Object

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.

ParametertypeDescription
idstringUnique identifier of the beneficiary in the ZWITCH database.

Example: vab_KvV9YEA4O9ABJNPq0cNJtjvuK
objectstringAPI object that is returned.

Possible value: beneficiary.vpa
typestringType of beneficiary added.

Possible values: vpa
name_of_account_holderstringBeneficiary's name.

Maximum 50 characters.

Example: Anil Reddy Enterprises

Supported characters:
  • A-Z
  • a-z
  • 0-9
  • .
  • /
  • \
  • -
  • _
  • ,
  • (
  • )
  • '
emailstringBeneficiary's email address.

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

Example: 9876543210
vpastringBeneficiary's VPA handle.

Example: anil-reddy@example
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
statusbooleanStatus 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