Bank Accounts

Create bank account

Changed on

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

  • Base URL
    https://your-subdomain.truust.io/2.0
  • URL
    https://your-subdomain.truust.io/2.0/bankaccounts
  • Auth
    HTTP bearer

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.

type'IBAN' | 'OTHER' | 'BSB_ACCOUNT' | 'PA_AHORRO' | 'PA_CTE' | 'CL_CTE' | 'CL_VISTA' | 'CL_AHORRO' | 'INTERNATIONAL' | 'ZEPTO' | 'CLEARJUNCTION' | 'CURRENCYCLOUD' required

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

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      the request property became optional

    • info

      the request property became optional

    • info

      added the new BSB_ACCOUNT enum value to the request property

    • info

      added the new CLEARJUNCTION enum value to the request property

    • info

      added the new CL_AHORRO enum value to the request property

    • info

      added the new CL_CTE enum value to the request property

    • info

      added the new CL_VISTA enum value to the request property

    • info

      added the new CURRENCYCLOUD enum value to the request property

    • info

      added the new INTERNATIONAL enum value to the request property

    • info

      added the new PA_AHORRO enum value to the request property

    • info

      added the new PA_CTE enum value to the request property

    • info

      added the new ZEPTO enum value to the request property

    • info

      the request property's maxLength was increased from 50 to 100

    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      the request property became required

    • breaking

      the request property became required

    • breaking

      the request property became required

    • breaking

      the request property's maxLength was decreased to 50

    • warning

      the request property's maxLength was set to 11

    • warning

      the request property's maxLength was set to 255