v1
latestOpenAPI 3.1.02026-07-266133267.6 KBCreate Beneficiary
This lets you create a beneficiary
Request body
Beneficiary Name
Email Address
business or individual
ID of the destination attached to the beneficiary
Set of key-value pairs to attach to the beneficiary
Tax ID of the beneficiary. (CPF or CPNJ is mandatory for payouts to Brazil)
National ID of the individual
Registration number of the business (Mandatory if destination_details.type is a wallet and type is business)
Date of birth of individual, Format DD-MM-YYYY (Mandatory if destination_details.type is a wallet and type is individual)
ISO 3166-1 alpha-2 country code representing the beneficiary's nationality (e.g., US, GB, IN, FR). Optional field used for enhanced compliance screening. Sending this field will reduce compliance hold.
Type of relationship between beneficiary and creator of beneficiary Possible values - self, third_party (Mandatory if destination_details.type is a wallet)
Name in local language
Response
200
Date of birth of the beneficiary in YYYY-MM-DD format.
ISO 3166-1 alpha-2 country code representing the beneficiary's nationality. Optional field used for enhanced compliance screening. Sending this field will reduce compliance hold.
Identifier or reference to the beneficiary's payment destination (bank account, wallet, etc.).
List of documents associated with the beneficiary (e.g., ID proof, address proof).
Email address of the beneficiary.
Full name of the beneficiary.
Local language representation of the beneficiary's name, if applicable.
National identification number or equivalent ID.
Classification of the beneficiary.Possible Values - 'self', 'third_party'.
Registration or incorporation number for business beneficiaries.
Tax identification number for the beneficiary.
Specifies whether the beneficiary is an 'individual' or a 'business'.