v4

latestOpenAPI 3.1.0Proprietaryraw.githubusercontent.com2026-04-277127123.7 KB

Bank Accounts

Create bank account

Registers a bank account for a customer (or the authenticated account). Use GET /bankaccounts/validation first to obtain the required fields for the given currency and country.

post/bankaccounts

Request body

customer_idinteger

Customer ID to assign the bank account to. Required unless customer_type is source.

customer_type'source'

Pass source to register a bank account for the authenticated account instead of a customer.

namestring required

Account holder name.

Bank account type. IBAN for SEPA accounts, BSB_ACCOUNT for Australian accounts, INTERNATIONAL for SWIFT/BIC accounts, CLEARJUNCTION / CURRENCYCLOUD for gateway-linked accounts, PA_CTE / PA_AHORRO for Spanish payment accounts, and OTHER / CL_CTE / CL_VISTA / CL_AHORRO / ZEPTO for other formats.

numberstring required

Bank account number or IBAN. Must be a valid IBAN when type is IBAN, CLEARJUNCTION, or CURRENCYCLOUD.

bicstring

BIC/SWIFT code. Required for INTERNATIONAL type. Auto-populated from bsb for BSB_ACCOUNT.

bsbstring

6-digit BSB code (Australian bank routing number). Required for BSB_ACCOUNT type.

cod_entidadstring

Entity code for Spanish payment accounts (PA_CTE / PA_AHORRO). Auto-populated from bic.

ibanstring

IBAN (alternative field to number for SEPA accounts).

tagstring

Example request

{
  "customer_id": 7485,
  "name": "My bank account",
  "type": "IBAN",
  "number": "ES1300812944953951475955",
  "bic": "CAIXESBBXXX"
}

Response

Bank account created

idinteger

selfstring

uuidstring

typestring

Account type (e.g. IBAN, ACCOUNT).

namestring nullable

Account holder name.

numberstring

Masked account number or IBAN.

bicstring nullable

tagstring nullable

metadataobject nullable

created_atstring date-time nullable

connectionsConnections

Hypermedia links to related resources.