POSTInitiate Refund

Refund a failed transaction to the customer after OTP consent.

POST/customer/payment/refund/{tid}

Refunds the e-value for a failed transaction back to your account, acting as consent that you have returned the cash to the customer. Requires the OTP (and otp_ref_id) from Get Refund OTP. Returns the financial response envelope with the refund transaction id and reversed amounts.

Request

Path parameters

Field	Type	Required	Description
`tid`	string	required	Transaction ID from the Initiate Transaction call.e.g. 13192443

tidstringRequired

Transaction ID from the Initiate Transaction call.

example: 13192443

Body parameters

Field	Type	Required	Description
`initiator_id`	string	required	Registered mobile number of the API user (see Platform Credentials).e.g. 9962981729
`otp`	integer	required	OTP sent to the customer's mobile number.e.g. 123456
`otp_ref_id`	string	optional	otp_ref_id received from Get Refund OTP.e.g. zCISyglexo0Pjqp4YrS2ssweuD9v1c3aLKGxjTW8wU7An8Wem1UyNws5830yh7q/sf5J4R3BY=
`service_code`	integer	optional	Fixed service code. For PayPoint send 80.e.g. 80
`state`	integer	optional	Fixed value. Send 1.e.g. 1

initiator_idstringRequired

Registered mobile number of the API user (see Platform Credentials).

example: 9962981729

otpintegerRequired

OTP sent to the customer's mobile number.

example: 123456

otp_ref_idstringoptional

otp_ref_id received from Get Refund OTP.

example: zCISyglexo0Pjqp4YrS2ssweuD9v1c3aLKGxjTW8wU7An8Wem1UyNws5830yh7q/sf5J4R3BY=

service_codeintegeroptional

Fixed service code. For PayPoint send 80.

example: 80

stateintegeroptional

Fixed value. Send 1.

example: 1

These headers authenticate and sign every request. See How Auth Works for details.

Field	Type	Required	Description
`developer_key`	string	required	Static API key issued to your account after KYC.
`secret-key`	string	required	Dynamic per-request signature: base64(HMAC-SHA256(timestamp, base64(access_key))).
`secret-key-timestamp`	string	required	Current time in milliseconds since UNIX epoch, used to compute secret-key. Must match server time.
`content-type`	string	required	application/jsone.g. application/json

developer_keystringRequired

Static API key issued to your account after KYC.

secret-keystringRequired

Dynamic per-request signature: base64(HMAC-SHA256(timestamp, base64(access_key))).

secret-key-timestampstringRequired

Current time in milliseconds since UNIX epoch, used to compute secret-key. Must match server time.

content-typestringRequired

application/json

example: application/json

Responses

statusnumber
Primary success indicator (0 = success).
messagestring
Human-readable response / error message.
response_status_idnumber
Granular status id; see the shared error-codes table.
response_type_idnumber
A unique id for every possible response shape (success or error) — useful for client logic branching and analytics.
tx_statusstring
Transaction state: 0=Success, 1=Fail, 2=Awaited, 3=Refund Pending, 4=Refunded, 5=On Hold.
txstatus_descstring
Human-readable transaction status.
dataobject
API-specific response payload.
- refund_tidstring
  Transaction ID of the refund.
- refunded_amountstring
  Total amount refunded (INR).
- amountstring
  Original transaction amount (INR).
- feestring
  Fee reversed (INR).
- balancestring
  Account balance after the refund (INR).
- tidstring
  Original transaction ID.

POSTInitiate Refund

Request

Path parameters

Body parameters

Responses

Next steps

Related