Request a Payment Refund

Submits a request to refund a specific payment. The request body includes details such as the refund amount, reason, and transaction ID.

Request a Payment Refund

cURL

curl --request POST \
  --url https://qa-lynx.nayax.com/operational/v1/payment/refund-request \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "RefundAmount": 123,
  "RefundEmailList": "<string>",
  "RefundReason": "<string>",
  "TransactionId": 123,
  "SiteId": 123,
  "MachineAuTime": "2023-11-07T05:31:56Z"
}
'

200

{
  "Result": "<string>",
  "Status": "<string>"
}

Authorizations

Authorization · string · header · required

Enter your API key. It's required to authenticate API requests.

Body

application/json

RefundAmount · number<double> | null

The amount to be refunded to the customer.

RefundEmailList · string | null

A list of email addresses to notify about the refund, separated by commas.

RefundReason · string | null

The reason for requesting the refund.

TransactionId · integer<int64>

The unique identifier of the transaction for which the refund is requested.

SiteId · integer<int32>

The unique identifier of the site where the transaction occurred.

MachineAuTime · string<date-time>

The machine's authorization time associated with the transaction.

Response

200 - application/json

The refund request was successfully processed, and the response contains the result of the request.

Result · string | null

The result of the refund request, indicating success or failure.

Status · string | null

The current status of the refund request.