Get a batched transaction by ID and transaction batch status
GET /api/transaction/{batchId}/{transactionsBatchedStatus}
Use this call to see batched transactions where {batchId}
is the batch identifier, and {transactionsBatchedStatus}
is the status of the batched transactions which are listed below. To filter the call, use the query parameters in the table below.
Request URL |
---|
https:// ...batch/api/transaction/{batchId}/{transactionsBatchedStatus} |
Path parameters
Parameter | Description |
---|---|
batchId string | This attribute is also referred to as TransactionRequestBatchId .Unique identifier for the batch. Required |
transactionsBatchedStatus string | This attribute is also referred to as TransactionStatus .The status of a batched transaction. You can filter by any of these statuses: - Success - Failed - InvalidRequests Required |
Query parameters
Parameter | Description |
---|---|
pageNumber integer | The current page number determined by the total number of transactions and the number of transactions per page. |
pageSize integer | Number of transactions to list on a page. |
Sample request GET /api/transaction/{batchId}/{transactionsBatchedStatus}
curl --location --request GET
'https://pushtopaystaging.crbnj.net/batch/api/transaction/{xxx}/Pending'
--header 'Accept: application/json'
Response attributes
Attribute | Description |
---|---|
RequestJson string | The JSON authorization response received for this card. |
transactionRequestId GUID | Unique customer generated transaction identifier. |
amount integer | Amount to be transferred in cents. |
transactionRequestedAt string | Date and time the transaction was requested. |
transactionStatus string | Status of the transaction: - Pending - Approved - Failed - Rejected |
errorDescription string | Description of any error that might have occurred. |
creditCardId string | Token of the debit card that was transacted to. |
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 P2P received a response from the external processor, otherwise false. |
responseCode integer | 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 GUID | Batch ID for the transaction request. This attribute is also referred to as BatchId . |
sourceSenderName string | Merchant name. |
sourceMcc integer | Merchant Category Code (MCC). 4-digits that a credit card issuer uses to categorize consumer transactions for their card. |
Sample response GET /api/transaction/{batchId}/{transactionsBatchedStatus}
{
"Results": [
{
"RequestJson": "string",
"TransactionRequestId": "GJS6B032-235B-S465-N9F9-AG3356FFG103'
"Amount": 2200,
"TransactionRequestedAt": "2022-01-19T11:39:08.567Z",
"TransactionStatus": "Success",
"ErrorDescription": "null",
"CreditCardId": "<CARD TOKEN>",
"RailId": "McSend",
"Network": "Mastercard",
"RetrievalReferenceId": "A0D77E03-6F34-4FF5-B215-E63A8DC5D",
"ActualTransactionDoneAt": "2022-01-19T11:39:08.567Z",
"PaymentSent": true,
"RequestApproved": true,
"ResponseReceived": true,
"ResponseCode": "00",
"ResponseDescription": "Approved",
"TraceNumber": "8CEDFAS3-2321-3GA5-GH90-6DSFAH5BX160",
"Error": "null",
"TransactionRequestBatchId": "null",
"SourceSenderName": "Cooks",
"SourceMcc": "1234"
}
}
Updated 7 months ago