Overview of the payment object.

Shown below is a sample payment object.

  "id": "tx_eHuSnX1GtF82Z1djxSN2We4j0",
  "object": "payment",
  "account_id": "va_uoTAm1EDcibA65V5YslTp5I3i",
  "amount": 3.69,
  "currency": "inr",
  "transacted_at": 0,
  "bank_reference_number": null,
  "status": "pending",
  "remitter_bank_account_number": null,
  "remitter_bank_ifsc_code": null,
  "remitter_full_name": null,
  "remitter_note": null,
  "remitter_vpa_handle": null,
  "paid_mode": "upi",
  "paid_to": "zwtc810212912@yesbank",
  "transaction_reference_id": null,
  "remark": "Lego Death Star",
  "merchant_reference_id": "1000051",
  "expiry_in_minutes": 10,
  "mandate_id": null,
  "metadata": {
    "key_1": "DD",
    "key_2": "XOF"
  "is_sandbox": true,
  "link": "upi://pay?pa=zwtc810212912@yesbank&pn=xyz&tr=tx_eHuSnX1GtF82Z1djxSN2We4j0&tn=gourav&am=1&cu=INR&mc=xyzw",
  "created_at": 1647345540

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

idstringUnique identifier of the payment in the ZWITCH database.

Example: tx_gwnCHducEmh57rrKUi0EOXhAK

Supported characters:
  • A-Z
  • a-z
  • 0-9
  • _
objectstringAPI object that is returned.

Possible value: payment
account_idstringUnique identifier of the account to which money is credited.

Example: va_Y6evcApKFXhQ9X7qKQ5AaysEI

Supported characters:
  • A-Z
  • a-z
  • 0-9
  • _
amountfloatThe amount received for this payment.

Example: 3.69

Supported characters:
  • `0-9
  • .
currencystring3-letter iso currency code for the payment.

Has to be 3 letters.

Possible value: inr

Supported characters:
  • a-z
transacted_atinteger Unix timestamp when the payment was made.

Example: 1640179951
bank_reference_numberstringReference number returned by the bank for the payment.

Example: 115119578783
statusstringStatus of the payment.

Possible values:
  • pending: A debit request has been created by us, but no payment has been made against the request as yet.
  • success: A payment has been successfully made against the debit request.
  • failed: We failed to receive a payment against the debit request. This could be because of multiple reasons such as the request timing out. or network issues.
remitter_bank_account_numberstringThe account number from which money is received.

Example: XXXXXX1111
remitter_bank_ifsc_codestringThe account IFSC from which money is received.

Example: HDFC0000123
remitter_full_namestringThe account holder's name from who money is received.

Example: Anil Reddy
remitter_notestringNotes entered by the remitter while making the payment.

Example: Lego Death Star
remitter_vpa_handlestringThe payee VPA handle.

Example: anil-reddy@example
paid_modestringPayment mode used to complete the payment.

Possible value: upi
paid_tostringVPA handle to which the amount is credited.

This is the VPA handle linked to the account where the money is credited. It always starts with zwch.

Example: zwch2016214817@yesbank
transaction_reference_idstringUnique Transaction Reference (UTR) number received from the bank for the payment.

Example: 088b6190eb7644e6b322b95ee4819e3e
remarkstringThe remark you want to show against the payment request.

  • Only alphabets and numbers are allowed.
  • Minimum: 1 character.
  • Maximum: 50 characters.

Example: Lego Death Star.
merchant_reference_idstringUnique identifier entered while creating the payment.

Example: 1409614085
expiry_in_minutesintegerTime in minutes after which the collect request expires.

Example: 10
mandate_idstringUnique identifier of the mandate for which the payment was made.

This is null for UPI collect requests.
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.”
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
linkstringUPI intent payment link. Show this link to the payer.

Clicking this link opens a list of UPI apps installed on the device. The payer can select their desired UPI app to complete the payment.

Example: upi://pay?pa=zwtc810212912@yesbank&pn=xyz&tr=tx_eHuSnX1GtF82Z1djxSN2We4j0&tn=gourav&am=1&cu=INR&mc=xyzw
created_atinteger Unix timestamp when the payment request was received by ZWITCH.

Example: 1640179951