Refund API

Refund Webhook Reference

Limited Preview - Right now Refund API is on invite only basis, Click here to join the waiting list

Introduction

Paysharp is providing refund webhooks, Refund webhooks fires after processing the refund, the webhook refund status will either be success or failure. You can configure refund webhooks from the merchant dashboard and start receiving refund webhooks.

Refund Webhook

Our system will call your webhook URL and post the refund status after processing the refund. In case your webhook does not respond, our system marks the call as failed.

Your webhook should respond in JSON format with

content-type: application/json

Request

Parameters	Datatype	Description
orderId	string	Returns the order Id of the original UPI transaction.
customerId	string	Returns the customer Id for the order.
paysharpReferenceNo	string	Reference number for the original UPI transaction.
refundPaysharpReferenceNo	string	Reference number for the refund transaction.
refundType	string	refundType represents any one of the following : PARTIAL - Partial refund FULL - Full refund
refundAmount	number	Amount refunded to the customer for the order.
fee	number	Fee for the refund transaction.
tax	number	Tax for the refund transaction.
totalFee	number	Sum of fee and tax.
refundUtrNumber	string	Unique transaction number provided by Bank for the refund transaction.
refundDate	datetime	Refund date in ISO 8601 format.
mode	string	Always returns as “UPI”.
status	string	status represents any one of the following : SUCCESS - For successful refund case FAILURE - In case refund failed
attemptCount	number	Number of times the webhook invoked.
source	string	source represents any one of the following : REFUND_UI - Refund initiated using web dashboard UI REFUND_BULK - Refund initiated using dashboard bulk refunds

Example

{

"orderId" : "202001051004",

"customerId" : "C_1112",

"paysharpReferenceNo" : "upi_dedc619auJz3YB096Se7Zh",

"refundPaysharpReferenceNo" : "STLMNP189b392bl9VMW3uC4a8eNW",

"refundType" : "PARTIAL",

"refundAmount" : 200,

"fee" : 5,

"tax" : 0.90,

"totalFee" : 5.90,

"refundUtrNumber" : "228200422398",

"refundDate" : "2025-02-20T11:25:51+05:30",

"mode" : "UPI",

"status" : "SUCCESS",

"attemptCount" : 1,

"source" : "REFUND_UI"

}

Expected Acknowledgement from merchant webhook

Response status

Http Status: 200

Response Body

{

"code" : 200,

"message" : "success"

}