Object

Overview of the vpa_verification object.

Shown below is a sample object for the vpa_verification object.

{
  "id": "accver_mtBP3HwL4JE6Ywl2oL2wiun09",
  "object": "vpa_verification",
  "vpa": "anil.reddy@example",
  "merchant_reference_id": "1409614085",
  "name_as_per_bank": "Anil Reddy",
  "status": "success",
  "message": "VPA is available for transaction",
  "bank_ifsc_code": "ICIC0000296",
  "bank_account_type": "savings",
  "created_at": 1644843861,
  "is_sandbox": true,
  "metadata": {
    "key_1": "DD",
    "key_2": "XOF"
  }
}

The table below lists the various objects in the vpa_verification object.

ParameterTypeDescription
idstringUnique identifier of the account verification transaction in the ZWITCH database.

Example: accver_Qs93rRv6Vq4EIVzKurII849yj
objectstringAPI object that is returned.

Possible value: vpa_verification
vpastringThe Virtual Payment Address (VPA) handle (UPI ID) you want to verify.

Example: anil.reddy@example
name_as_per_bankstringAccount holder's name as per bank records.

Example: Anil Reddy
statusstringStatus of the account verification transaction.

Possible values:
  • success: The account verification transaction was successfully completed.
  • failed: The account verification transaction was not completed.
messagestringMessage about the account verification transaction.

Example: VPA is available for transaction
bank_ifsc_codestringAccount holder's IFSC

Example: ICIC0000296
bank_account_typestringAccount holder's bank type.

Possible values:
  • savings
  • current
merchant_reference_idstringUnique identifier entered when creating the verification request.

  • Only alphabets and numbers are allowed.
  • Minimum: 7 characters.
  • Maximum: 40 characters.

Example: 1409614085
created_atinteger Unix timestamp when the account validation request was received by ZWITCH.

Example: 1640179951
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
metadataobjectObject of key-value pair that can be used to store additional information about the entity.
  • Maximum 5 key-value pairs.
  • Maximum 256 characters in the metadata object.
Example: "key_1": "DD"