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.

Changes

Changed in 2 of the 4 revisions of this API.6230

Mar 24, 202633c8b5a6215c30See the full diff
- ○
  added the new optional request property bsb
  new-optional-request-property
- ○
  added the new optional request property cod_entidad
  new-optional-request-property
- ○
  added the new optional request property metadata/bank_account_type
  new-optional-request-property
- ○
  added the new optional request property metadata/beneficiary_address
  new-optional-request-property
- ○
  added the new optional request property metadata/beneficiary_city
  new-optional-request-property
- ○
  added the new optional request property metadata/beneficiary_company_name
  new-optional-request-property
- ○
  added the new optional request property metadata/beneficiary_country
  new-optional-request-property
- ○
  added the new optional request property metadata/beneficiary_entity_type
  new-optional-request-property
- ○
  added the new optional request property metadata/beneficiary_first_name
  new-optional-request-property
- ○
  added the new optional request property metadata/beneficiary_last_name
  new-optional-request-property
- ○
  added the new optional request property metadata/beneficiary_postcode
  new-optional-request-property
- ○
  added the new optional request property metadata/beneficiary_state
  new-optional-request-property
- ○
  added the new optional request property metadata/country
  new-optional-request-property
- ○
  added the new optional request property metadata/currency
  new-optional-request-property
- ○
  added the new optional request property metadata/payment_types
  new-optional-request-property
- ○
  added the new optional request property metadata/routing_code_type
  new-optional-request-property
- ○
  added the new optional request property metadata/routing_code_value
  new-optional-request-property
- ○
  the request property bic became optional
  request-property-became-optional
- ○
  the request property customer_id became optional
  request-property-became-optional
- ○
  added the new BSB_ACCOUNT enum value to the request property type
  request-property-enum-value-added
- ○
  added the new CLEARJUNCTION enum value to the request property type
  request-property-enum-value-added
- ○
  added the new CL_AHORRO enum value to the request property type
  request-property-enum-value-added
- ○
  added the new CL_CTE enum value to the request property type
  request-property-enum-value-added
- ○
  added the new CL_VISTA enum value to the request property type
  request-property-enum-value-added
- ○
  added the new CURRENCYCLOUD enum value to the request property type
  request-property-enum-value-added
- ○
  added the new INTERNATIONAL enum value to the request property type
  request-property-enum-value-added
- ○
  added the new PA_AHORRO enum value to the request property type
  request-property-enum-value-added
- ○
  added the new PA_CTE enum value to the request property type
  request-property-enum-value-added
- ○
  added the new ZEPTO enum value to the request property type
  request-property-enum-value-added
- ○
  the tag request property's maxLength was increased from 50 to 100
  request-property-max-length-increased
Mar 11, 2026ff825f6602c862See the full diff
- ▲
  added the new required request property number
  new-required-request-property
- ▲
  added the new required request property type
  new-required-request-property
- ▲
  the request property bic became required
  request-property-became-required
- ▲
  the request property customer_id became required
  request-property-became-required
- ▲
  the request property name became required
  request-property-became-required
- ▲
  the tag request property's maxLength was decreased to 50
  request-property-max-length-decreased
- ●
  the bic request property's maxLength was set to 11
  request-property-max-length-set
- ●
  the name request property's maxLength was set to 255
  request-property-max-length-set

Full history