Bank Accounts
Create a Bank Account
Save a bank account. Required fields depend on the country and payment rail. The account needs your API user’s approval.
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
Bank and account identifiers. Send the fields that the country and payment rail need. See BankAccountInfo.
Payment rails the account supports:
ACH, WIRE, SEPA, SWIFT, FPS, NIP, PIX, or UAEFTS. See PaymentRail.Account holder. Set
entityType, then send the matching business or individual object. See BankAccountBeneficiary.Response
Returns the new BankAccount withstatus: "PENDING".
Sub-org that owns the bank account, if any.
PENDING, APPROVED, or DECLINED. A new bank account stays PENDING until it’s approved. See BankAccountStatus.Bank and account identifiers. See BankAccountInfo.
Payment rails the account supports:
ACH, WIRE, SEPA, SWIFT, FPS, NIP, PIX, or UAEFTS. See PaymentRail.Account holder.
entityType decides whether business or individual is present. See BankAccountBeneficiary.Approve the bank account
A new bank account comes back withstatus: "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