Payment Refund (Refund)
11.2 Payment Return (Refund)
Definition
The refund process provides a refund of a certain amount or all of a completed (captured) payment.
Endpoint: POST /b2c/payment/refund
Header
| Area | Type | Mandatory | Description |
|---|---|---|---|
| Authorization | string | ✔ | Bearer {AccessToken} |
Request Body
| Area | Type | Mandatory | Description |
|---|---|---|---|
| referenceCode | string | ✔ | Merchant reference code for the transaction |
| amount | decimal | ✔ | Amount to be refunded |
| reason | string | ✔ | Reason for return |
Request Example
{
"referenceCode": "8893cec8-51df-40bc-b7e3-cc06fd1a48b6",
"amount": 1,
"reason": "partial_refund"
}
Response
| Area | Type | Description |
|---|---|---|
| success | boolean | Transaction result |
| error | string | Error message |
| lastAmount | decimal | Remaining amount after refund |
Response Example
{
"error": null,
"success": true,
"lastAmount": 0.00
}