BI Search Transactions

Gather Business Insights (BI) by analyzing the transactions for a Business Account and its Child Business Accounts.

Use this API to search transactions based on filters such as the transaction type, status, and amount. The API returns a queryId that can be used to query the search status and retrieve the results.

Note The search is limited to the Business Account associated with the request access token. To include the Business Account’s Child Business Accounts, set nestedTransactions to true.

Endpoint

POST /v1/search/transactions

Authorization Header

Authorization: Bearer <access_token>

Request Body

nestedTransactions REQUIRED

boolean

Whether to include Child Business Accounts in the search.

If false, only the Business Account associated with the request access token will be included.
If true, all Child Business Accounts of the Business Account associated with the request access token will also be included.

solution

string enum, values: PUSH_TO_CARD, ACH, ADJUSTMENT, TRANSFER

RocketKOR solution. This filter will return transactions created for the specified solution.

fromFinancialAccount

array of strings (UUID)

List of Financial Account IDs for the debit account (the source of funds) for a transaction. This filter will return transactions with these Financial Accounts as the credit account.

toFinancialAccount

array of strings (UUID)

List of Financial Account IDs for the credit account (the destination account) for a transaction. This filter will return transactions with these Financial Accounts as the credit account.

fromCreatedAt

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.

toCreatedAt

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.

fromAmount

number

Transaction amount. This filter will return transactions with an amount equal to or greater than this amount.

toAmount

number

Transaction amount. This filter will return transactions with an amount equal to or less than this amount.

transactionStatus

string enum, values: NEW, PENDING, PROCESSING, APPROVED, SETTLED, CLEARED, DECLINED, 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.
DECLINED Disbursement has been declined by the Provider.
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.

transactionType

string enum, values: SEND, REQUEST, DEPOSIT, WITHDRAWAL, REVERSAL, RETURN, ADJUSTMENT

Type of transaction. The following values are supported:

SEND Push funds from the debit Financial Account to the credit Financial Account. For example, a SEND transaction would be used if a Business Account (owner of the debit Financial Account) is sending a refund to a Customer (owner of the credit Financial Account).
REQUEST Pull funds to the credit Financial Account from the debit Financial Account. For example, a REQUEST transaction would be used if a Business Account (owner of the credit Financial Account) is collecting a rent payment from a Customer (owner of the debit Financial Account).
DEPOSIT Push funds into a Financial Account where the push is originated outside RocketKOR.
WITHDRAWAL Pull funds from a Financial Account where the pull is originated outside RocketKOR.
REVERSAL A transaction created by RocketKOR to reverse a SETTLED or CLEARED transaction.
RETURN A RETURN transaction cancels the original transaction.
ADJUSTMENT An ADJUSTMENT transaction is used to correct a human or system error with a transaction or to record a transaction that originated outside of RocketKOR.

resultFormat

string enum, values: CSV, JSON

Type of file used to store the search results.

Returns

Returns a queryId. Use this queryId to query the search status and retrieve the search results.

queryId

string (UUID)

ID representing the search results.

SAMPLE REQUEST

				
					{
  "nestedTransactions": true,
  "solution": [
    "PUSH_TO_CARD"
  ],
  "fromFinancialAccount": [
    "da86603c-6bb5-4e98-85ee-7017b734650c"
  ],
  "toFinancialAccount": [
    "5b307781-d571-4bf1-9240-a2125b5a7529"
  ],
  "fromCreatedAt": "2023-01-01",
  "toCreatedAt": "2023-01-31",
  "fromAmount": 1000.00,
  "toAmount": 5000.00,
  "transactionStatus": [
    "NEW"
  ],
  "transactionType": [
    "SEND"
  ],
  "resultFormat": "CSV"
}

SAMPLE RESPONSE

				
					{
  "queryId": "88fe3238-8b6c-4de7-a77a-05fe43541d56"
}