RocketKOR

List All Financial Accounts

Retrieve all Financial Accounts for a Business Account. This includes Financial Accounts owned by the Business Account, as well as Customer Financial Accounts and Recipient Financial Accounts within the Business Account.

Note  Financial Accounts will be retrieved for the Business Account associated with the request access token.

You can filter the results based on filters such as account holder ID, account holder type, account category, and account name. Use the sort query parameter to sort the results, and use the page and size query parameters to limit the number of results returned.

Endpoint

GET /v1/financial-accounts

Authorization Header

Authorization: Bearer <access_token>

Query Parameters

accountHolderTypes

string, values: BUSINESS_ACCOUNT, CUSTOMER, RECIPIENT

Filter the results by the type of account holder. Possible values are:

  • 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, values: INTERNAL, EXTERNAL, INTEGRATED

Filter the results by Financial Account category. Possible values are:

  • INTERNAL  A Financial Account that is issued and managed by RocketKOR.
  • EXTERNAL  A Financial Account that is issued and managed by a financial institution.
  • INTEGRATED  A Financial Account that resides inside a financial institution. The Financial Account may be managed by RocketKOR and/or the financial institution.

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

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. Possible values are BANK (bank account) and CARD (card account).

state

string enum, values: ACTIVE, SUSPENDED

Filter the results by the state of the Financial Account. Possible values are ACTIVE (account is active) and SUSPENDED (account is inactive).

sort

array [string]

Sort the response by any field in ascending or descending order. For details, see Sorting and Pagination. The default sort order is createdAt,DESC.

page

integer (int32)

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

size

integer (int32)

Maximum number of results to return per page.

Request Body

None

Returns

Returns a paginated response with an array of Internal Financial Account Summary objects (for internal Financial Accounts), Card Summary objects (for card accounts), and Bank Account Summary objects (for bank accounts).

SAMPLE RESPONSE

				
					{
  "totalElements": 100,
  "totalPages": 50,
  "number": 1,
  "numberOfElements": 2,
  "hasNext": true,
  "content": [
    {
      "id": "cac69d6d-66d7-49c3-8caa-2fde3b0beb44",
      "parentId": "4563ee45-446e-4c6e-83d8-2d5767614a5",
      "businessAccountId": "26b0ef39-72e9-4b0a-a183-9f1142083f03",
      "name": "Internal Checking Account",
      "defaultFlag": false,
      "currency": "USD",
      "accountHolderId": "8eb2a485-c074-40ac-a6e4-7a49e442ce45",
      "accountHolderType": "CUSTOMER",
      "state": "ACTIVE",
      "maskedAccountNumber": "******1454",
      "createdAt": "2022-07-14T21:41:28.111137Z",
      "updatedAt": "2022-07-14T21:41:28.111137Z",
      "category": "INTERNAL",
      "type": "BANK",
      "subtype": "CHECKING"
    },
    {
      "id": "90dcbd64-b1fa-4429-adeb-4d5e8dcf90d7",
      "parentId": "",
      "businessAccountId": "26b0ef39-72e9-4b0a-a183-9f1142083f03",
      "name": "Debit Card",
      "defaultFlag": false,
      "currency": "USD",
      "accountHolderId": "8eb2a485-c074-40ac-a6e4-7a49e442ce45",
      "accountHolderType": "CUSTOMER",
      "state": "ACTIVE",
      "maskedAccountNumber": "******9785",
      "createdAt": "2022-07-14T21:41:28.111137Z",
      "updatedAt": "2022-07-14T21:41:28.111137Z",
      "category": "EXTERNAL",
      "type": "CARD",
      "subtype": "DEBIT",
      "card": { 
        "firstName": "Mark",
        "middleName": "David",
        "lastName": "Strong",
        "cardNumberTail": "6999",
        "expiry": "2027-12",
        "billingAddress": {
          "addressLine1": "625 Queen St",
          "addressLine2": "",
          "addressLine3": "",
          "city": "Vancouver",
          "state": "BC",
          "country": "Canada",
          "postalCode": "V5K 0A1"
        }
      }
    },
    {
      "id": "1bb964b2-9825-46d8-ba77-ac64079bc72d",
      "parentId": "",
      "businessAccountId": "26b0ef39-72e9-4b0a-a183-9f1142083f03",
      "name": "Checking Account",
      "defaultFlag": false,
      "currency": "USD",
      "accountHolderId": "8eb2a485-c074-40ac-a6e4-7a49e442ce45",
      "accountHolderType": "CUSTOMER",
      "state": "ACTIVE",
      "maskedAccountNumber": "******6790",
      "createdAt": "2022-07-14T21:41:28.111137Z",
      "updatedAt": "2022-07-14T21:41:28.111137Z",
      "category": "EXTERNAL",
      "type": "BANK",
      "subtype": "CHECKING",
      "bankAccount": {
        "bankName": "CitiBank",
        "nameOnAccount": "Mark Strong",
        "accountNumberTail": "6790",
        "routingNo": "321171184",
        "businessName": "GLOBAL"
      }
    },
    {
      "id": "1bb964b2-9825-46d8-ba77-ac64079bc72d",
      "parentId": "",
      "businessAccountId": "26b0ef39-72e9-4b0a-a183-9f1142083f03",
      "name": "Checking Account",
      "defaultFlag": false,
      "currency": "USD",
      "accountHolderId": "accb6fde-d7b4-4925-acdf-f9d9c506b6c4",
      "accountHolderType": "CUSTOMER",
      "state": "ACTIVE",
      "maskedAccountNumber": "******6831",
      "createdAt": "2022-07-14T21:41:28.111137Z",
      "updatedAt": "2022-07-14T21:41:28.111137Z",
      "category": "INTEGRATED",
      "type": "BANK",
      "subtype": "CHECKING",
      "bankAccount": {
        "bankName": "CitiBank",
        "nameOnAccount": "Jane Smith",
        "accountNumber": "45056831",
        "accountNumberTail": "6831",
        "routingNo": "321171184",
        "businessName": "GLOBAL"
      }
    }
  ]
}