BI Search Financial Accounts

fromCreatedAt

string (date), required format: yyyy-mm-dd

Date the Financial Account was created in RocketKOR. This filter will return Financial Accounts created on or after this date.

toCreatedAt

string (date), required format: yyyy-mm-dd

Date the Financial Account was created in RocketKOR. This filter will return Financial Accounts created on or before this date.

category

string enum, values: INTERNAL, EXTERNAL, INTEGRATED

Financial Account category. The following values are supported:

• INTERNAL  Created within RocketKOR to manage funds and track account balances for a Customer. Is not linked to an account at a financial institution and cannot be used for transactions outside of RocketKOR.
• EXTERNAL  Linked to an account that is issued or managed by an outside financial institution. Can only be used for transactions initiated on RocketKOR, such as send and request. Example: A debit card or bank account issued by a financial institution.
• INTEGRATED  Linked to a third-party account at a third-party institution. Can be used for any type of transaction (send, request, deposit, withdrawal, internal transfer, and so on). Example: A debit card or bank account issued on RocketKOR.

type

string enum, values: BANK, CARD

Financial Account type.

financialAccountSubType

string enum; values for BANK Financial Accounts: SAVING, CHECKING; values for CARD Financial Accounts: DEBIT, CREDIT, PREPAID, GIFT

Financial Account subtype.

financialAccountStatus

string enum, values: ACTIVE, SUSPENDED, DELETED

Financial Account status. The following values are supported:

• ACTIVE  Financial Account is active.
• SUSPENDED  Financial Account is inactive.
• DELETED  Financial Account has been deleted.

customerAccountType

string enum, values: INDIVIDUAL, BUSINESS

Type of Customer Account to which the Financial Account belongs.

currency

string, max length: 3, min length: 3

Currency of the Financial Account. Must be an ISO 4217 alpha 3-character currency code. RocketKOR supports USD and CAD currencies.

financialAccountName

string, max length: 100, min length: 1

Financial Account name. This is an informal name used for the account in RocketKOR.

customerFirstName

string, max length: 40, min length: 1

This filter is available for Individual Customer Accounts. Customer’s first name.

customerMiddleName

string, max length: 40, min length: 1

This filter is available for Individual Customer Accounts. Customer’s middle name.

customerLastName

string, max length: 40, min length: 1

This filter is available for Individual Customer Accounts. Customer’s last name.

customerDoingAsBusinessName

string, max length: 40, min length: 1

This filter is available for Business Customer Accounts.

Business operating name. Used by the business in marketing and day-to-day activities.

shipToFirstName

string, max length: 40, min length: 1

First name of the of the Customer contact responsible for shipments.

shipToMiddleName

string, max length: 40, min length: 1

Middle name of the Customer contact responsible for shipments.

shipToLastName

string, max length: 40, min length: 1

Last name of the Customer contact responsible for shipments.

expiryFromDate

string, required format: YYYY-MM

This filter is available for CARD Financial Accounts.

Expiry date for the card. This filter will return Financial Accounts where the card has an expiry date on or after this date.

expiryToDate

string, required format: YYYY-MM

This filter is available for CARD Financial Accounts.

Expiry date for the card. This filter will return Financial Accounts where the card has an expiry date on or before this date.

fulfillmentHouse

string

This filter is available for CARD Financial Accounts. ID of the printer where the cards will be printed.

last4Digits

string, max length: 4

This filter is available for CARD Financial Accounts. Last 4 digits of the card number.

nameOnCard

string, max length: 60, min length: 1

This filter is available for CARD Financial Accounts. Customer’s name as it appears on the card.

resultFormat

string enum, values: CSV, JSON

Type of file used to store the search results.