Update Beneficiary
This lets you update an existing beneficiary
Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Path Parameters
ID of the exisitng beneficiary
Body
Beneficiary Name
business or individual
Address
Phone
Destination Details
Set of key-value pairs to attach to the beneficiary
Tax ID of the beneficiary. (CPF or CPNJ is mandatory for payouts to Brazil)
Documents for the beneficiary
National ID of the individual
Response
200
Represents a payout beneficiary with personal, contact, and destination details.
Address details of the beneficiary.
Date of birth of the beneficiary in YYYY-MM-DD format.
ISO 3166-1 alpha-2 country code representing the beneficiary's nationality.
Identifier or reference to the beneficiary's payment destination (bank account, wallet, etc.).
Details about the payout destination, such as wallet or bank.
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, such as 'self', 'third_party', etc.
Contact phone information of the beneficiary.
Registration or incorporation number for business beneficiaries.
Tax identification number for the beneficiary.
Specifies whether the beneficiary is an 'individual' or a 'business'.