Object

Overview of the pan_verification object.

Shown below is a sample pan object.

{
  "id": "pan_XAZyW7rLkhQ16bZEM1SRIl4Q2",
  "object": "pan_verification",
  "pan": "AAAPA0000A",
  "name_on_pan": "Anil Reddy",
  "status": "success",
  "merchant_reference_id": "1000629",
  "message": "PAN verified",
  "metadata": {
    "key_1": "DD",
    "key_2": "XOF"
  },
  "created_at": 1662032873,
  "is_sandbox": false
}

The table below lists the various parameters in the pan object.

ParameterTypeDescription
idstringUnique identifier of the PAN verification request in the ZWITCH database.

Example: pan_jNsJ5K9mz8tHXL7XiJbKr241r
objectstringAPI object that is returned.

Possible value: pan_verification
panstringPAN number to be verified.

Example: AAAPA0000A
name_on_panstringCustomer's name according to the PAN database.

Example: Anil Reddy
statusstringPossible values:
  • success: PAN successfully verified.
  • failed: PAN verification failed.
merchant_reference_idstringUnique identifier entered when creating the verification request.

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

Example: 14096850
messagestringMessage describing the status of the transaction.

Example: Invalid PAN
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_atintegerUnix timestamp when the verify PAN 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.