Create an account

Creates a new beneficiary account for the authenticated organisation.

Authentication

AuthorizationBearer
Token obtained via the login flow.

Request

This endpoint expects an object.
namestringRequired<=33 characters

Legal name of the beneficiary. Max 33 chars (SWIFT limit).

currencystringRequired
ISO 4217 fiat currency code.
bicstringRequired

SWIFT BIC (8 or 11 characters) of the beneficiary’s bank.

addressobjectRequired
ibanstringOptional

IBAN, if applicable. Either iban or accountNumber must be provided.

accountNumberstringOptional

Account number when no IBAN is available. Either iban or accountNumber must be provided.

bankNamestringOptional
Name of the beneficiary's bank.
bankCountrystringOptional

ISO 3166-1 alpha-2 country code of the beneficiary’s bank.

Response

Account created.
accountIdstring
typeenum

beneficiary — outbound payment destination; deposit — inbound funding account.

currencystringOptional
ISO 4217.
accountHolderstringOptional
accountNumberstringOptional
ibanstringOptional
bicstringOptional
swiftReferencestringOptional
bankNamestringOptional
countrystringOptional

ISO 3166-1 alpha-2.

addressobjectOptional
bankCountrystringOptional

ISO 3166-1 alpha-2 country code of the beneficiary’s bank.

statusenumOptional

Errors

400
Bad Request Error
401
Unauthorized Error