Sign in

v1

latestOpenAPI 3.1.02026-07-24111224223.3 KB
Bank accounts

Retrieves a bank account

Returns configuration and status for a single bank account, including identifiers downstream connectors need when refreshing balances. Use before deleting or updating metadata so you preserve institution codes and default subsidiary routing.

get/bank-accounts/{bank_account_id}

Path parameters

bank_account_idstring required

UUID of the bank account to be used in this operation.

Response

OK

idstring uuid required
namestring required

The bank account name

currencystring required

Currency code following ISO-4217

bank_namestring required
subsidiary_idstring uuid
account_codestring

The account code found in the Chart of Accounts

maskstring

Last digits of the bank account number

transactions_start_datestring date nullable

The earliest date from which bank transactions are tracked for this account. Omitted for pre-existing accounts that have no recorded start date.

status'ACTIVE' | 'INACTIVE' required

Example response

{
  "currency": "USD"
}