Skip to main content
Request example
Response example
GET /api/external/bank_accounts/{bankAccountId}/ Returns one bank account by its identifier. Use this to read the current status and exact account fields for a previously created bank account.
Bank-account data is sensitive. Avoid logging full account numbers, routing numbers, IBANs, and beneficiary identity documents, and preserve the organization or sub-org scope returned by the API.

Path parameters

string
required
The bank account ID.

Response

Returns a BankAccount.
string
Bank account ID.
string
Organization that owns the bank account.
string
Sub-org that owns the bank account, if any.
string
Organization entity that owns the account.
string
User or API user that created the bank account.
string
Creation timestamp (ISO 8601).
string
Last update timestamp (ISO 8601).
boolean
Whether the bank account is deleted.
BankAccountStatus
PENDING, APPROVED, or DECLINED. A new bank account stays PENDING until it’s approved. See BankAccountStatus.
string | null
Account-holder name.
BankAccountInfo | null
Bank and account identifiers. See BankAccountInfo.
string[]
Payment rails the account supports: ACH, WIRE, SEPA, SWIFT, FPS, NIP, PIX, or UAEFTS. See PaymentRail.
BankAccountBeneficiary | null
Account holder. entityType decides whether business or individual is present. See BankAccountBeneficiary.
string | null
Account currency.
string | null
Client-controlled bank-account reference.
string[]
Tags on the bank account.
Request example
Response example