List All Financial Accounts

accountHolderTypes

string, values: BUSINESS_ACCOUNT, CUSTOMER, RECIPIENT

Filter the results by the type of account holder. The following values are supported:

• BUSINESS_ACCOUNT  Retrieve Financial Accounts owned by the Business Account.
• CUSTOMER  Retrieve Financial Accounts belonging to Customers within the Business Account.
• RECIPIENT  Retrieve Financial Accounts belonging to Recipients within the Business Account.

Use a comma-separated list to specify multiple values (example: CUSTOMER,RECIPIENT).

accountHolderId

string (UUID)

Filter the results by a specific account holder. The account holder can be a Business Account, Customer, or Recipient.

categories

string enum, values: INTERNAL, EXTERNAL, INTEGRATED

Filter the results by 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.

name 

string, max length: 100, min length: 1

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

defaultFlag

boolean

Filter the results based on whether this is the account holder’s default Financial Account.

parentId

string (UUID)

Filter the results based on the ID of the Parent Business Financial Account.

type

string enum, values: BANK, CARD

Filter the results by the type of Financial Account. The following values are supported:

• BANK  Bank account
• CARD  Debit, credit, or prepaid card

state

string enum, values: ACTIVE, SUSPENDED

Filter the results by the state of the Financial Account. The following values are supported:

• ACTIVE  Financial Account is active.
• SUSPENDED  Financial Account is inactive.

cardStartingNumbers

string

This filter is only available for issued cards. Filter the results by the starting numbers for the card. These numbers identify the card BIN and the Program ID.

cardProgramId

string

This filter is only available for issued cards. Filter the results by the Card Program ID. This can be useful if multiple Card Programs use the same starting numbers.

cardEndingNumbers

string

This filter is only available for issued cards. Filter the results by the last 4 digits of the card number.

cardExpiry

string, format: YYY-MM

This filter is only available for issued cards. Filter the results by the card expiry date.

shippingMethod

string enum, values: NORMAL, URGENT, VIP, BULK, BULK_URGENT, BULK_VIP

This filter is only available for issued cards. Filter the results by the card shipping method. The following values are supported:

• NORMAL  Normal shipment
• URGENT  Urgent shipment
• VIP  VIP shipment
• BULK  Bulk shipment
• BULK_URGENT  Urgent bulk shipment
• BULK_VIP  VIP bulk shipment

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.

page

integer (int32)

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

size

integer (int32)

Maximum number of results to return per page.