Returns the bank account with the given identifier.

GET /banking/bank-accounts/{id}

Group: Banking › Bank Accounts · Operation ID: getBankAccount

Returns the account's payment credentials. reference is the IBAN or ACH number, bankAccountCode the SWIFT/BIC or US routing number, and bankAccountHolderName is personal data. mask is the safe display form. accountNumber is the chart-of-accounts number, not a bank one.

A soft-deleted account is not returned.

Open in the interactive reference

Parameters

Name In Type Required Description
Api-Version header "v1" yes The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version v1.
id path string yes The unique identifier for the bank account to return.

Response

200 Success

Under data (getBankAccountOutput):

Field Type Required Description
id string yes The unique identifier for the bank account.
externalAccountId string yes The identifier this account has in the bank or aggregator it was connected from. Unique within the tenant.
externalAccountName string no The account name as reported by the bank or aggregator.
externalDescription string no The account description as reported by the bank or aggregator.
type string no The kind of account, as free-form text. For example 'checking', 'saving' or 'creditCard'.
currency string no The currency the account is held in. Format ISO 4217, for example 'USD'. balance is in this currency.
balance string (decimal) no The current account balance, in currency.
mask string no A masked form of the account number, for example '****1234'. Display it instead of reference where the full number is not needed.
reference string no The full account number, the IBAN or the ACH account number.
referenceType string no How referenceNumber is structured. Possible values: 'QRR', 'SCOR', 'NON'. 'QRR' is a Swiss QR reference, 'SCOR' an ISO 11649 creditor reference, and 'NON' none.
referenceNumber string no A structured payment reference for payments to this account, interpreted per referenceType.
bankAccountCode string no The bank identifier, the SWIFT/BIC code or the US routing number.
bankAccountHolderName string no The name the account is held in. This is personal data.
paymentAllowed boolean yes Whether payments may be made from this account.
receivableAccount boolean no Whether this account may be used to receive money.
payableAccount boolean no Whether this account may be used to pay money out.
isReady boolean no Whether the account is fully set up and usable.
reconciliationStartDate string (date) yes The date from which this account is reconciled. Format YYYY-MM-DD. Transactions before it are not reconciled.
transactionsImportDate string (date) no The date from which transactions are imported for this account. Format YYYY-MM-DD.
accountId string no The chart-of-accounts account this bank account is linked to. See id on GET accounting/accounts/:id.
accountName string no The name of the linked chart-of-accounts account.
accountNumber string no The number of the linked chart-of-accounts account. This is a general-ledger account number, not the bank account number, which is reference.
bankName string no The name of the bank this account is held at.
financialInstitutionId string no The financial institution this account is held at. There is no endpoint for it.
entityId string no The legal entity that owns this account. See id on GET base/entities.
entityName string no The name of the legal entity that owns this account.
lastModifiedDate string (date-time) yes The date and time the bank account last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.

Errors

Code Status
NOT_FOUND 400

Statuses