Design / Financial Account Use Cases / Recipient / List All Financial Accounts for a Recipient

List All Financial Accounts for a Recipient

Overview

In this use case, we’ll walk through retrieving all Financial Accounts linked to a Recipient Account. The response includes details for each Financial Account, including details for the card or bank account linked to the Financial Account.

API Operation

Steps

Send a request to the following endpoint:

GET /v1/recipients/{recipientId}/financial-accounts

Include an Authorization header with your RocketKOR access token as a Bearer Token.
Use {recipientId} to specify the Recipient Account ID. All Financial Accounts belonging to this Recipient Account will be retrieved.
Filter the results based on the Financial Account type and state.
Use the sort query parameter to sort the results.
Use the page and size query parameters to limit the number of results returned.
Request body is not required.

Sample Response

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). Details are returned for each Financial Account.

In the following example, two Financial Accounts have been retrieved for the Recipient Account: a debit card and a bank account.

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

List All Financial Accounts for a Recipient

Overview

API Operation

Steps

Sample Response

ON THIS PAGE