Update Beneficiary

This lets you update an existing beneficiary

PUT /v3/beneficiary/{id}

Update Beneficiary

cURL

curl --request PUT \
  --url https://service-sandbox.tazapay.com/v3/beneficiary/{id} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "metadata": {
    "key1": "value1",
    "key2": "value2"
  }
}
'

200

{}

Authorizations

Authorization · string · header · required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

id · string · required

ID of the exisitng beneficiary

Body

application/json

name · string

Beneficiary Name

type · string

business or individual

address · object

Address

Show child attributes

phone · object

Phone

Show child attributes

destination_details · object

Destination Details

Show child attributes

metadata · string<json>

Set of key-value pairs to attach to the beneficiary

tax_id · string

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

documents · object

Documents for the beneficiary

Show child attributes

national_identification_number · string

National ID of the individual

Response

200

application/json

200

Represents a payout beneficiary with personal, contact, and destination details.

address · object

Address details of the beneficiary.

Show child attributes

date_of_birth · string

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

Example:

"2003-04-04"

nationality · string

ISO 3166-1 alpha-2 country code representing the beneficiary's nationality.

Example:

"IN"

destination · string

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

Example:

""

destination_details · object

Details about the payout destination, such as wallet or bank.

Show child attributes

documents · object[]

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

Example:

[]

email · string

Email address of the beneficiary.

Example:

"[e-mail]"

name · string

Full name of the beneficiary.

Example:

"Scott"

name_local · string

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

Example:

""

national_identification_number · string

National identification number or equivalent ID.

Example:

""

party_classification · string

Classification of the beneficiary, such as 'self', 'third_party', etc.

Example:

"third_party"

phone · object

Contact phone information of the beneficiary.

Show child attributes

registration_number · string

Registration or incorporation number for business beneficiaries.

Example:

""

tax_id · string

Tax identification number for the beneficiary.

Example:

""

type · string

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

Example:

"individual"