Overview of the beneficiary.vpa object.
Shown below is a sample beneficiary.vpa object.
{
"id": "vab_eT1hikoDFd0azs2SZYe8jPxYV",
"object": "beneficiary.vpa",
"type": "vpa",
"name_of_account_holder": "Anil Reddy",
"email": "[email protected]",
"phone": "9000000195",
"vpa": "zwitch12345@example",
"metadata": {
"key_1": "DD",
"key_2": "XOF"
},
"created_at": 1659005979,
"status": "active",
"is_sandbox": false,
"account_id": "va_vTXxIy4enPkiLjE60P7PTm3kv"
}
The table below lists the various parameters in the beneficiary.account_number object.
| Parameter | type | Description |
|---|---|---|
| id | string | Unique identifier of the beneficiary in the ZWITCH database. Example: vab_KvV9YEA4O9ABJNPq0cNJtjvuK |
| object | string | API object that is returned. Possible value: beneficiary.vpa |
| type | string | Type of beneficiary added. Possible values: vpa |
| name_of_account_holder | string | Beneficiary's name. Example: Anil Reddy Enterprises |
string | Beneficiary's email address. Example: [email protected] | |
| phone | string | Beneficiary's phone number. Example: 9876543210 |
| vpa | string | Beneficiary's VPA handle. Example: anil-reddy@example |
| metadata | object | Object of key-value pair that can be used to store additional information about the entity.
Example: "key_1": "We are using Zwitch.” |
| created_at | integer | Unix timestamp when the create beneficiary request was received by ZWITCH. Example: 1640179951 |
| status | boolean | Status of the beneficiary. Possible values: active |
| is_sandbox | boolean | The mode in which the API was triggered. Possible values:
|
| account_id | string | Unique identifier of the account to which the beneficiary is linked. Example: va_Y6evcApKFXhQ9X7qKQ5AaysEI |
| deleted | string | Returned only when a beneficiary is deleted. Possible value: true |
| deleted_at | integer | Returned only when a beneficiary is deleted. Unix timestamp when the beneficiary was deleted. Example: 1640179951 |