Overview of the beneficiary.account_number object.
Shown below is a sample beneficiary.account_number object.
{
"id": "vab_XJ240TO790ETLmK6aY6vKUtPx",
"object": "beneficiary.account_number",
"type": "account_number",
"name_of_account_holder": "Ganga Reddy",
"email": "[email protected]",
"phone": "9888763451",
"bank_account_number": "55678490012348",
"bank_ifsc_code": "ABCD0000123",
"bank_name": "abcd",
"metadata": {
"key_1": "DD",
"key_2": "XOF"
},
"created_at": 1652698298,
"status": "active",
"is_sandbox": true,
"account_id": "va_TXXQA20wPWf4KY9WrhoqGXjG6"
}
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.account_number |
| type | string | Type of beneficiary added. Possible values: account_number |
| 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 |
| bank_account_number | string | Beneficiary's bank account number. Example: 98765432101234 |
| bank_ifsc_code | string | Beneficiary's bank IFSC. Example: HDFC0000123 |
| bank_name | string | Beneficiary's bank name. Example: hdfc |
| 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 | string | 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 |