Retrieve a bank account

Changed on
get/bank_accounts/{id}

Request

  • Base URL
    https://api.endclose.com/v1
  • Auth
    API key in header X-API-KEY

Path parameters

idstring required

The unique identifier of the bank account

Response

Bank account retrieved

idstring uuid

Unique identifier

namestring required

Human readable name for the bank account

maskstring nullable

Last four digits of the account number, as it appears on statements. Populated for Plaid-linked accounts.

display_namestring

Human label for the account: "Name (mask)" when a mask is known, otherwise just the name.

currencystring nullable

Three-letter ISO 4217 currency code (e.g. USD, EUR). Must be uppercase. Optional — bank accounts may be created without a currency.

role'fbo' | 'ach_suspense' | 'network_settlement' | 'secondary_network' | 'revenue' | 'cardholder_adjustment' | 'cash_load' | 'unload_settlement' | 'reserve' | 'escheat' | 'gl' | 'operating' nullable

Canonical account role within a program. Null when the account has no declared role.

created_atstring date-time
updated_atstring date-time

Changes

    • breaking

      the response's property type changed from integer to string, and format from no format to uuid for status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status