Get push transactions
GET /api/transaction
Use this call to retrieve past push transactions. You can add query parameters to narrow down the search results.
Query parameters
These parameters can be added to your request to narrow down your search results.
Parameter | Description |
---|---|
cardToken string | Card token for the signed-up debit card. Optional |
statusEnum string | Status of the transaction: - Pending - Succeeded - Failed - Rejected Optional |
fromDate DateTime | The starting date for the report. Optional |
toDate DateTime | The ending date for the report. Optional |
pageNumber integer | The current page number determined by the total number of transactions and the number of transactions per page. Optional |
pageSize integer | Number of transactions to list on a page. Optional |
Sample request GET /api/transaction
curl --location --request GET
'https://pushtopaystaging.crbnj.net/api/transaction'
--header 'Accept: application/json'
--header 'Authorization: Bearer {xxx}'
Response attributes
Attribute | Description |
---|---|
transactionRequestId string | Unique customer generated transaction identifier. |
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 transaction was sent to the processor. |
paymentSent boolean | True if the payment was sent, otherwise false. |
requestApproved boolean | True if the payment passed all the way to the processor successfully, otherwise false. |
responseReceived boolean | True if P2C 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 shows. |
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
{
"results": [
{
"transactionRequestId": "7CE5B6CC-253B-4AB5-B8X9-6E7VE63D7459",
"amount": 0,
"transactionRequestedAt": "2022-01-19T11:08:19.870Z",
"transactionStatus": "Pending",
"errorDescription": "null",
"creditCardId": "<CARD TOKEN>",
"railId": "RS2",
"network": "string",
"retrievalReferenceId": "LAKHG06654SVO75S",
"actualTransactionDoneAt": "2022-01-19T11:08:19.871Z",
"paymentSent": true,
"requestApproved": true,
"responseReceived": true,
"responseCode": "00",
"responseDescription": "approved",
"traceNumber": "lkjaf6vb5a;dftt00z",
"error": "null",
"transactionRequestBatchId": "null",
"sourceSenderName": "Cooks",
"sourceMcc": "7652"
}
],
}
Updated 9 months ago