Get push transaction details by transaction ID
GET /api/transaction/{transactionId}
Use this call to get details of a transaction where {transactionId}
is the transaction identifier.
You can call this API to track the status of a transaction. If the transaction is pending, you can call this API to check the final status.
You can also sign up for webhooks and the status will be reported to your system and you wont have to poll the API.
Path parameter
Parameter | Description |
---|---|
transactionId string | Unique customer generated transaction identifier. This parameter corresponds to the TransacationRequestId in the response.Required |
Query parameter
These parameters can be added to your request to narrow down your search results.
Parameter | Description |
---|---|
sourceSenderId string | Merchant ID. |
Sample request GET /api/transaction/{transactionId}
curl --location --request GET
'https://pushtopaystaging.crbnj.net/api/transaction/113-135155-548934-21939'
--header 'Accept: text/html'
--header 'Authorization: Bearer {xxx}'
Response attributes
Attribute | Description |
---|---|
transactionRequestId GUID | Unique customer generated transaction identifier. This parameter corresponds to the transactionId in the request. |
amount integer | Transaction amount in cents. |
transactionRequestedAt string | Date and time the transaction was requested. |
transactionStatus string | Status of the transaction: - Succeeded - Pending - Failed - Rejected |
errorDescription string | Description of any error that might have occurred. |
creditCardId string | Card token of the signed-up debit card. |
railId string | The processor used to perform the transaction. - RS2 - McSend - TabaPay |
network string | Card network. - Visa - Mastercard - ET - PULSE - STAR - NYCE - Accel - RPPS - MoneySend |
retrievalReferenceId GUID | Unique tracking identifier for this transaction in the processors to correlate this transaction to the processors. |
actualTransactionDoneAt string | Actual time the tranaction was sent to the processor. |
paymentSent boolean | True if the payment passed all the way to the processor successfully, otherwise false. |
requestApproved boolean | True if the payment passed all the way to the processor successfully, otherwise false. |
responseReceived boolean | True if P2P received a response from the external processor, otherwise false. |
responseCode string | An ISO 8583 two-digit code signifying the transaction result. For example, 00 means successful. |
responseDescription string | An ISO 8583 string description of the transaction result. For example, Approved. |
traceNumber string | Unique number that is assigned to a transaction when it leaves the merchant bank until it arrives at the cardholder bank. |
error string | Descriptive error, if relevant. |
transactionRequestBatchId string | If a request is part of a batch, this Id will be populated. |
sourceSenderName string | Merchant name. |
*sourceMcc string | Merchant Category Code (MCC). 4-digits that a credit card issuer uses to categorize consumer transactions for their card. |
Sample response GET /api/transaction/{transactionId}
{
"transactionRequestId":"00000000-34670000-0000-0000-000000000000",
"amount":2000,
"transactionRequestedAt":"2022-01-03T09:57:03.020Z",
"transactionStatus":"Pending",
"errorDescription":"string",
"creditCardId":"string",
"railId":"RS2",
"network":"string",
"retrievalReferenceId":"string",
"actualTransactionDoneAt":"2022-01-03T09:57:03.020Z",
"paymentSent":true,
"requestApproved":true,
"responseReceived":true,
"responseCode":"string",
"responseDescription":"string",
"traceNumber":"string",
"error":"string",
"transactionRequestBatchId":"00000000-0000-0000-0000-000000000000",
"sourceSenderName":"string",
"sourceMcc": "string"
}
Updated 7 months ago