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.
Parameters | Type | Description |
---|---|---|
id | string | Unique identifier of the payment in the ZWITCH database. Example: tx_gwnCHducEmh57rrKUi0EOXhAK Supported characters:
|
object | string | API object that is returned. Possible value: payment |
account_id | string | Unique identifier of the account to which money is credited. Example: va_Y6evcApKFXhQ9X7qKQ5AaysEI Supported characters:
|
amount | float | The amount received for this payment. Example: 3.69 Supported characters:
|
currency | string | 3-letter ISO currency code for the payment. Has to be 3 letters. Possible value: inr Supported characters:
|
transacted_at | integer | Unix timestamp when the payment was made. Example: 1640179951 |
bank_reference_number | string | Reference number returned by the bank for the payment. Example: 115119578783 |
status | string | Status of the payment. Possible values:
|
remitter_bank_account_number | string | The account number from which money is received. Example: XXXXXX1111 |
remitter_bank_ifsc_code | string | The account IFSC from which money is received. Example: HDFC0000123 |
remitter_full_name | string | The account holder's name from whom money is received. Example: Anil Reddy |
remitter_note | string | Notes entered by the remitter while making the payment. Example: Lego Death Star |
remitter_vpa_handle | string | The payee VPA handle. Example: anil-reddy@example |
paid_mode | string | Payment mode used to complete the payment. Possible value: upi |
paid_to | string | VPA 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_id | string | Unique Transaction Reference (UTR) number received from the bank for the payment. Example: 088b6190eb7644e6b322b95ee4819e3e |
remark | string | The remark you want to show against the payment request.
Example: Lego Death Star. |
merchant_reference_id | string | Unique identifier entered while creating the payment. Example: 1409614085 |
expiry_in_minutes | integer | Time in minutes after which the collect request expires. Example: 10 |
mandate_id | string | Unique identifier of the mandate for which the payment was made. This is null for UPI collect requests. |
metadata | object | An object of a key-value pair that can be used to store additional information about the entity.
"key_1": "We are using Zwitch.” |
is_sandbox | boolean | The mode in which the API was triggered. Possible values:
|
link | string | UPI 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 Note: This link is valid for 30 days from the date of creation. |
created_at | integer | Unix timestamp when the payment request was received by ZWITCH. Example: 1640179951 |