JavaScript is disabled. Some features may not work. You can also read the static version: View text version

Merchant Refund 360

This api can be used to trigger a refund against a successful complaint resolve and if the transaction is successful. There are two types of refunds supported - UDIR and OFFLINE.

Refund360 will be used for initiating a new refund or getting the status of an existing refund. If the "refundRequestId" is present with the PSP, then the latest status of the existing refund will be returned. If not present, then a new refund will be triggered.

OFFLINE refunds take around 2-3 working days to get processed.

UDIR refunds get credited to remitter account instantly. Merchant is required to pass the adjCode and adjFlag in the request. Below are mentioned the adjCode and adjFlag for merchant’s reference.

adjCode and adjFlag from NPCI not mentioned below shall be treated as Pending

UDIR refund to be initiated 5 minutes post successful transaction only, prior initiations can lead to errors.

Gateway Response codes wrt Online Refunds:

Scroll inside to view more

gatewayResponseCode	gatewayResponseStatus	Description
00	SUCCESS	Refund accepted successfully
01	PENDING	Refund is in pending state
RB	DEEMED	Refund is in deemed state
BT	DEEMED	Refund is in deemed state
Else	FAILURE	Refund failed

Gateway Response codes wrt UDIR Refunds:

Scroll inside to view more

gatewayResponseCode	gatewayResponseStatus	Description
00	SUCCESS	Refund accepted successfully
01	PENDING	Refund is in pending state
JPREFD	DEEMED	Refund is in deemed state
Else	FAILURE	Refund failed

Reason codes and flag for Refund From Beneficiary:

Scroll inside to view more

AdjFlag	AdjCode	Description
REF	1064	Goods or Services Not Provided
REF	1084	Duplicate /Multiple Transaction
REF	1063	Customer paid by alternate means
REF	1061	Credit not processed for cancelled or returned goods and services.

Reason codes and flags for Refund From NPCI:

Scroll inside to view more

AdjFlag	AdjCode	Description
RRC	501	Success
RRC	502	Deemed
RUU	UT1, UT2, UT3, UT4, UT5, UT6, UT7	Deemed

Request

Response

API Endpoints

Production Link

POST

{{host}}/api/{{uri}}/merchants/transactions/refund360

Body

                      originalMerchantRequestId
                      *
                      

String

Mandatory

merchantRequestId of the original transaction against which refund is being initiated.

                      refundRequestId
                      *
                      

String

Mandatory

Merchant generated unique id for the refund.

Constraints: Max 35 characters alphanumeric, can also contain hyphen(-), dot(.) & underscore(_)

                      refundType
                      *
                      

String

mandatory

Type of refund being initiated.

Value: UDIR, ONLINE, OFFLINE

                      refundAmount
                      *
                      

String

Mandatory

The amount to be refunded.

Constraints: String with mandatory two decimals and should be less than or equal to original txn amount.

                      merchantRefundVpa
                      
                      

String

Conditional

Merchant refund vpa that is to be used for online refund.

                      remarks
                      *
                      

String

Mandatory

Remarks or reason for the refund.

Constraints: The transaction note must be alphanumeric, with a minimum length of 1 character and a maximum length of 50 characters.

                      refundUpiRequestId
                      
                      

String

Optional

Upi request Id used for refund transaction.

Constraints: Max 35 characters alphanumeric.

                      originalTransactionTimestamp
                      
                      

String

Optional

Timestamp of the original transaction. Passing this parameter will help PSP to optimize the refund request to reduce the latency of this api.

Format: YYYY-MM-DDTHH:MM:SS+05:30

                      iat
                      *
                      

String

Mandatory

Current Epoch Unix timestamp string. Has to be of 13 digit in Milliseconds.

Example: 1496918882000.

                      udfParamters
                      
                      

Stringified JSON

Optional

Merchant Defined Parameters

Example: "{\"udf1\":\"value1\",\"udf2\":\"value2\",…}"

