Refund a payment

POST /v2/payments/{payId}/refund

Initiates a refund for a successfully completed payment identified by payId. Applies to any supported payment method.

Request

HTTP Method: POST Endpoint:

/v2/payments/{payId}/refund

Headers:

Authorization: {tokenType} {access_token}
Content-Type: application/json

---

Path Parameters

Name	Type	Required	Description
payId	string (UUID)	Yes	Unique identifier of the recorded payment in the system.

Request Body Parameters

Name	Type	Required	Description
amount	number	Yes	The total amount to be refunded or processed, expressed in major currency units.
reason	string (max 500 chars)	Yes	Reason for initiating the refund.
callbackUrl	string	Optional	The URL where the system sends the asynchronous status notification after processing.

---

Example request

{
  "amount": 50.61,
  "reason": "Client returned the product",
  "callbackUrl": "https://www.example.com"
}

---

Response

Response Parameters

Name	Type	Description
result	object	Operation result container.
result.refundId	string (UUID)	Unique identifier of the refunded payment.
result.status	string (enum)	Final status of the payment. Possible value: Refunded.
ok	boolean	Indicates successful request execution.
errors	array	List of processing/validation errors, if any.
errors.errorCode	string	Error code.
errors.errorMessage	string	Error description.

---

Example Successful Response

{
  "result": {
    "refundId": "123e4567-e89b-12d3-a456-426614174000",
    "status": "Refunded"
  },
  "ok": true
}

---