Get All Customer Accounts

📘
Note
Before you can retrieve the customer accounts, the customer needs to be registered with Open Banking and have at least one financial account connected. This is done using the Register Open Banking Customer endpoint.

The Get All Customer Accounts endpoint enables you to retrieve all connected accounts for a customer. It is a free to use Open Banking management endpoint, used to check and validate the status of connected customer accounts.

You can retrieve all customer accounts by making a GET request to the Get All Customer Accounts endpoint, with the openbanking_customer_id provided in the Register Open Banking Customer API response.

https://uat-api.thredd.com/api/v1/open-banking/customers/{openbanking_customer_id}/accounts

The request header must include the client-id for the request, and an optional partner-id. See the below example.

curl --request GET \
     --url https://uat-api.thredd.com/api/v1/open-banking/customers/12345/accounts \
     --header 'accept: application/json' \
     --header 'client-id: Client A' \
     --header 'partner-id: 1234567890123'

If successful, a 200 response is returned with the accounts associated with the customer identifier included in the endpoint.

{
  "request_id": "string",
  "customer_accounts": [
    {
      "id": "string",
      "number": "string",
      "accountNumberDisplay": "1234-9",
      "name": "string",
      "balance": 0,
      "type": "checking",
      "status": "pending",
      "customerId": "string",
      "institutionId": "string",
      "currency": "USD",
      "realAccountNumberLast4": "string",
      "balanceDate": 0,
      "aggregationSuccessDate": 0,
      "aggregationStatusCode": 0,
      "aggregationAttemptDate": 0,
      "createdDate": 0,
      "lastUpdatedDate": 0,
      "linkedAccountDate": 0,
      "lastTransactionDate": 0,
      "institutionLoginId": 0,
      "displayPosition": 0,
      "accountNickname": "string",
      "oldestTransactionDate": 0,
      "marketSegment": "string",
      "detail": {
        "available_balance_amount": 0
      }
    }
  ],
  "count": 1
}

📘
More Information

To view this endpoint in the API Explorer, see Get All Customer Accounts.

To view details on the fields included in this endpoint, see Get All Customer Accounts - Field Descriptions.

Updated 7 days ago