Get Customer Account Details

📘

Note

Before you can retrieve the customer account details, 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 Customer Account Details endpoint is part of the Instant Account Verification (US) service and enables you to download the actual account number and routing number for the customer’s Automated Clearing House (ACH) payment, which is used to set up an ACH payment. Using the Get Customer Account Details endpoint minimises any ACH payment processing errors related to incorrect account details supplied.

You can retrieve customer account details (the account number and routing number) by making a GET request to the Get Customer Account Details endpoint, with the Open Banking customer identifier and account identifier included. For example:

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

📘

Note

You can retrieve the account_id from the response of the Get All Customer Accounts endpoint, or from the Open Banking Registration webhook. For more information on the Open Banking Registration webhook, see Event Code 117 - Open Banking Registration.

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/98765/details \
     --header 'accept: application/json' \
     --header 'client-id: Client A' \
     --header 'partner-id: 1234567890123'

If successful, a 200 response is returned with details of the customer's account details.

{
  "paymentInstruction": {
    "type": "ach",
    "accountNumber": "1000001111",
    "tanEnabled": true,
    "descriptors": [
      {
        "type": "routingNumber",
        "value": "2434345"
      }
    ],
    "transferInEnabled": true,
    "transferOutEnabled": true
  }
}

TANs vs Normal Account Numbers

A Tokenised Account Number (TAN) is a tokenised version of the account number in the response to the Get Customer Account Details call. Chase and PNC (and by March 2026, US Bank) return a TAN in place of the real account number and routing number. The TAN enabled flag in the response indicates when TANs are used.

If the account number is a TAN, it must be used as the account number to set up the ACH payment.

If a Thredd client wants to display the confirmed account number to the end user, they need to be aware that the end user will not know what their TAN is and therefore may potentially be confused by what the TAN is.

Additionally, Thredd suggests to not revoke consent to the accounts with TANs in place because when consent is revoked, the TAN becomes invalid and all the future payments set up to this TAN will fail.

For more information, see Mastercard Developers.

📘

More Information

To view this endpoint in the API Explorer, see Get Customer Account Details.

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