Skip to main content
REST request body
Response example
POST /api/external/bank_accounts/ Creates a new fiat settlement or beneficiary bank account under the API user’s organization. accountName, bankAccountInfo, paymentRails, and currency are required. The fields required inside bankAccountInfo and beneficiary depend on the country and payment rail.
Send the complete set of bankAccountInfo and beneficiary fields for each rail in paymentRails. The SDK marks most nested fields optional, but the rail can still require them.

Request body

string
Sub-org that owns the account. Set only at creation.
string
required
Account-holder name.
BankAccountInfo
required
Bank and account identifiers. Send the fields that the country and payment rail need. See BankAccountInfo.
string[]
required
Payment rails the account supports: ACH, WIRE, SEPA, SWIFT, FPS, NIP, PIX, or UAEFTS. See PaymentRail.
BankAccountBeneficiary
Account holder. Set entityType, then send the matching business or individual object. See BankAccountBeneficiary.
string
required
Account currency, for example USD, EUR, NGN, or AED.
string
Client-controlled bank-account reference.
string[]
Tags for the bank account.

Response

Returns the new BankAccount with status: "PENDING".
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.

Approve the bank account

A new bank account comes back with status: "PENDING" and needs your API user’s approval. Call Get Approval Message with entityId set to the bank account id, sign the message, and send the signature to Submit Approval Action. See Approvals for the full flow. With the SDK, approve separately or in one call:
Use the returned id with Retrieve Bank Account to check the current status.
REST request body
Response example