bf5f4b8f6f5d

latestOpenAPI 3.1.02026-07-266133267.6 KB

Update Beneficiary

This lets you update an existing beneficiary

put/v3/beneficiary/{id}

Path parameters

idstring required

ID of the exisitng beneficiary

Request body

namestring

Beneficiary Name

typestring

business or individual

metadatastring json

Set of key-value pairs to attach to the beneficiary

tax_idstring

Tax ID of the beneficiary. (CPF or CPNJ is mandatory for payouts to Brazil)

national_identification_numberstring

National ID of the individual

Response

200

date_of_birthstring

Date of birth of the beneficiary in YYYY-MM-DD format.

nationalitystring

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.

destinationstring

Identifier or reference to the beneficiary's payment destination (bank account, wallet, etc.).

documentsobject[]

List of documents associated with the beneficiary (e.g., ID proof, address proof).

emailstring

Email address of the beneficiary.

namestring

Full name of the beneficiary.

name_localstring

Local language representation of the beneficiary's name, if applicable.

national_identification_numberstring

National identification number or equivalent ID.

party_classificationstring

Classification of the beneficiary. Possible Values - 'self', 'third_party'.

registration_numberstring

Registration or incorporation number for business beneficiaries.

tax_idstring

Tax identification number for the beneficiary.

typestring

Specifies whether the beneficiary is an 'individual' or a 'business'.