Object

Shown below is a sample upi_refund_payments object.

{
    "id": "rtx_COCdWMCJ11BcM4MXsxK7GqiqA",
    "object": "payments",
    "type": "upi_refund_payments",
    "amount": 1,
    "currency": "inr",
    "status": "success",
    "original_bank_reference_number": "518626339179",
    "bank_reference_number": "518858496461",
    "original_npci_transaction_id": "SBI57233a2e256d485497520c73fe23e7f2",
    "remarks": "Refund 518626339179",
    "merchant_reference_id": "232333334333342333332342334",
    "paid_to": "john.doe@oksbi",
    "is_sandbox": false,
    "created_at": 1751898561
}

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

Parameters	Type	Description
id	`string`	Unique identifier of the UPI Refund in the ZWITCH database. Example: `rtx_0gXFPU5PYqorebLC4GuSfxpWX` Supported characters: `A-Z` `a-z` `0-9` `_`
object	`string`	API object that is returned. Possible value: `payments`
type	`string`	Type of refund. Accepted values: `upi_refund_payments`
amount	`float`	The amount which is refunded. Example: `1.00`
currency	`string`	3-letter iso currency code for the payment. Has to be 3 letters. Possible value: `inr` Supported characters: `a-z`
status	`string`	Status of the reversal. Possible values: `pending`: A reversal request has been created by us, but no reversal has been made against the request as yet. `success`: A reversal has been successfully made against the payment. `failed`: We failed to initiate the reversal request. This could be because of multiple reasons such as the request timing out. or network issues.
original_bank_reference_number	`string`	The UTR against the actual payment which is being refunded. Example: `SBIN23272354267`
bank_reference_number	`string`	Reference number returned by the bank for the refund. Example: `115119578783`
original_npci_transaction_id	`string`	The NPCI reference number returned by the bank for the refund Example: `SBIN23272354267`
remarks	`string`	The remark against the payment request. Currently it is not manageable by the merchant. It will return as default value in the format Refund followed by the UTR againts the refund. Example: `Refund SBIN23272354267.`
merchant_reference_id	`string`	Unique identifier entered while creating the refund request. Example: `1409614085`
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`
is_sandbox	`boolean`	The mode in which the API was triggered. Possible values: `true`: API was triggered in sandbox mode `false`: API was triggered in live mode
created_at	`integer`	Unix timestamp when the payment request was received by ZWITCH. Example: `1640179951`