UPI Setu - Refunds and disputes - Create refund API

Reading time — 1 minutes

#Create refund

The merchant will have to call the create refund API with the correct set of parameters.

Staging host	`https://umap.setu.co/api`
Method	`POST`
Path	`/v1/merchants/refunds`
Header	`merchantId` `Authorization`: Bearer <insert_token_here>. Generate this token using OAuth. `Content-Type`—will be `application/json`

#Sample request

{
    "amount": 10000,
    "currency": "INR",
    "merchantReferenceId": "BILL12345",
    "paymentId": "01HKSEWQ509Z56CVQNQ2XHGJZ1",
    "remarks": "Services not rendered",
    "type": "online"
}

#Sample response

{
  "amount": 10000,
  "createdAt": "2023-09-04T12:08:20+0530",
  "currency": "INR",
  "id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
  "merchantReferenceId": "BILL12345",
  "paymentId": "01HKSEWQ509Z56CVQNQ2XHGJZ1",
  "remarks": "Services not rendered",
  "status": "success",
  "type": "online"
}

In the above response—

id is a unique refund ID that is associated with this refund and can be used to track it later.

To know more about all the API params, please refer to the API documentation here.

UPI Setu coordinates with NPCI to process the refund, ensuring the amount is returned to the customer's account.

Throughout the refund process, UPI Setu provides merchants with timely updates regarding the refund status, ensuring transparency and allowing merchants to keep their customers informed.

UPI Setu sends notifications to the merchants for the following events:

refund.sucess (if refund is successful)
refund.failed (if refund fails)

Read more about refund status notifications here

—

–

#Create refund

#Sample request

#Sample response