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. A sample request and response is below.

Request URL

https:// ...batch/api/transaction/{batchId}/{transactionsBatchedStatus}

Sample request

curl --location --request GET 
'https://pushtopaystaging.crbnj.net/batch/api/transaction/{xxx}/Pending'
--header 'Accept: application/json'

Path parameters

Parameter

Description

batchId
string

This attribute is also referred to as TransactionRequestBatchId.

Unique ID 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 response

For a description of the response attributes, see Batch transaction attributes.

{
  "Results": [
    {
      "RequestJson": "string",
      "TransactionRequestId": "9085r4098-323-0-887v'
      "Amount": 0,
      "TransactionRequestedAt": "2021-01-19T11:39:08.567Z",
      "TransactionStatus": "Success",
      "ErrorDescription": "null",
      "CreditCardId": "ELHPIE39WGWYDVYAT280YBS138F1YLA0NSV5E2",
      "RailId": "McSend",
      "Network": "Mastercard",
      "RetrievalReferenceId": "a0d77e03-6f34-4ff5-b215-e63a8dc5d",
      "ActualTransactionDoneAt": "2021-01-19T11:39:08.567Z",
      "PaymentSent": true,
      "RequestApproved": true,
      "ResponseReceived": true,
      "ResponseCode": "00",
      "ResponseDescription": "Approved",
      "TraceNumber": "00000000-0128-0000-0000-000000000000",
      "Error": "null",
      "TransactionRequestBatchId": "null",
      "SourceSenderName": "Elphie Sar",
      "SourceMcc": "1234"
    }
  ],
  "PageNumber": 0,
  "PageSize": 0,
  "HasPreviousPage": true,
  "HasNextPage": true
}

Did this page help you?