The Tazapay Beneficiary Object represents the recipient of a payment or payout within the Tazapay platform. This object holds all relevant information about the beneficiary, including personal details, bank account information, and any other relevant metadata required for processing payments to them.
Parameters
{
"address": {
"city": "Vrtmore",
"country": "JM",
"line1": "it12 3cwth",
"postal_code": "00000",
"state": "Vortmore"
},
"date_of_birth": "2003-04-04",
"destination": "",
"destination_details": {
"type": "wallet",
"wallet": {
"currency": "USDC",
"deposit_address": "09e53bcac0f2edxnjsui87f8bb7a9faf64789ed8",
"type": "ethereum"
}
},
"documents": [],
"email": "[email protected]",
"name": "Scott",
"name_local": "",
"national_identification_number": "",
"party_classification": "third_party",
"phone": {
"calling_code": "91",
"number": "9231231231"
},
"tax_id": "",
"type": "individual"
}{
"address": {
"city": "Vrtmore",
"country": "JM",
"line1": "it12 3cwth",
"postal_code": "00000",
"state": "Vortmore"
},
"destination": "",
"destination_details": {
"bank": {
"account_type": "savings",
"bank_codes": {
"swift_code": "FBDEFF"
},
"bank_name": "ER VOLKSBANK EG",
"branch_name": "",
"country": "DE",
"currency": "EUR",
"firc_required": false,
"iban": "DE535019045650474185",
"purpose_code": "",
"transfer_type": "any"
},
"type": "bank"
},
"documents": [],
"email": "",
"name": "GMBH",
"name_local": "",
"national_identification_number": "",
"party_classification": "",
"phone": {
"calling_code": "49",
"number": "9231231231"
},
"registration_number": "",
"tax_id": "",
"type": "business"
},Beneficiary Details
| Field | Type | Description |
|---|---|---|
| id | string | The unique Tazapay identifier for the beneficiary. |
| address | object | The address of the beneficiary. Address Object |
| date_of_birth | string | Date of birth of the beneficiary (for individuals). |
| destination | string | The destination identifier (if applicable). |
| destination_details | object | The details of the destination account. (Destination Details Object) |
| documents | array | The list of documents related to the beneficiary. |
| string | The email address of the beneficiary. | |
| name | string | The name of the beneficiary. |
| name_local | string | The local language name of the beneficiary. |
| national_identification_number | string | The national ID number of the beneficiary. |
| party_classification | enum | Classification of the beneficiary (Possible values - self, third_party). |
| phone | object | The phone details of the beneficiary. (Phone Object) |
| registration_number | string | The registration number (for business beneficiaries). |
| tax_id | string | The tax identification number of the beneficiary. |
| created_at | string (ISO timestamp) | The date and time when the beneficiary was created. |
| metadata | json | Additional key-value pairs associated with the beneficiary (optional). |