This lets you fetch an existing beneficiary
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
ID of the existing beneficiary
200
Represents a payout beneficiary with personal, contact, and destination details.
Address details
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.).
Destination details for beneficiary payouts (discriminated union based on type)
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'.
Phone contact details
Registration or incorporation number for business beneficiaries.
Tax identification number for the beneficiary.
Specifies whether the beneficiary is an 'individual' or a 'business'.