Request Refunds
The refund process begins by submitting a request with details such as the refund amount and reason. This notifies the customer that the refund is being processed. We will describe this process in more detail on this page.
Credit Cards Only
Refunds can only be requested for transaction done through Credit Card. This option is not available for prepaid cards.
In Nayax Core, refunds can be requested through the Dynamic Transactions Monitor. Follow the steps below to do so.
-
Access Reports > Online Reports > Dynamic Transactions Monitor.
-
Search for the transaction to refund. You can use the filter feature to make this easier.
-
Right-click the transaction you want to refund.
-
Click Request Refund
-
A pop-up window will appear. In it, choose if the refund is complete or partial and write the reason for the refund.
-
Click Request Refund.
Lynx API
This process can be performed programmatically through the Lynx API. The following endpoint is used to process the refund.
Authentication
Refer to the Security & Token page of this documentation to learn how to access your tokens and how to properly use them to authenticate your API requests.
Initiating the request
To start the request, use the Request a Payment Refund endpoint to request a refund. Providing the attributes regarding the rebate in the body parameters of the request, as exemplified below:
curl --request POST \
--url https://qa-lynx.nayax.com/operational/v1/payment/refund-request \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data '
{
"RefundAmount": 0,
"RefundEmailList": "string",
"RefundReason": "string",
"TransactionId": 0,
"SiteId": 0,
"MachineAuTime": "2024-10-10T16:30:37.179Z"
}
'
Below, you can see a description of each of the parameters:
Name | Type | Description |
---|---|---|
RefundAmount | 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 | int64 | The unique identifier of the transaction for which the refund is requested. |
SiteId | int32 | The unique identifier of the site where the transaction occurred. |
MachineAuTime | date-time | The machine's authorization time is associated with the transaction. |
How to obtain TransactionID and SiteID
The TransactionId
and SiteId
can be retrieved in the Lynx API using the Get Last Sales for Machine endpoint to retrieve the last sales using the MachineID
and the response object should have the necessary data.
Request Status
Once you send the request, a notification email will be sent to the email address entered in the request parameters.
The refund is now in the pending
status and will need to be approved or declined. See Approve or Decline a Refund for more details.
Updated 5 months ago