POST
/
api
/
v1
/
beneficiaries
Create New Beneficiary
curl --request POST \
  --url http://localhost:8080/api/v1/beneficiaries \
  --header 'Content-Type: application/json' \
  --data '
{
  "client_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "account_number": "<string>",
  "address": "<string>",
  "bank_address": "<string>",
  "bank_name": "<string>",
  "bic": "<string>",
  "city": "<string>",
  "country_code": "<string>",
  "display": true,
  "iban": "<string>",
  "postal_code": "<string>",
  "routing_number": "<string>",
  "swift_code": "<string>"
}
'
{
  "client_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "display": true,
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "account_number": "<string>",
  "address": "<string>",
  "bank_address": "<string>",
  "bank_name": "<string>",
  "bic": "<string>",
  "city": "<string>",
  "country_code": "<string>",
  "iban": "<string>",
  "postal_code": "<string>",
  "routing_number": "<string>",
  "swift_code": "<string>"
}

Body

application/json

Request to create a new beneficiary

​
client_id
string<uuid>
required

Client UUID who owns this beneficiary

​
name
string
required

Beneficiary name (person or company name)

​
account_number
string | null

Bank account number (non-SEPA)

​
address
string | null
​
bank_address
string | null

Bank address

​
bank_name
string | null

Bank name

​
beneficiary_type
enum<string>

Type of beneficiary

Available options:
PERSON,
COMPANY
​
bic
string | null

Bank Identifier Code (SEPA) - 8 or 11 characters

​
city
string | null
​
country_code
string | null

ISO 3166-1 alpha-3 country code

​
display
boolean

Whether beneficiary is displayed to users

​
iban
string | null

International Bank Account Number (SEPA) - validated with checksum

​
postal_code
string | null
​
routing_number
string | null

US ABA routing number (9 digits)

​
swift_code
string | null

SWIFT code for international transfers

Response

Beneficiary created successfully

Beneficiary - Payment recipient entity

​
beneficiary_type
enum<string>
required

Beneficiary Type - Individual person or company

Available options:
PERSON,
COMPANY
​
client_id
string<uuid>
required
​
created_at
string<date-time>
required
​
display
boolean
required

Whether beneficiary is displayed to users

​
id
string<uuid>
required
​
name
string
required

Beneficiary name (person or company name)

​
updated_at
string<date-time>
required
​
account_number
string | null

Bank account number (non-SEPA)

​
address
string | null
​
bank_address
string | null

Bank address

​
bank_name
string | null

Bank name

​
bic
string | null

Bank Identifier Code (SEPA)

​
city
string | null
​
country_code
string | null

ISO 3166-1 alpha-3 country code

​
iban
string | null

International Bank Account Number (SEPA)

​
postal_code
string | null
​
routing_number
string | null

US ABA routing number

​
swift_code
string | null

SWIFT code for international transfers