Search Transaction Batches

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.

Endpoint

GET /v1/transaction-batches

Authorization Header

Authorization: Bearer <access_token>

Query Parameters

createdDateFrom

string (date), required 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), required 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: UTC

Time zone for the createdDateFrom and createdDateTo filters. The following values are supported:

Z, UTC or GMT – UTC
{+,-}N(N)(:MM) – zone offset in hours and minutes
UTC+<offset>, UTC-<offset>, GMT+<offset>, GMT-<offset>
IANA Time Zone Database region ID (example: the value for America/New_York is -04)

status

string enum, values: PENDING, PROCESSING, COMPLETED, ERROR, CANCELLED

Current status of the transaction batch. Possible values are:

PENDING The batch has been created.
PROCESSING The batch is being processed.
COMPLETED The batch has been completed.
ERROR The batch is unusable.
CANCELLED The batch has been cancelled.

solution

string enum, values: push-to-card, ach

Name of the RocketKOR solution used for the transaction batch. Possible values are:

push-to-card Push to Card solution.
ach ACH solution.

transactionType

string enum, value: SEND, REQUEST

Type of transaction. Possible values are:

SEND Push funds from a Financial Account to another Financial Account.
REQUEST Pull funds to a Financial Account from another Financial Account.

batchMode

string enum, values: RELAXED, STRICT

default: RELAXED

Batch mode. Possible values are:

RELAXED RocketKOR will validate the request header only and not the transaction line items. Individual transactions may be rejected based on validation rules.
STRICT RocketKOR applies zero-tolerance validation rules on the request header as well as the transaction line items. If one of the validation rules fail, the entire batch will be rejected.

sort

array [string]

Sort the response by any field in ascending or descending order. For details, see Sorting and Pagination. The default sort order is createdAt,DESC.

page

integer (int32)

Page number to return, based on zero-based page index.

size

integer (int32)

Maximum number of results to return per page.

Request Body

None

Returns

Returns a paginated response with an array of Transaction Batch objects.

SAMPLE RESPONSE

				
					{
  "totalElements": 0,
  "totalPages": 0,
  "number": 0,
  "numberOfElements": 0,
  "hasNext": true,
  "content": [
    {
      "id": "65078464-2dd1-496a-8a07-7dfd9e36b0a0",
      "businessAccountId": "77051b4b-4c5f-4f65-af6d-87a8b61f73a6",
      "metadata": {
        "myPaymentId": "100000333",
        "invoiceNumber": "123232333",
        "authorizedBy": "user@email.com"
      },
      "transactionType": "SEND",
      "batchMode": "RELAXED",
      "solution": "push-to-card",
      "description": "This is a batch",
      "settlementPriority": "SAME_DAY",
      "currency": "USD",
      "transactionCount": 5000,
      "totalAmount": 52450.26,
      "status": "PENDING",
      "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",
            "createdAt": "2023-02-06T01:02:45.943Z"
          }
        },
        {...},
        {...}
      ],
      "createdAt": "2023-04-06T01:02:45.943Z",
      "createdBy": {
        "id": "4bd3aff1-cf97-4480-96f4-cfe3656500a3",
        "type": "EMPLOYEE"
      }
    }
    {...},
    {...}
  ]
}