Overview of the payment object.

Shown below is a sample payment object.

  "id": "tx_mb8uewBpmBio1GDPbYgPn15cO",
  "object": "payment",
  "type": "funding",
  "account_id": "va_d6tSjecrvZDNEGwhmXZ2nOOGg",
  "vpa_verification_id": "accver_wjqJy3qqUVVoj9gA1aYdfvZ8G",
  "funding_account_id": "sa_sbmAPCCHdJ41ggx5UPwv0n0a2YVe",
  "amount": 1,
  "currency": "inr",
  "transacted_at": null,
  "bank_reference_number": "115119578783",
  "status": "pending",
  "remitter_bank_account_number": null,
  "remitter_bank_ifsc_code": null,
  "remitter_full_name": null,
  "remitter_note": null,
  "remitter_vpa_handle": "anil.reddy@examplebank",
  "paid_mode": "upi",
  "paid_to": "zwch1761300234@icici",
  "transaction_reference_id": null,
  "remark": "first fund",
  "merchant_reference_id": "1234565656",
  "expiry_in_minutes": 10,
  "mandate_id": null,
  "metadata": {
    "key_1": "DD",
    "key_2": "XOF"
  "is_sandbox": true,
  "link": null,
  "created_at": 1667821016

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

idstringUnique identifier of the payment in the ZWITCH database.

Has to be 28 characters.

Example: tx_mb8uewBpmBio1GDPbYgPn15cO

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

Possible value: payment
typestringThe type of payments you want to receive.

Possible value: funding
account_idstringUnique identifier of your receivable funding account.

Money is credited to your receivable account. You need to transfer money from the receivable account to the account being funded.

Has to be 28 characters.

Example: va_d6tSjecrvZDNEGwhmXS2nOOGg

Supported characters:
  • A-Z
  • a-z
  • 0-9
  • _
vpa_verification_idstringUnique identifier obtained when verifying the applicant's UPI ID.

Example: accver_wjqJy3qqUVVoj9gA1aYdfvZ8G
funding_account_idstringUnique identifier of the account you want to fund in the ZWITCH database.

Example: sa_sbmAPCCHdJ41ggx5UPwv0n0a2YVe
amountfloatFunding amount.

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 received against the request as yet.
  • success: A payment has been successfully made against the first funding request.
  • failed: We failed to receive a payment against the first funding 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

Note: The remitter's name should match the name on the account being funded.
remitter_notestringNotes entered by the remitter while making the payment.

This is null for UPI collect requests.
remitter_vpa_handlestringThe applicants VPA handle.

Example: anil.reddy@ybl
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.

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

Example: HDFCA00001000000
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
linkstring Always null for first funding transfers.
created_atinteger Unix timestamp when the payment request was received by ZWITCH.

Example: 1640179951