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 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.
POST /v1/search/transactions
Authorization: Bearer <access_token>
nestedTransactions REQUIRED
boolean
Whether to include all Child Business Accounts in the search.
businessAccountIds REQUIRED
string (UUID)
Child Business Accounts to include in the search.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
Transaction status. Possible values are:transactionType
string enum, values: SEND, REQUEST, DEPOSIT, WITHDRAWAL, REVERSAL, RETURN, ADJUSTMENT
Type of transaction. Possible values are:
resultFormat
string enum, values: CSV, JSON
Type of file used to store the search results.
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,
"businessAccountIds": [
"2bf96628-9d1e-4846-b7a6-70d25d0d5e5b"
],
"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"
}
© 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.