Skip to main content
POST
Create beneficiary

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
currency_id
string
required

Currency code

Maximum string length: 3
Example:

"EUR"

entity_type
enum<string>
required

Beneficiary entity type

Available options:
individual,
company
Example:

"company"

uuid
string

UUID of beneficiary

name
string

Name of beneficiary

Maximum string length: 255
Example:

"Aliaksandr"

bank_country
string

Alpha-2 bank country code. Used for DEFAULT bank details.

Maximum string length: 2
Example:

"LT"

iban
string

IBAN. Used for DEFAULT bank details.

Maximum string length: 255
Example:

"NL13RABO4448094871"

bic_swift
string

BIC/SWIFT. Used for DEFAULT bank details and not required for SEPA accounts.

Example:

"AGBLLT2X"

account_number
number

Account number. Used for LOCAL bank details.

sort_code
number

Sort code. Used for LOCAL bank details.

bank_details_type
enum<string>

Bank details type

Available options:
DEFAULT,
LOCAL
street
string

Beneficiary address street. Required for non-SEPA accounts.

Maximum string length: 64
Example:

"Gagarina street"

house
string

Beneficiary house number. Required for non-SEPA accounts.

Maximum string length: 32
Example:

"22"

city
string

Beneficiary city. Required for non-SEPA accounts.

Maximum string length: 64
Example:

"London"

country_id
string

Beneficiary address country Alpha-2 code. Required for non-SEPA accounts.

Example:

"GB"

postal_code
string

Beneficiary postal code. Required for non-SEPA accounts.

Maximum string length: 32
Example:

"10001"

company_name
string

Company name. Required when entity_type is company.

Maximum string length: 35
Example:

"Finsei Ltd."

first_name
string

Beneficiary first name. Required when entity_type is individual.

Maximum string length: 64
Example:

"Aliaksandr"

last_name
string

Beneficiary last name. Required when entity_type is individual.

Maximum string length: 64
Example:

"Lastname"

Response

OK

status
string
Example:

"SUCCESS"

message
string
data
object