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.

idstringUnique identifier of the beneficiary in the ZWITCH database.

Example: vab_KvV9YEA4O9ABJNPq0cNJtjvuK
objectstringAPI object that is returned.

Possible value: beneficiary.account_number
typestringType of beneficiary added.

Possible values: account_number
name_of_account_holderstringBeneficiary's name.

Example: Anil Reddy Enterprises
emailstringBeneficiary's email address.

Example: [email protected]
phonestringBeneficiary's phone number.

Example: 9876543210
bank_account_numberstringBeneficiary's bank account number.

Example: 98765432101234
bank_ifsc_codestringBeneficiary's bank IFSC.

Example: HDFC0000123
bank_namestringBeneficiary's bank name.

Example: hdfc
metadataobjectObject of key-value pair that can be used to store additional information about the entity.
  • Each pair cannot exceed 256 characters.
  • Maximum 5 key-value pairs.

Example: "key_1": "We are using Zwitch.”
created_atinteger Unix timestamp when the create beneficiary request was received by ZWITCH.

Example: 1640179951
statusstringStatus of the beneficiary.

Possible values: active
is_sandboxbooleanThe mode in which the API was triggered.

Possible values:
  • true: API was triggered in sandbox mode
  • false: API was triggered in live mode
account_idstringUnique identifier of the account to which the beneficiary is linked.

Example: va_Y6evcApKFXhQ9X7qKQ5AaysEI
deletedstringReturned only when a beneficiary is deleted.

Possible value: true
deleted_atintegerReturned only when a beneficiary is deleted.

Unix timestamp when the beneficiary was deleted.

Example: 1640179951