Retrieve a Recipient’s Default Financial Account

Retrieve the details for a recipient’s default Financial Account. The response includes details about the Financial Account, as well as details for the card or bank account linked to the Financial Account.

Endpoint

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

Authorization Header

Authorization: Bearer <access_token>

Path Parameters

recipientId REQUIRED

string (UUID)

Recipient Account ID.

Request Body

None

Returns

Returns details for the recipient’s default Financial Account. The Card Financial Account object or Bank Financial Account object is returned, depending on whether the Financial Account is a card-based account or a bank account.

SAMPLE RESPONSE

				
					{
  "id": "6a017f06-83a3-44b7-be6f-5e5cae4a9ed7",
  "parentId": "",
  "businessAccountId": "c937109c-6077-4b4e-8d28-c6768e3546c5",
  "name": "Debit Card",
  "defaultFlag": true,
  "state": "ACTIVE",
  "currency": "USD",
  "category": "EXTERNAL",
  "type": "CARD",
  "subtype": "DEBIT",
  "maskedAccountNumber": "******4242",
  "accountHolderId": "8c8c5119-3abd-42e8-8b37-f8eaaa4afacb",
  "accountHolderType": "RECIPIENT",
  "createdAt": "2021-07-08T21:10:51.610Z",
  "updatedAt": "2021-07-08T21:10:51.610Z",
  "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"
    }
  }
}