Refund Status

This callback is given when the merchant initiates a refund and when the same gets success/failure.

Note: Merchant can get multiple callbacks for the same event type till the refund status reaches a terminal state. Terminal states for a refund are SUCCESS and FAILURE.

Scroll inside to view more
Parameter
Description
customResponse
Stringified JSON parameter for future use.
gatewayRefundReferenceId
Reference id returned by the gateway for the refund
gatewayResponseCode
Response code returned by gateway for the refund.
gatewayResponseStatus
Response status returned by gateway for the refund.
gatewayResponseMessage
Response message for code returned by gateway for the refund
gatewayTransactionId
UPI request id returned by gateway for the transaction
merchantChannelId
Unique id for the merchant channel as passed in request headers
merchantId
Unique id for the merchant as passed in request headers
merchantRefundReason
Reason for the refund.
merchantRefundVpa
VPA of the merchant from which refund was initiated
merchantRequestId
Request id used for the original transaction.
refundAmount
The amount to be refunded.
refundRequestId
Merchant generated unique id for the refund as passed in the request body
refundType
Type of refund being initiated as passed in the request body
refundTimestamp
Timestamp of when refund request was initiated
refundGatewayReferenceId
RRN for the refund.
refundMerchantRequestId
Request id for refund request.
transactionAmount
The amount for which original transaction was performed.
type
CUSTOMER_OFFLINE_REFUND / CUSTOMER_ONLINE_REFUND
udfParameters
udfParameters sent for the original refund request