post https://api-approval.tingg.africa/v3/checkout-api/refund/request
This function allows a merchant to refund payments that were already acknowledged as received and processed successfully
Live Endpoint
Key | Value Type | Required | Description |
---|---|---|---|
currency_code | String | No | 3 letter currency code for the transaction |
merchant_transaction_id | String | Yes | Unique transaction ID identifying the transaction as given by the merchant. |
refund_type | String | Yes | A flag indicating the type of refund to be done; can either be Full or Partial . |
amount | Double | Yes | Amount to be refunded. Compulsory for partial |
refund_narration | String | Yes | A reason for the refund. |
refund_reference | String | Yes | Reference number for the transaction. |
service_code | String | Yes | The merchant's service code. |
payment_id | String | Yes | Unique payment reference on the Cellulant Payment Gateway |
Response Status Codes
Status Code | Description |
---|---|
200 | Success. Checkout request successfully logged in the checkout platform. |
500 | Failure. Generic failure occurred. Could be as a result of a system failure on the checkout platform. |
1001 | No request found. |
1007 | Missing country code. The checkout request posted was missing a country_code |
1013 | Not JSON. The checkout request posted was not valid JSON |
1014 | Missing merchant transaction id. The request did not have a merchant_transaction_id |
1015 | Missing checkout request id.The request did not have a checkout_request_id |
1017 | Invalid charge msisdn provided. The charge_msisdn provided was not valid in the country provided |
1027 | Invalid amount provided. The charge_amount should be between the minimum and maximum amounts provided for the payment option. |