Reverse/Refund Payment
warning
A very limited set of billers accept reversals/refunds. Most do not.
Request
POST /api/payment/reverse
| Field | Data Type | Description |
|---|---|---|
| OriginalReference | String | Vendor's original payment reference (used during AUTH and PAY) |
| Reference | String | Vendor's unique reversal reference |
Example request:
{
"OriginalReference": "PMT1234567890",
"Reference": "REV1234567890"
}
Response
| Field | Data Type | Description |
|---|---|---|
| OriginalReference | String | Vendor's original payment reference |
| Reference | String | Vendor's unique reversal reference |
| ErrorCode | Integer | 0 indicates success. Non-zero indicates failure |
| Narration | String | Populated when error code is non-zero |
| TechnicalNarration | String | Technical error description (if any) |
| BillpayReference | String | BillPay reversal reference |
| BillerReference | String | Biller's reversal reference |
Example response:
{
"OriginalReference": "PMT1234567890",
"Reference": "REV1234567890",
"ErrorCode": 0,
"Narration": "",
"TechnicalNarration": "",
"BillpayReference": "R-COH-1234567890",
"BillerReference": "1000-123456789"
}
Error Codes
| Code | Description |
|---|---|
| 0 | Reversal was successful (no error) |
| 1 | Original payment not found |
| 2 | Duplicate vendor reversal reference |
| 3 | Biller failed to reverse payment |
| 4 | Biller does not support reversals |
| 5 | Original payment is already refunded |
| 99 | General (non-specific) error |