Skip to main content
Create a beneficiary record to store recipient information for future payouts. After creating a beneficiary, add their payment method details using the payment methods endpoint.
Requires an Idempotency-Key header.

Request body

recipient_type
string
required
Beneficiary type: "individual" or "business".
customer_name
string
required
Full name of the beneficiary (individual) or legal business name.
customer_email
string
required
Beneficiary’s email address.
customer_address
string
required
Beneficiary’s physical address.
country
string
required
Beneficiary’s country code (e.g. CHL, MEX, BRA).
customer_nickname
string
A short label for this beneficiary. Defaults to customer_name if omitted.