This endpoint retrieves a list of transactions based on the merchant's four part key, which is set during onboarding. When called directly, the endpoint will list all transactions specific to that four part key at the terminal level. If the detail property is set to DBA, it will tell the endpoint to return all transactions at the DBA level, essentially using the first three parts of the four part key.
Custom Pay API
Transaction List
get /sale
Parameters
EPI-Id required
string
Example:
1111-222222-3-4
Loading...
EPI-Signature required
string
Example:
0123456789ABCDEF
Loading...
Content-Type required
string
Example:
application/json
Loading...
EPI-Trace
string
Loading...
200 Successful request
400 Invalid request
401 Unauthorized: EPI-Signature is required.
Or the generated HMAC does not match the endpoint and JSON payload received. Please review your HMAC-SHA256 procedure or the endpoint/body that are being sent.
403 Forbidden: EPI-Id provided doesn’t have the right to perform the request
404 Requested resource was not found
405 HTTP method is not allowed
500 Internal server error
Refund Details by BRIC
get /refund/{BRIC}
This endpoint retrieves details of a specific refund based on the BRIC token (EPX Transaction Identifier) of the refund.
Parameters
EPI-Id required
string
Example:
1111-222222-3-4
Loading...
EPI-Signature required
string
Example:
0123456789ABCDEF
Loading...
Content-Type required
string
Example:
application/json
Loading...
EPI-Trace
string
Loading...
BRIC required
string
Example:
00DXDBWHB6WA5HJ3D71
Loading...
200 Successful request
400 Invalid request
401 Unauthorized: EPI-Signature is required.
Or the generated HMAC does not match the endpoint and JSON payload received. Please review your HMAC-SHA256 procedure or the endpoint/body that are being sent.
403 Forbidden: EPI-Id provided doesn’t have the right to perform the request
404 Requested resource was not found
405 HTTP method is not allowed
500 Internal Server Error
Transaction Details by BRIC
get /sale/{BRIC}
This endpoint retrieves the details for a single transaction based on the BRIC (EPX Transaction Identifier) value.
Parameters
EPI-Id required
string
Example:
1111-222222-3-4
Loading...
EPI-Signature required
string
Example:
0123456789ABCDEF
Loading...
Content-Type required
string
Example:
application/json
Loading...
EPI-Trace
string
Loading...
BRIC required
string
Example:
00DXDBWHB6WA5HJ3D71
Loading...
200 Successful request
400 Invalid request
401 Unauthorized: EPI-Signature is required.
Or the generated HMAC does not match the endpoint and JSON payload received. Please review your HMAC-SHA256 procedure or the endpoint/body that are being sent.
403 Forbidden: EPI-Id provided doesn’t have the right to perform the request
404 Requested resource was not found
405 HTTP method is not allowed
500 Internal server error
Auth Reversal Details
get /reverse/{BRIC}
Retrieves details about a reversed authorization.
Parameters
EPI-Id required
string
Example:
1111-222222-3-4
Loading...
EPI-Signature required
string
Example:
0123456789ABCDEF
Loading...
Content-Type required
string
Example:
application/json
Loading...
EPI-Trace
string
Loading...
BRIC required
string
Example:
00DXDBWHB6WA5HJ3D71
Loading...
200 Successful request
400 Invalid request
401 Unauthorized: EPI-Signature is required.
Or the generated HMAC does not match the endpoint and JSON payload received. Please review your HMAC-SHA256 procedure or the endpoint/body that are being sent.
403 Forbidden: EPI-Id provided doesn’t have the right to perform the request
404 Requested resource was not found
405 HTTP method is not allowed
500 Internal server error
Batch Details by Transaction
get /batch/{batchID}
This endpoint retrieves details about a specific batch based on the Batch ID.
Parameters
EPI-Id required
string
Example:
1111-222222-3-4
Loading...
EPI-Signature required
string
Example:
0123456789ABCDEF
Loading...
Content-Type required
string
Example:
application/json
Loading...
EPI-Trace
string
Loading...
batchID required
integer
Example:
123
Loading...
Example Response
200 Successful request
400 Invalid request
401 Unauthorized: EPI-Signature is required.
Or the generated HMAC does not match the endpoint and JSON payload received. Please review your HMAC-SHA256 procedure or the endpoint/body that are being sent.
403 Forbidden: EPI-Id provided doesn’t have the right to perform the request
404 Requested resource was not found
405 HTTP method is not allowed
500 Internal server error