INTRODUCTION

RECIPIENT USE CASES

FINANCIAL ACCOUNT USE CASES

PAYMENT REASON USE CASES

TRANSACTION USE CASES

NOTE USE CASES

Design  /  Financial Account Use Cases  /  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 Account.

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 /api/external/recipients/{recipientId}/financial-accounts/default

  • Use the {recipientId} path parameter to specify the Recipient Account ID. The default Financial Account will be retrieved for this Recipient Account.
  • Request body is not required.
  • Include a Basic Auth Authorization header where the username is your API key ID and the password is your API key secret.

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.

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

				
					{
  "id": "6a017f06-83a3-44b7-be6f-5e5cae4a9ed7",
  "createdAt": "2021-07-08T21:10:51.610Z",
  "updatedAt": "2021-07-08T21:10:51.610Z",
  "name": "Debit Card",
  "accountId": "4py56a34-4686-1539-c2ga-1a723g55dlq3",
  "accountIdType": "RECIPIENT",
  "defaultFlag": true,
  "state": "ACTIVE",
  "financialInstitutionId": "8th32z87-3845-9810-v7gu-1f827g98swk3",
  "financialInstitutionName": "CIBC",
  "ledgerIds": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "card": {
    "id": "7wu45p35-2178-3098-x6wg-2s749k37alk2",
    "token": "2av81w47-9367-1295-h4ng-1q520p28wfn1",
    "firstName": "Mark",
    "middleName": "David",
    "lastName": "Strong",
    "type": "DEBIT",
    "expiry": {
      "year": 2022,
      "month": "JANUARY",
      "monthValue": 1,
      "leapYear": false
    },
    "billingAddress": {
      "addressLine1": "625 Queen St",
      "addressLine2": "",
      "addressLine3": "",
      "city": "Vancouver",
      "state": "BC",
      "country": "Canada",
      "postalCode": "V5K 0A1"
    },
    "cardNumberTail": "6999"
  }
}
				
			
ON THIS PAGE