Refund a total or partial amount
Available for: Cards, Blik and PayByLink
The purpose of this operation is to refund the amount of a previous payment, crediting the cardholder account and debiting the Merchant account.
A refund is performed against a previous payment, referencing its transactionID by sending a POST request over HTTPS to the /payments/{transactionID}/refund endpoint.
A refund can be performed:
- Against purchase (PURS);
- Against captured preauthorisation (AUTH -> Capture).
And it can be:
- A full refund when the total amount of the purchase is refunded to the cardholder
- A partial refund when a subtotal of the total purchase is refunded to the cardholder
Generate the transaction:
POST https://stargate-cer.qly.site1.sibs.pt/api/v1/payments/{transactionID}/refund
Here’s an example:
Request Headers:
Autorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6I (...)
X-IBM-Client-Id: b4480347-9fc8-4790-b359-100a99c60ea3
Content-Type: application/json
{
"merchant": {
"terminalId": 24,
"channel": "web",
"merchantTransactionId": "BO_Order Id: c9876bcasd"
},
"transaction": {
"transactionTimestamp": "2022-05-29T18:23:41.367Z",
"description": "This is a refund request",
"amount": {
"value": 10,
"currency": "PLN"
},
"originalTransaction": {
"id": "mvuy3dh3wucpsi4389fh",
"datetime": "2022-05-29T17:23:36.105Z"
}
}
}
}
