Skip to main content
POST
/
v1
/
beneficiaries
Create a beneficiary
curl --request POST \
  --url http://localhost:8080/v1/beneficiaries \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "individual",
  "first_name": "<string>",
  "last_name": "<string>",
  "country": "<string>",
  "company_name": "<string>",
  "email": "[email protected]",
  "bank_name": "<string>",
  "account_number": "<string>",
  "iban": "<string>",
  "swift_bic": "<string>",
  "wallet_address": "<string>",
  "wallet_network": "<string>"
}
'
{
  "id": "ben_cq1234567890abcdef",
  "merchant_id": "<string>",
  "type": "individual",
  "status": "pending",
  "first_name": "<string>",
  "last_name": "<string>",
  "company_name": "<string>",
  "email": "[email protected]",
  "phone": "<string>",
  "country": "<string>",
  "bank_name": "<string>",
  "account_number": "<string>",
  "iban": "<string>",
  "swift_bic": "<string>",
  "wallet_address": "<string>",
  "wallet_network": "<string>",
  "token_contract": "<string>",
  "token_symbol": "<string>",
  "address_verified": true,
  "metadata": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

Merchant API key: ak_live_... or ak_test_...

Body

application/json
type
enum<string>
required
Available options:
individual,
business
first_name
string
required
last_name
string
required
country
string
required
company_name
string
email
string<email>
bank_name
string
account_number
string
iban
string
swift_bic
string
wallet_address
string
wallet_network
string

Response

Beneficiary created

id
string
Example:

"ben_cq1234567890abcdef"

merchant_id
string
type
enum<string>
Available options:
individual,
business
status
enum<string>
Available options:
pending,
verified,
blocked
first_name
string
last_name
string
company_name
string
email
string<email>
phone
string
country
string
bank_name
string
account_number
string
iban
string
swift_bic
string
wallet_address
string
wallet_network
string
token_contract
string
token_symbol
string
address_verified
boolean
metadata
object
created_at
string<date-time>
updated_at
string<date-time>