Body
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 - ONLINE and OFFLINE. ONLINE refunds get credited to remitter account instantly, whereas OFFLINE refunds take around 3-5 working days.
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.
Note
This is an idempotent api.
Use --header x-api-version: 3 to get gatewayRefundTransactionId and merchantRequestId in response.
Request
Response
API Endpoints
Production Link
POST
{{host}}/api/n2/merchants/transactions/refund360
Basic Params
originalupiRequestId
String
Optional
UPI request id for the original transaction against which refund is being initiated.
Constraints: Max 35 characters alphanumeric.
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.
Constraints: OFFLINE, ONLINE,UDIR
refundAmount
*
String
Mandatory
The amount to be refunded
Constraints:String with mandatory two decimals
merchantRefundVpa
String
Conditional
Merchant refund vpa that is to be used for online refund.
Constraint: mandatory for refundType = ONLINE
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.
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.
Formate: YYYY-MM-DDTHH:MM:SS+05:30
iat
String
Optional
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
Optional
Reason Code for complaint sent to NPCI.
refundUpiRequestId
String
Optional
Upi request Id used for refund transaction.
Constraints: Max 35 characters alphanumeric.
200 : Success
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
merchantChannelId
*
String
Mandatory
Unique id for the merchant channel.
Values:As passed in request headers.
gatewayResponseStatus
*
String
Mandatory
Response status returned by gateway for the refund.
Values:String (SUCCESS, PENDING, DEEMED, FAILURE).
merchantId
*
String
Mandatory
Unique id for the merchant.
Values:As passed in request headers.
gatewayRefundReferenceId
String
Optional
Reference id returned by the gateway for the refund.
gatewayResponseMessage
*
String
Mandatory
Response message for code returned by gateway for the refund.
OriginalMerchantRequestId
*
String
Mandatory
Merchant generated id for the original transaction.
gatewayResponseCode
*
String
Mandatory
Response 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.
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.
transactionAmount
String
optional
The total amount for which original transaction was performed.
Values:String with mandatory two decimals.
refundTimestamp
*
String
Mandatory
Timestamp of when refund request was initiated.
Formate: String (YYYY-MM-DDTHH:MM:SS+05:30).
refundType
*
String
Mandatory
Type of refund being initiated.
Values:As passed in the request body.
merchantRefundVpa
json String
optional
Merchant refund vpa that is to be used for online refund
Values: mandatory for refundType = ONLINE
partnersSplit
String
Conditional
List of partners for which the split needs to be divided with the value.
partnerId
*
String
Mandatory
The LSP id provided by the bank.
value
*
String
Mandatory
Split share for LSP account. Decimal Value.
splitType
*
String
Mandatory
The type of split for this transaction. Can be AMOUNT, PERCENTAGE, DEFAULT, LATER.
merchantSplit
String
Optional
Split share for merchant pool account.
riskScore
String
Optional
RiskScore shared by NPCI or Bank
gatewayRefundTransactionId
String
Optional
UpiRequestId for the refund
Example:- Values: As passed in the request body in refundUpiRequestId.
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.
remarks
String
Optional
Remarks or reason as sent in the request.
Values:As passed in the request body
crn
String
Optional
Complaint reference number returned by NPCI.
Values:14 to 16 characters alphanumeric.
adjFlag
String
Optional
Reason flag for complaint sent to NPCI.
adjCode
String
Optional
Reason Code for complaint sent to NPCI.
adjAmount
String
Optional
Amount of the transaction sent to NPCI.
Values:Amount in two decimals.
reqAdjFlag
String
Optional
Reason flag for complaint sent by NPCI
reqAdjCode
String
Optional
Reason Code for complaint sent by NPCI
udfParameters
stringified JSON
optional
Merchant Defined Parameters
Example: "{\"udf1\":\"value1\",\"udf2\":\"value2\",…}"