Get batched transaction count status
GET /api/transaction
Use this call to get information on the number of transactions as they are being processed. You can filter the call with the query parameters in the table below.
These are the statuses that are returned, each followed by the transaction count.
- RequestsCount
- FailedTransactionCount
- InvalidTransactionCount
- SuccessTransactionCount
- TransactionInProcessCount
A sample request and response is below.
Request URL |
---|
https:// ....../batch/api/transaction |
Query parameters
Parameter | Description |
---|---|
batchId | This attribute is also referred to as Unique identifier for the batch. |
fromDate | The first date to include in the response. |
toDate | The last date to include in the response. |
batchesWithFailuresOrInvalidRequests | Filters for batches with failures or invalid requests. True to filter for those batches, false to filter for batches without failures or invalid requests. |
completedBatches | Filters for batches that have already completed and are no longer processing. True to filter for those batches, false to filter for batches that are still processing. |
pageNumber | The current page number determined by the total number of transactions and the number of transactions per page. |
pageSize | Number of transactions to list on a page. |
Sample request GET /api/transaction
curl --location --request GET
'https://pushtopaystaging.crbnj.net/batch/api/transaction'
--header 'Accept: application/json'
Response attributes
Attribute | Description |
---|---|
BatchId | This attribute is also referred to as Unique ID for the batch. |
RequestsCount | Number of transactions included in this batch. |
FailedTransactionCount | Number of transactions in this batch that failed. |
InvalidTransactionCount | Number of transactions in this batch that are invalid. |
SuccessTransactionCount | Number of transactions in this batch that were processed successfully. |
TransactionInProcessCount | Number of transactions in this batch that are still in process. |
RequestedAt | The time the batch transaction was submitted. |
CompletedAt | The time the batch transaction was completed. |
Sample response GET /api/transaction
{
"Results": [
{
"BatchId": "00000000-0000-0000-0000-000000000000",
"RequestsCount": 0,
"FailedTransactionCount": 200,
"InvalidTransactionCount": 10,
"SuccessTransactionCount": 450,
"TransactionInProcessCount": 50,
"RequestedAt": "2021-01-19T11:39:08.534Z",
"CompletedAt": "2021-01-19T11:39:08.534Z"
}
}
For additional descriptions of the request and response attributes, see Batch transaction attributes.
Updated 11 days ago