Retrieve a Customer’s Financial Accounts

Retrieve all Financial Accounts belonging to a Customer. The response includes details about each Financial Account, as well as details for the card or bank account linked to the Financial Account.

You can filter the results based on the Financial Account type and state. You can also sort the results and limit the number of results returned.

Endpoint

GET /v1/customers/{customerId}/financial-accounts

Authorization Header

Authorization: Bearer <access_token>

Path Parameters

customerId REQUIRED

string (UUID)

ID of the Customer Account.

Query Parameters

type

string enum, values: BANK, CARD

Filter the results by the type of Financial Account. The following values are supported:

BANK Bank account
CARD Debit or credit card

state

string enum, values: PENDING, ACTIVE, SUSPENDED

Filter the results by the state of the Financial Account. The following values are supported:

PENDING Financial Account is being processed and is not yet active.
ACTIVE Financial Account is active.
SUSPENDED Financial Account is inactive.

sort

array of strings

Sort the response by any field in ascending or descending order. The default sort order is createdAt,DESC. For more information, see Sorting and Pagination.

page

integer (int32)

Page number to return, based on zero-based page indexing.

size

integer (int32)

Maximum number of results to return per page.

Request Body

None

Returns

Returns a paginated response with an array of Financial Account objects. The following objects may be 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

				
					{
  "totalElements": 3,
  "totalPages": 1,
  "number": 0,
  "numberOfElements": 3,
  "hasNext": false,
  "content": [
    {
      "id": "6a017f06-83a3-44b7-be6f-5e5cae4a9ed7",
      "businessAccountId": "c937109c-6077-4b4e-8d28-c6768e3546c5",
      "name": "Debit Card",
      "category": "EXTERNAL",
      "type": "CARD",
      "subtype": "DEBIT",
      "defaultFlag": true,
      "currency": "USD",
      "accountHolderId": "8c8c5119-3abd-42e8-8b37-f8eaaa4afacb",
      "accountHolderType": "CUSTOMER",
      "state": "ACTIVE",
      "maskedAccountNumber": "******4242",
      "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",
      "card": {
        "firstName": "Mark",
        "middleName": "David",
        "lastName": "Strong",
        "cardNumber": "123456784242",
        "cardNumberTail": "4242",
        "expiry": "2027-12",
        "billingAddress": {
          "addressLine1": "625 Queen St",
          "addressLine2": "Suite 201",
          "addressLine3": "South Building",
          "city": "Vancouver",
          "stateCode": "BC",
          "countryCode": "CAN",
          "postalCode": "V5K 0A1"
        }
      }
    },
    {...},
    {...}
  ]
}