v1

latestOpenAPI 3.0.02026-07-242444105.9 KB
Beneficiaries

Create Beneficiary

Create a new beneficiary

post/v4/accounts

Request body

counterparty_idinteger required
cidstring required
namestring required
account_type'Bank' | 'Wallet' required
ccystring

Account currency - ISO Code 3

host_namestring

Bank name

host_hubstring

Bank sort code

host_locationstring

Bank address

host_countrystring required

Account country - ISO Code 2

node_namestring

Account name

node_addressstring

Account number

node_location_line_1string

Beneficiary address line 1 - Mandatory for CHAPS payments

node_location_line_2string

Beneficiary address line 2

node_location_line_3string

Beneficiary address line 3

node_location_citystring

Beneficiary address city

node_location_regionstring

Beneficiary address region

node_location_postcodestring

Beneficiary address postcode

node_countrystring

ISO Code 2 letters

node_type'individual' | 'corporate' required
ibanstring
bicstring
account_labelstring

Name - CCY

payment_typestring
emailstring

Beneficiary email address

bcb_controlledinteger required

This is always 1

settlement_referencestring
is_beneficiaryinteger required

This is always 1

Response

Success