Skip to main content
POST
/
v2
/
beneficiary
Create beneficiary
curl --request POST \
  --url https://api.sandbox.finsei.com/v2/beneficiary \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "currency": "EUR",
  "iban": "NL13RABO4448094871",
  "entity_type": "company",
  "uuid": "<string>",
  "name": "Aliaksandr",
  "bank_country": "LT",
  "bic_swift": "AGBLLT2X",
  "account_number": 123,
  "sort_code": 123,
  "bank_details_type": "DEFAULT",
  "street": "Gagarina street",
  "house": 22,
  "city": "London",
  "country_id": "GB",
  "postal_code": 10001,
  "company_name": "Finsei Ltd.",
  "first_name": "Aliaksandr",
  "last_name": "Lastname"
}
'
{
  "errors": {
    "email": "Email cannot be blank."
  },
  "notice": {
    "iban": "It looks like you entered an invalid IBAN number."
  },
  "data": {
    "id": 0,
    "uuid": "string"
  }
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
currency
string
required

Currency

Maximum string length: 3
Example:

"EUR"

​
iban
string
required

IBAN number

Maximum string length: 255
Example:

"NL13RABO4448094871"

​
entity_type
enum<string>
required

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

2-char code of country.⚠ REQUIRED if the currency is not EUR

Maximum string length: 2
Example:

"LT"

​
bic_swift
string

BIC\SWIFT number. ⚠ NOT REQUIRED if SEPA

Example:

"AGBLLT2X"

​
account_number
number

⚠ REQUIRED if the currency is GBP and bank_details_type is local

​
sort_code
number

⚠ REQUIRED if the bank_details_type is local

​
bank_details_type
enum<string>
Available options:
DEFAULT,
LOCAL
​
street
string

Beneficiary address street. ⚠ REQUIRED if the currency is not EUR

Maximum string length: 64
Example:

"Gagarina street"

​
house
string

Beneficiary house number. ⚠ REQUIRED if the currency is not EUR

Maximum string length: 32
Example:

22

​
city
string

Beneficiary city. ⚠ REQUIRED if the currency is not EUR

Maximum string length: 64
Example:

"London"

​
country_id
string

Alpha-2 country code. ⚠ REQUIRED if the currency is not EUR

Example:

"GB"

​
postal_code
string

Beneficiary postal code. ⚠ REQUIRED if the currency is not EUR

Maximum string length: 32
Example:

10001

​
company_name
string

⚠ REQUIRED if entity_type is 'company'

Maximum string length: 128
Example:

"Finsei Ltd."

​
first_name
string

Beneficiary first name. ⚠ REQUIRED if entity_type is 'individual'

Maximum string length: 64
Example:

"Aliaksandr"

​
last_name
string

Beneficiary last name. ⚠ REQUIRED if entity_type is 'individual'

Maximum string length: 64
Example:

"Lastname"

Response

OK

  • Option 1
  • Option 2
​
status
string
Example:

"SUCCESS"

​
message
string
​
data
object