A refund makes it possible to return a payment to the customer. The payment is always returned using the original payment method.
Refunds are divided into two types.
full refund – the whole payment is returned
partial refund – part of the payment is returned
💡 GoPay tip:
A payment refund has to be authorised using a token. The token for a payment refund has to be created in scope=payment-all. You will find more information about the process of obtaining a token in the article describing the payment gateway integration procedure.
Full refund
A full refund is carried out by an API request.
The only parameter of the call is amount, which specifies the amount you want to return to the customer.
For a full refund, amount is set to the amount the payment was paid in.
The response to the refund is an object containing the payment id and the status of the refund.
Once the refund has been carried out, the payment moves to the state REFUNDED, which we report via an HTTP notification. You will find more about notifications in the article describing the payment gateway integration procedure.
💡 GoPay tip:
The amount parameter is passed as a whole number in hellers and can never contain a value greater than the amount the payment was paid in.
Partial refund
A partial refund is carried out using the same API request as a full refund.
The only difference is in the setting of the amount parameter. In the amount parameter you pass the value corresponding to the part of the payment you want to return.
The response to the refund is an object containing the id of the payment refunded and the status of the refund.
Once the refund has been carried out, the payment moves to the state PARTIALLY_REFUNDED, which we report via an HTTP notification.
💡A partial refund cannot be carried out in the test environment for the payment card payment method. Partial refunds can only be tested in the test environment for bank transfers.
Refunds by payment method
For online banking buttons, partial and full refunds can only be carried out 24 hours after the payment is paid.
For payment cards, a full refund can be carried out immediately after the payment is paid, but a partial one only after 24 hours have elapsed.