Login

Initiate Refunds

Log in to see full request history

This function allows a merchant to refund payments that were already acknowledged as received and processed successfully

📘

Live Endpoint

https://api.tingg.africa/v3/checkout-api/refund/request

KeyValue TypeRequiredDescription
currency_codeStringNo3 letter currency code for the transaction
merchant_transaction_idStringYesUnique transaction ID identifying the transaction as given by the merchant.
refund_typeStringYesA flag indicating the type of refund to be done; can either be Full or Partial.
amountDoubleYesAmount to be refunded. Compulsory for partial
refund_narrationStringYesA reason for the refund.
refund_referenceStringYesReference number for the transaction.
service_codeStringYesThe merchant's service code.
payment_idStringYesUnique payment reference on the Cellulant Payment Gateway

Response Status Codes

Status CodeDescription
200Success. Checkout request successfully logged in the checkout platform.
500Failure. Generic failure occurred. Could be as a result of a system failure on the checkout platform.
1001No request found.
1007Missing country code. The checkout request posted was missing a country_code
1013Not JSON. The checkout request posted was not valid JSON
1014Missing merchant transaction id. The request did not have a merchant_transaction_id
1015Missing checkout request id.The request did not have a checkout_request_id
1017Invalid charge msisdn provided. The charge_msisdn provided was not valid in the country provided
1027Invalid amount provided. The charge_amount should be between the minimum and maximum amounts provided for the payment option.
Body Params
string
required
Defaults to KES
string
required
Defaults to 78JY58HTBB
string
required
Defaults to PARTIAL
string
required
Defaults to 100
string
required
Defaults to User refunded from portal
string
required
Defaults to PRF0018
string
required
Defaults to JOHNDOEONLINESERVICE
string
required
Defaults to 183
Headers
string
required
Defaults to your_api_key
string
required
Defaults to Access Token
Responses

Language
Click Try It! to start a request and see the response here! Or choose an example:
application/json