Retrieve Transaction

Retrieves the Transaction.

If you are an ISO (Independent Sales Organization), you will need to specify a SubClientID (see notes below).


URL:

https://<FQDN>/v1/clients/<ClientIDISO>/transactions/<TransactionID>


Request:

No Request Data


Response:

Status Codes:

Status Code Description
200 OK The Transaction is retrieved.
421 Misdirected Request Too late to Retrieve Transaction by ReferenceID, use TransactionID.

See Status Codes for other possible Status Codes that might be returned.


Response Data:

JSON Name Value Description Status Code
200 Other
SC Integer
3-digit code
HTTP Status Code O
EC String
1 or 8 characters
Internal Error Code O
EM String Error Message O
referenceID String ReferenceID
network String Network O
networkRC String
2 or 3-character code
Network Response Code O
status String Status
originally String Original Status O
approvalCode String
6 characters
Approval Code O
errors Array of
8 characters
Strings
Array of Internal Error Codes O
currency String
3-digit code
ISO 4217 Currency Number O
amount String Amount in Currency
amountUSD String Amount in USD if Currency is not 840 (USD) O
last4 String Last 4 of Card Account Number (PAN)
or
Last 4 of Bank Account Number
memo String Memo O
fees object Fees O
interchange String
Amount
Interchange Fees
network String
Amount
Network Fees
tabapay String
Amount
TabaPay Fees
reversalStatus String Reversal Status O
reversal object Reversal O
networkRC String
2 or 3-character code
Network Response Code O
networkRC2 String
2 or 3-character code
Network Response Code O
error String
1 or 8 characters
Internal Error Code O

Sample Response:

Transaction retrieved using TransactionID:
{
  "SC": 200,
  "EC": "0",
  "referenceID": "1",
  "network": "Visa",
  "networkRC": "00",
  "status": "COMPLETED",
  "approvalCode": "000000",
  "amount": "0.10",
  "fees":
  {
    "interchange": "0.50",
    "network": "0.50",
    "tabapay": "0.25"
  }
}

Notes:

For Clients who are an ISO (Independent Sales Organization), to specify your ClientID and a SubClientID, use the underscore character ("_") to separate the two values: <ClientID>_<SubClientID> where:

  • ClientID is your unique 22-character string and
  • SubClientID is an assigned 4, 6 or 8-digit value.

The Fees are only an estimation. The actual Fees will be shown on your daily settlement reports.


See Anti-Pattern FAQ for proper usage of Retrieve by ReferenceID.


If there was a HTTP communication error and you did not get back a TransactionID, you can try to Retrieve the TransactionID using the ReferenceID.