Design / Financial Account Use Cases / Recipient / Retrieve a Recipient’s Default Financial Account

Retrieve a Recipient’s Default Financial Account

Overview

In this use case, we’ll walk through retrieving the default Financial Account for a Recipient.

A Recipient may have multiple Financial Accounts linked to their Recipient Account; one of these accounts is designated as the Recipient’s default account for transactions.

API Operation

Steps

Send a request to the following endpoint:

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

Include an Authorization header with your RocketKOR access token as a Bearer Token.
Use {recipientId} to specify the Recipient Account ID. The default Financial Account will be retrieved for this Recipient Account.
Request body is not required.

Sample Response

The response includes details about the recipient’s default Financial Account, as well as details for the card or bank account linked to the Financial Account. For details, see the Card Financial Account object and the Bank Financial Account object.

In the following example, the recipient’s default Financial Account is a debit card.

				
					{
  "id": "6a017f06-83a3-44b7-be6f-5e5cae4a9ed7",
  "businessAccountId": "ccab4527-c320-4952-a38c-aebeb719eeab",
  "name": "Debit Card",
  "defaultFlag": true,
  "currency": "USD",
  "state": "ACTIVE",
  "createdAt": "2021-07-08T21:10:51.610Z",
  "updatedAt": "2021-07-08T21:10:51.610Z",
  "accountType": "EXTERNAL",
  "accountHolderId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "accountHolderType": "RECIPIENT",
  "card": {
    "firstName": "Mark",
    "middleName": "David",
    "lastName": "Strong",
    "type": "DEBIT",
    "expiry": "2027-12",
    "billingAddress": {
      "addressLine1": "625 Queen St",
      "addressLine2": "",
      "addressLine3": "",
      "city": "Vancouver",
      "state": "BC",
      "country": "Canada",
      "postalCode": "V5K 0A1"
    },
    "cardNumber": "84563876999"
  }
}

Retrieve a Recipient’s Default Financial Account

Overview

API Operation

Steps

Sample Response

ON THIS PAGE