To make a total or partial refund of a transaction, you can use either our API or the HiPay Enterprise back office.
Please note: refunds must be made within 11 months after capture for card transactions. Conditions may differ depending on payment methods.
1. Refunding a transaction through our API
There are two endpoints (base URLs) to which you can make your API calls:
- Stage, if you are testing your integration,
- and Production, when you have finished testing and want your application to go live.
|AN||Alphanumeric characters (a-z, A-Z, 0-9)|
|N||Numeric characters only|
|R||Decimal number with explicit decimal point, signed|
To refund a transaction, you must send the following parameters in your API call.
|Field name||Format||Length||HTTP method||Description|
HiPay transaction ID to be inserted at the end of the API URL
Set the value: refund
|amount||R||-||POST||Amount you want to refund|
|operation_id||AN||-||POST||Operation merchant ID. This value will be returned to the merchant with the notifications related to this operation. It can be used, for example, if you make more than one partial refund.|
Transaction statuses sent by server-to-server notification
|124||Refund Requested||A refund request has been sent to the financial institution.|
|125||Refunded||The payment was refunded. A payment reaches the “Refunded” status when the financial institution has processed the refund and the amount has been transferred to the customer’s account. The amount will be deducted from the next total amount to be paid out to the merchant.|
|126||Partially Refunded||The payment was partially refunded.|
|165||Refund Refused||The refund operation was refused by the financial institution.|
2. Refunding a transaction in our back office
In the HiPay Enterprise back office, search for the captured transaction you want to refund.
From the Transaction Preview, click on , then choose if you want to make a full or partial refund (for partial refunds, specify the amount) and click on .