Note: Few special characters are not allowed. Regex for the characters which are not allowed : ^[^/#-()*!%~`]+$

                      adjCode
                      
                      

String

Conditional

To be passed in case of UDIR refunds.

Value: {1064, 1084, 1063, 1061}

Description for the same are mentioned above in the Reason codes and flag for Udir Refund From Beneficiary Table.

                      adjFlag
                      
                      

String

Conditional

To be passed in case of UDIR refunds.

Value: REF

Description for the same are mentioned above in the Reason codes and flag for Udir Refund From Beneficiary Table.

Response Body

                      status
                      *
                      

String

Mandatory

PSP status of the API.

Values: SUCCESS | FAILURE.

                      responseCode
                      *
                      

String

Mandatory

PSP response code for the API.

Values: Refer Codes Guide in Resource Section.

                      responseMessage
                      *
                      

String

Mandatory

PSP response message for the API.

Values: Refer Codes Guide in Resource Section.

                      payload
                      *
                      

Json

Mandatory

                      merchantId
                      *
                      

String

Mandatory

Unique id for the merchant.

Values: As passed in request headers.

                      merchantChannelId
                      *
                      

String

Mandatory

Unique id for the merchant channel.

Values: As passed in request headers.

                      gatewayResponseCode
                      *
                      

String

Mandatory

Response code returned by gateway for the refund.

                      gatewayResponseStatus
                      *
                      

String

Mandatory

Response status returned by gateway for the refund.

Values: String (SUCCESS, PENDING, DEEMED, FAILURE).

                      gatewayResponseMessage
                      *
                      

String

Mandatory

Response message for code returned by gateway for the refund.

                      gatewayTransactionId
                      *
                      

String

Mandatory

UPI request id returned by gateway for the transaction.

Values: Same as originalUpiRequestId passed in request.

                      gatewayRefundReferenceId
                      *
                      

String

Mandatory

Reference ID returned by the gateway for the refund (RRN).

                      refundAmount
                      *
                      

String

Mandatory

The amount to be refunded.

Values: As passed in the request body.

                      refundRequestId
                      *
                      

String

Mandatory

Merchant generated unique id for the refund.

Values: As passed in the request body.

                      originalMerchantRequestId
                      
                      

String

Optional

merchant request id of original transaction.

                      gatewayRefundTransactionId
                      *
                      

String

Mandatory

UpiRequestId for the refund.

                      refundTimestamp
                      *
                      

String

Mandatory

Timestamp of when refund request was initiated.

Format: String (YYYY-MM-DDTHH:MM:SS+05:30).

                      refundType
                      *
                      

String

Mandatory

Type of refund being initiated.

Value: UDIR, ONLINE, OFFLINE

                      riskScore
                      
                      

String

Optional

RiskScore shared by NPCI or Bank.

                      remarks
                      
                      

String

Optional

Remarks or reason as sent in the request.

                      subMerchantId
                      
                      

String

Optional

Unique id for subMerchant. Only if present as a subMerchant.

                      subMerchantChannelId
                      
                      

String

Optional

Unique id for the channel via which request is made. Only if present as a subMerchant.

                      adjFlag
                      
                      

String

Conditional

Reason Flag received in response from NPCI.

                      adjCode
                      
                      

String

Conditional

Reason Code received in response from NPCI.

                      reqAdjFlag
                      
                      

String

Conditional

Reason flag for refund raised to NPCI.

                      reqAdjCode
                      
                      

String

Conditional

Reason Code received from Merchant and sent to NPCI for refund.

crn

String

Conditional

Complaint reference number returned by NPCI.
Values:14 to 16 characters alphanumeric.

                      merchantRefundVpa
                      
                      

String

Optional

RefundVPA used for refund

                      udfParameters
                      
                      

stringified JSON

optional

Merchant Defined Parameters

Example: "{\"udf1\":\"value1\",\"udf2\":\"value2\",…}"

Have questions?
Need help? Contact support
LLM? Read llms.txt