Search Transactions

createdById

string (UUID)

ID of the entity that created the transaction.

createdByType

string enum, values: EMPLOYEE, CUSTOMER, SERVICE_ACCOUNT, RECIPIENT

Type of entity that created the transaction. The following values are supported:

• employee  Team Member using the RocketKOR Portal.
• service-account  Service Account using APIs.
• internal  Internal service call.

createdDateFrom

string (date), format: yyyy-MM-dd

Date the transaction was created in the RocketKOR system. This filter will return transactions 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 was created in the RocketKOR system. This filter will return transactions 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:

• 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)

amountFrom

number

Amount of the transaction. This filter will return transactions with an amount equal to or greater than this amount.

amountTo

number

Amount of the transaction. This filter will return transactions with an amount equal to or less than this amount.

latestStatus

string enum, values: NEW, PENDING, PROCESSING, APPROVED, SETTLED, CLEARED, CANCELLED, DECLINED, REVERSED, ERROR

Transaction status. The following values are supported:

• NEW  The transaction has been created in RocketKOR.
• PENDING  The transaction has been moved from the Transaction Domain to one of the Processing Domains. The transaction is still in the RocketKOR system (meaning it has not been transmitted to the Provider for processing) and is in a state where it can be cancelled.
• PROCESSING  One of the following is true: (a) the transaction is in a Processing Domain in the RocketKOR system but can no longer be cancelled, or (b) the transaction has been transmitted to the Provider for processing.
• APPROVED  Disbursement has been approved by the Provider.
• SETTLED  The transaction has been settled by the Provider.
• CLEARED  The Sponsor has indicated that funds movement for the transaction is complete. The funds are now available in the Master Settlement Account (MSA). This status is only applicable to “received” transactions.
• CANCELLED  The transaction has been cancelled.
• DECLINED  Disbursement has been declined by the Provider.
• REVERSED  A transaction was submitted by RocketKOR to move funds in the opposite direction of the initial transaction. This “reverses” the transaction by moving the funds back to the original account.
• ERROR  The transaction could not be processed due to one or more errors (for example, the Provider system is unavailable after a number of retries). The ERROR status is only activated after RocketKOR determines that it cannot continue processing the transaction.

maskedDebitAccountNumber

string

Masked account number for the bank account or card account used as the debit account for the transaction. Enter the last 4 digits of the account number (for example: 4242). Optionally, you can enter asterisks for the rest of the account number (for example: ********4242).

maskedCreditAccountNumber

string

Masked account number for the bank account or card account used as the credit account for the transaction. Enter the last 4 digits of the account number (for example: 4242). Optionally, you can enter asterisks for the rest of the account number (for example: ********4242).

solution  

string

Name of the RocketKOR solution used for the transaction.

transactionType  

string enum, values: SEND, REQUEST, REVERSAL

Type of transaction. The following values are supported:

• SEND  Push funds from a Financial Account to another Financial Account.
• REQUEST  Pull funds to a Financial Account from another Financial Account.
• REVERSAL  A transaction created by RocketKOR to reverse a SETTLED or CLEARED transaction.

SEND, REQUEST, and REVERSAL transactions are originated on RocketKOR.

origin

string enum, values: SINGLE, BATCH

Whether the transaction originated from a single transaction request or from a transaction batch.

batchId

string (UUID)

ID of the batch from which the transaction originated.

page

integer (int32)

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

size

integer (int32)

Maximum number of results to return per page.

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.