Search for transaction batches based on filters such as the status, date, solution, and transaction type. Use the sort query parameter to sort the results, and use the page and size query parameters to limit the number of results returned.
Note The search is limited to transaction batches for the Business Account associated with the request access token.
GET /v1/transaction-batches
Authorization: Bearer <access_token>
createdDateFrom
string (date), format: yyyy-MM-dd
Date the transaction batch was created in the RocketKOR system. This filter will return batches created on or after this date.
Note The date is interpreted using the specified timeZone. UTC format is used if timeZone is not provided.
createdDateTo
string (date), format: yyyy-MM-dd
Date the transaction batch was created in the RocketKOR system. This filter will return batches created on or before this date.
Note The date is interpreted using the specified timeZone. UTC format is used if timeZone is not provided.
timeZone
string (timeZone), default value: UTC
Time zone for the createdDateFrom and createdDateTo filters. The following values are supported:
status
string enum, values: PENDING, PROCESSING, COMPLETED, ERROR, CANCELLED
Current status of the transaction batch. The following values are supported:
solution
string
Name of the RocketKOR solution used for the transaction batch.
transactionType
string enum, value: SEND, REQUEST
Type of transaction. The following values are supported:
batchMode
string enum, values: RELAXED, STRICT
default value: RELAXED
Batch mode. The following values are supported:
sort
array of strings
Sort the response by any field in ascending or descending order. The default sort order is createdAt,DESC. For more information, see Sorting and Pagination.
page
integer (int32)
Page number to return, based on zero-based page index.
size
integer (int32)
Maximum number of results to return per page.
None
Returns a paginated response with an array of Transaction Batch objects.
SAMPLE RESPONSE
{
"totalElements": 3,
"totalPages": 1,
"number": 0,
"numberOfElements": 3,
"hasNext": false,
"content": [
{
"id": "65078464-2dd1-496a-8a07-7dfd9e36b0a0",
"businessAccountId": "77051b4b-4c5f-4f65-af6d-87a8b61f73a6",
"metadata": {
"department": "billing"
},
"transactionType": "SEND",
"batchMode": "RELAXED",
"solution": "push-to-card",
"description": "This is a batch",
"settlementPriority": "SAME_DAY",
"currency": "USD",
"transactionCount": 5000,
"processedTransactionCount": 4998,
"failedTransactionCount": 2,
"totalAmount": "52450.26",
"processedTransactionAmount": "49813.26",
"failedTransactionAmount": "2637.00,
"transactions": [
{
"id": "ce0c8e6d-f747-4aff-b607-8a6d1a10968c",
"metadata": {
"myPaymentId": "100000333",
"invoiceNumber": "123232333",
"authorizedBy": "user@email.com"
},
"debitFinancialAccountId": "00303bff-29af-4213-bc7d-d9127a16927e",
"creditFinancialAccountId": "cf2944c7-465b-427c-b933-4d33526b391a",
"paymentReasonId": "loan-payouts",
"amount": "250.00",
"latestStatus": {
"status": "NEW",
"message": "New transaction",
"createdBy": {
"id": "e1b97aa1-29a8-46d3-8f58-aa7a8bec5e79",
"type": "service-account"
},
"createdAt": "2023-02-06T01:02:45.943Z"
}
},
{...},
{...}
],
"createdBy": {
"id": "e1b97aa1-29a8-46d3-8f58-aa7a8bec5e79",
"type": "service-account"
},
"createdAt": "2023-02-07T01:02:45.943Z",
"updatedBy": {
"id": "e1b97aa1-29a8-46d3-8f58-aa7a8bec5e79",
"type": "service-account"
},
"updatedAt": "2023-02-08T20:40:03.484Z"
},
{...},
{...}
]
}
© 2022 Rocket Financial. All rights reserved. RocketFNCL, RocketKOR, RocketBNK are trade names of Rocket Financial Inc.
Services Agreement | Privacy Policy | RocketFNCL | © 2023 by Rocket Financial Inc. All rights reserved.
Services Agreement | Privacy Policy | RocketFNCL | © 2023 by Rocket Financial Inc. All rights reserved.
Services Agreement | Privacy Policy | RocketFNCL
© 2023 by Rocket Financial Inc. All rights reserved.