Retrieve Bulk Transaction Status
This method retrieves status information for a specific group of bulk transactions.
The API endpoint is as follows:
GET /api/v2/bulk_transactions/:bulk_key:
Request
curl -X GET https://secure.usaepay.com/api/v2/bulk_transactions/antn1r9j6bss668h1
-H "Authorization: Basic OWZuVVQ3Zkk2Tjc2YjU1M0pEUkk1MTQwOVlVYnA4OTg6czIvZDUxYjkxMTUxMThkNTRkZGUzYzYxOTA3ODVjNDJhZGUvMGMyZDdkMDVlNGViMjNkMDAzZDdhZTc5YmZiM2M1NWNjYzM2NmMzYTQzZjgzOGYxYzBiZDNkMWNlZWYwYjQ3Yw=="
Response
{
"bulk_key": "antn1r9j6bss668h1",
"uploaded": "2018-08-15 14:49:57",
"filename": "upload1.csv",
"status": "Completed",
"transactions": "3",
"remaining": "0",
"approved": "3",
"declined": "0",
"errors": "0"
}
This is the sample response object sent back from the server.
Parameters
Request Parameters
| Parameter | Type | Description |
|---|---|---|
| bulk_key | string | Unique identifier for group of transactions generated by gateway. You can also use current reference the group of transactions that is currently processing. |
Response Parameters
| Parameter | Type | Description |
|---|---|---|
| bulk_key | string | Unique identifier for group of transactions generated by gateway. |
| uploaded | date/time | Date and time the file was uploaded. |
| filename | string | Name of the file containing the transactions. |
| status | string | Current status of the bulk transaction upload. |
| transactions | integer | Number of total transactions uploaded. |
| remaining | integer | Number of transactions left to process. |
| approved | integer | Number of approved transactions currently processed within the bulk transaction file. |
| declined | integer | Number of declined transactions currently processed within the bulk transaction file. |
| errors | integer | Number of err'd transactions currently processed within the bulk transaction file. |
Retrieve Bulk Transaction Detail
Use this method to see the details of each transactions within the group of transactions you uploaded.
The API endpoint is as follows:
GET /api/v2/bulk_transactions/:bulk_key:/transactions
Request
curl -X GET https://secure.usaepay.com/api/v2/bulk_transactions/antn1r9j6bss668h1/transactions
-H "Authorization: Basic OWZuVVQ3Zkk2Tjc2YjU1M0pEUkk1MTQwOVlVYnA4OTg6czIvZDUxYjkxMTUxMThkNTRkZGUzYzYxOTA3ODVjNDJhZGUvMGMyZDdkMDVlNGViMjNkMDAzZDdhZTc5YmZiM2M1NWNjYzM2NmMzYTQzZjgzOGYxYzBiZDNkMWNlZWYwYjQ3Yw=="
Response
{
"type": "list",
"limit": 20,
"offset": 0,
"data": [
{
"type": "transaction",
"key": "gdb5vq0641y9vbpn",
"refnum": "2071671514",
"trantype_code": "S",
"trantype": "Credit Card Sale",
"result_code": "A",
"result": "Approved",
"authcode": "544324",
"status_code": "P",
"status": "Authorized (Pending Settlement)",
"creditcard": {
"cardholder": "Cary Grant",
"number": "4000xxxxxxxx2222",
"avs_street": "789 North Way",
"avs_postalcode": "90005",
"category_code": "A"
},
"avs": {
"result_code": "NYZ",
"result": "Address: No Match & 5 Digit Zip: Match"
},
"cvc": {
"result_code": "M",
"result": "Match"
},
"batch": {
"type": "batch",
"key": "apts0bfxcq5q2kt7",
"sequence": "1"
},
"amount": "20.00",
"invoice": "103"
},
{
"type": "transaction",
"key": "fdb5vq1hf1vg9q3m",
"refnum": "2071671513",
"trantype_code": "S",
"trantype": "Credit Card Sale",
"result_code": "A",
"result": "Approved",
"authcode": "544325",
"status_code": "P",
"status": "Authorized (Pending Settlement)",
"creditcard": {
"cardholder": "James Dean",
"number": "4000xxxxxxxx2223",
"avs_street": "456 Griffith Park Dr.",
"avs_postalcode": "90005",
"category_code": "A"
},
"avs": {
"result_code": "YYX",
"result": "Address: Match & 9 Digit Zip: Match"
},
"cvc": {
"result_code": "M",
"result": "Match"
},
"batch": {
"type": "batch",
"key": "apts0bfxcq5q2kt7",
"sequence": "1"
},
"amount": "20.00",
"invoice": "102"
},
{
"type": "transaction",
"key": "ddb57bdmpybmjm2c",
"refnum": "2071671511",
"trantype_code": "S",
"trantype": "Credit Card Sale",
"result_code": "A",
"result": "Approved",
"authcode": "544326",
"status_code": "P",
"status": "Authorized (Pending Settlement)",
"creditcard": {
"cardholder": "Audrey Hepburn",
"number": "4000xxxxxxxx2224",
"avs_street": "123 Tiffany St.",
"avs_postalcode": "90005",
"category_code": "A"
},
"avs": {
"result_code": "YYY",
"result": "Address: Match & 5 Digit Zip: Match"
},
"cvc": {
"result_code": "M",
"result": "Match"
},
"batch": {
"type": "batch",
"key": "apts0bfxcq5q2kt7",
"sequence": "1"
},
"amount": "20.00",
"invoice": "101"
}
],
"total": "3"
}
This is the sample response object sent back from the server.
Parameters
Request Parameters
| Parameter | Type | Description |
|---|---|---|
| bulk_key | string | Unique identifier for group of transactions generated by gateway. You can also use current reference the group of transactions that is currently processing. |
Response Parameters
| Parameter | Type | Description |
|---|---|---|
| type | string | This is will always be list for this method. |
| limit | integer | Limit setting for this response. This will default to 20. |
| offset | integer | Offset setting for this response. This will default to 0. |
| data | array | Array of transaction objects for the transactions in this group of transactions. |
| total | integer | Total number of transactions in the file you uploaded. |
Change Log
| Date | Change |
|---|---|
| 2017-09-04 | Added page with code examples. |