Retrieve a Customer’s Default Financial Account

Retrieve the details for a Customer’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/customers/{customerId}/financial-accounts/default

Authorization Header

Authorization: Bearer <access_token>

Path Parameters

customerId REQUIRED

string (UUID)

ID of the Customer Account.

Request Body

None

Returns

Returns details for the Customer’s default Financial Account. One of the following objects is returned:

External Bank Financial Account Returned for external bank Financial Accounts.
External Card Financial Account Returned for external card Financial Accounts.
Internal Financial Account Returned for internal Financial Accounts.
Integrated Bank Financial Account Returned for integrated bank Financial Accounts.

SAMPLE RESPONSE

				
					{
  "id": "8th32z87-3845-9810-v7gu-1f827g98swk3",
  "businessAccountId": "a1d8b427-d2b2-4711-bc10-f515366bb8d6",
  "name": "Checking",
  "category": "EXTERNAL",
  "type": "BANK",
  "subtype": "CHECKING",
  "defaultFlag": true,
  "currency": "USD",
  "accountHolderId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "accountHolderType": "CUSTOMER",
  "state": "ACTIVE",
  "maskedAccountNumber": "******6790",
  "createdBy": {
    "id": "59dff46b-03d3-449b-89bf-b8010770864f",
    "type": "employee"
  },
  "createdAt": "2024-09-20T22:09:31.947Z",
  "updatedBy": {
    "id": "59dff46b-03d3-449b-89bf-b8010770864f",
    "type": "employee"
  },
  "updatedAt": "2024-10-20T22:09:31.947Z",
  "bankAccount": {
    "bankName": "Citibank",
    "routingNo": "321171184",
    "accountNumberTail": "4523",
    "nameOnAccount": "Mark Strong",
    "billingAddress": {
      "addressLine1": "625 Queen St",
      "addressLine2": "Suite 201",
      "addressLine3": "South Building",
      "city": "Vancouver",
      "stateCode": "BC",
      "countryCode": "CAN",
      "postalCode": "V5K 0A1"
    }
  }
}