Reverse a Payment

You can reverse a payment using this API if the payment rail supports the reversal of payments.


PUT /payments/{paymentUID}/reverse

HTTP Method: PUT

Description - Sending a PUT request to "/payments/{paymentUID}/reverse" endpoint allows users to reverse a payment. All the request parameters and objects are specified below

Request Parameters

Name In Type Required Description
paymentUID path string true Payment unique identifier
ReversePaymentRequest body ReversePaymentRequest false Reverse payment response

ReversePaymentRequest

Copy
Copied
{
  "reversalNotes": "" 
}
Name In Type Required Description
reversalNotes request string false Reversal notes

JSON Response

Success Code - 200

Copy
Copied
{
  "status": "Success or Failure",
  "code": "PAYMENT003 etc.",
  "message": "Failed to reverse a payment: ",
  "data": {
    "paymentUID": "string",
	"status": "string"
  }
}
Name Type Required Restrictions Description
status string false none Status of the API request either it will be a success or a failure
code string false none Code associated with the error.
message string false none Error message corresponding to the error code indicating the issue in API call and an indication on how to resolve it.
data ReversePaymentResponse_data false none Reverse Payment Response Data

ReversePaymentResponse_data

Copy
Copied
{
  "paymentUID": "string",
  "status": "string"
}
Name Type Description
paymentUID string Payment unique preference ID
status string Payment response status