Refund Completed Payment

POST /v2/mia/payments/{payId}/refund

This endpoint allows initiating a refund for a successfully completed payment identified by payId.

---

Request parameters (path)

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

Request parameters (body)

Name	Type	Required	Description
reason	string (max. 500 caractere)	Yes	Reason for initiating the refund.

Request example

{
    "reason": "Client returned the product"
}

---

Response parameters

Object result

Name	Type	Description
payId	string (GUID)	Unique identifier of the payment for which the refund was made.
status	string (enum)	Result status of the payment. Possible value: Refunded.

Other fields

Name	Type	Description
ok	boolean	Indicates whether the request was processed successfully.
errors	array	Contains details about any errors encountered during processing.
errors.errorCode	string	Error code.
errors.errorMessage	string	Error description.

---

Response example

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