BI Search Transactions

nestedTransactions  REQUIRED

boolean

Whether to include all Child Business Accounts in the search.

businessAccountIds  REQUIRED

string (UUID)

• To include all Child Business Accounts, provide the ID of the parent Business Account. nestedTransactions must also be set to true.
• To include specific Child Business Accounts, provide a list of one or more Child Business Account IDs. These accounts must be children of the Business Account associated with the request access token. If a list of Child Business Account IDs is provided here, nestedTransactions will be ignored.

solution

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

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

fromFinancialAccount

string (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

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

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

toAmount

number

Amount of the transaction. 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

• 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. Possible values are:

• SEND  Push funds from a Financial Account to another Financial Account. SEND transactions are originated on RocketKOR.
• REQUEST  Pull funds to a Financial Account from another Financial Account. REQUEST transactions are originated on RocketKOR.
• 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.