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

Sub Merchant Refund 360

This api can be used to trigger a refund against a successful sub-merchant transaction.

This is an idempotent api.

Request

Response

API Endpoints

Production Link

POST

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

                      Content-Type
                      
                      

string

application/json

                      x-merchant-id
                      
                      

string

Will be shared while onboarding.

                      x-merchant-channel-id
                      
                      

string

Will be shared while onboarding.

                      Accept
                      
                      

string

application/json

                      x-timestamp
                      
                      

String

This is an epoch unix timestamp string. For example, 1496918882000. It can be used by us to invalidate older requests.

                      x-merchant-signature
                      
                      

string

This is a signature over combination of headers, payload. Refer Signature Calculation section for more details.

                      x-sub-merchant-id	
                      
                      

String

Provided during on-boarding. To be passed in the apis if it needs to be invoked in sub merchant mode.

                      x-sub-merchant-channel-id	
                      
                      

String

Provided during on-boarding. To be passed in the apis if it needs to be invoked in sub merchant mode.

Body

                      originalUpiRequestId
                      *
                      

String

Mandatory

UPI request id for the original transaction against which refund is being initiated
Constraints: 35 character alphanumeric

                      originalTransactionTimestamp
                      
                      

String

Optional

Timestamp of the original transaction
Constraints: As returned in the response of original transaction api, String (YYYY-MM-DDTHH:MM:SS+05:30)

                      refundRequestId
                      *
                      

String

Mandatory

Merchant generated unique id for the refund
Constraints: 35 characters alphanumeric

                      refundAmount
                      *
                      

String

Mandatory

The amount to be refunded
Constraints: String with mandatory two decimals

                      refundType
                      *
                      

String

Mandatory

Type of refund being initiated
Constraints: OFFLINE, ONLINE

                      merchantRefundVpa
                      
                      

String

optional

Merchant refund vpa of parent merchant is to be used for online refund
Constraints: mandatory for refundType = ONLINE, vpa@handle

                      remarks
                      *
                      

String

Mandatory

Remarks or reason for the refund

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

                      udfParameters
                      
                      

JSON String

Optional

Stringified JSON for udf parameters

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

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

                      iat
                      *
                      

String

Mandatory

Timestamp to be used in JWS
Constraints: As passed in the request body

Response Body

                      status
                      *
                      

String

Mandatory

PSP status of the API
SUCCESS, FAILURE

                      responseCode
                      *
                      

String

Mandatory

PSP response code for the API
Refer error code section

                      responseMessage
                      *
                      

String

Mandatory

PSP response message for the API
Refer error code section

                      payload
                      *
                      

JSON

Mandatory

                      merchantId
                      *
                      

String

Mandatory

Unique id for the merchant
As passed in request headers

                      merchantChannelId
                      *
                      

String

Mandatory

Unique id for the merchant channel
As passed in request headers

                      refundRequestId
                      *
                      

String

Mandatory

Merchant generated unique id for the refund
As passed in the request body

                      transactionAmount
                      *
                      

String

Mandatory

The total amount for which original transaction was performed
String with mandatory two decimals

                      refundAmount
                      *
                      

String

Mandatory

The amount to be refunded
As passed in the request body

                      refundType
                      *
                      

String

Mandatory

Type of refund being initiated
As passed in the request body

                      refundTimestamp
                      *
                      

String

Mandatory

Timestamp of when refund request was initiated
String (YYYY-MM-DDTHH:MM:SS+05:30)

                      gatewayTransactionId
                      *
                      

String

Mandatory

UPI request id returned by gateway for the transaction
Same as originalUpiRequestId passed in request

                      gatewayRefundReferenceId
                      *
                      

String

Mandatory

Reference id returned by the gateway for the refund

                      gatewayResponseStatus
                      *
                      

String

Mandatory

Response status returned by gateway for the refund
String (SUCCESS, PENDING, DEEMED, FAILURE)

                      gatewayResponseCode
                      *
                      

String

Mandatory

Response code returned by gateway for the refund

                      gatewayResponseMessage
                      *
                      

String

Mandatory

Response message for code returned by gateway for the refund

                      udfParameters
                      
                      

JSON String

Optional

Udf parameters
As passed in the request body

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