POST
Create New Beneficiary

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