RocketKOR

Introduction

Authentication

Sorting and Pagination

Errors

List All Financial Accounts for a Recipient

Retrieve all Financial Accounts belonging to a Recipient Account.

You can filter the results based on the Financial Account type and state. 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 /recipients/{recipientId}/financial-accounts

Authorization Header

Authorization: Bearer <access_token>

where <access_token> is your RocketKOR access token.

Path Parameters

recipientId  REQUIRED

string (UUID)

Recipient Account ID.

Query Parameters

type

string enum, values: bankAccount, card

Filter the results by the type of Financial Account. Possible values are bankAccount (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 Card Summary objects (for card-based Financial Accounts) and Bank Account Summary objects (for bank account Financial Accounts).

SAMPLE RESPONSE

				
					{
  "totalElements": 100,
  "totalPages": 50,
  "number": 1,
  "numberOfElements": 2,
  "hasNext": true,
  "content": [
    {
      "id": "90dcbd64-b1fa-4429-adeb-4d5e8dcf90d7",
      "createdAt": "2022-07-14T21:41:28.111137Z",
      "updatedAt": "2022-07-14T21:41:28.111137Z",
      "accountId": "26b0ef39-72e9-4b0a-a183-9f1142083f03",
      "entityId": "8eb2a485-c074-40ac-a6e4-7a49e442ce45",
      "entityType": "RECIPIENT",
      "defaultFlag": false,
      "state": "ACTIVE",
      "currency": "USD",
      "maskedAccountNumber": "************4242",
      "type": "DEBIT",
      "accountType": "EXTERNAL",
      "card": {
        "type": "DEBIT",
        "cardNumberTail": "4242"
      },
    },
    {
      "id": "1bb964b2-9825-46d8-ba77-ac64079bc72d",
      "createdAt": "2022-07-14T21:41:28.111137Z",
      "updatedAt": "2022-07-14T21:41:28.111137Z",
      "accountId": "26b0ef39-72e9-4b0a-a183-9f1142083f03",
      "entityId": "8eb2a485-c074-40ac-a6e4-7a49e442ce45",
      "entityType": "RECIPIENT",
      "defaultFlag": false,
      "state": "ACTIVE",
      "currency": "USD",
      "maskedAccountNumber": "************4523",
      "type": "CHECKING",
      "accountType": "EXTERNAL",
      "bankAccount": {
        "type": "CHECKING",
        "accountNumberTail": "4523"
      },
    }
  ]
}