This endpoint allows the merchant to simulate a payment after performing a charge request, updating the request status to “Pending cknowledgement”. This is sent as a JSON POST request.
Sandbox Endpoint:https://api-approval.tingg.africa/v3/checkout-api/simulation/request
Request Parameters
| Key | Value Type | Required | Description |
|---|---|---|---|
customer_name | String | Yes | Customer name/s. |
msisdn | String | Yes | Mobile number for the customer. |
account_number | String | Yes | Account number for the customer on the merchant system. This is the reference the customer will pay to. (Has a limit of 15 characters) |
country_code | String | No | 3 digit ISO code of the country you wish to collect payment for |
currency_code | String | Yes | 3 digit ISO code of the currency the merchant is invoicing for. |
client_code | String | No | Payment option code of the payment options the merchant wishes to collect for |
merchant_transaction_id | String | Yes | Unique Id the merchant raised for the request (Has a limit of 100 characters) |
amount | Double | Yes | Amount you wish to start collecting for. |
narration | String | Yes | Shows the description of the item being purchased. (Has a limit of 255 characters) |
service_code | String | Yes | The service code assigned to the merchant on the tingg portal |
payment_mode | String | Yes | Static value of "mobile" |
{
"msisdn": "254700000000",
"amount": 1000,
"client_code": "SAFKE",
"country_code": "KEN",
"service_code": "MULACHECKOUTONLINE",
"customer_name": "Alex Kintuhia",
"currency_code": "KES",
"account_number": "dNSC7UKAs36",
"merchant_transaction_id": "TXN_TpyQSN18h",
"checkout_request_id": 517933,
"narration": "Simulate payment",
"payment_mode": "mobile"
}HTTP 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 msisdn provided. The charge_msisdn provided was not valid in the country provided |
| 1027 | Invalid amount provided. The charge_amount should be between the and maximum amounts provided for the payment option. |
Successful Response
{
"status": 1,
"data": "Payment pending acknowledgement"
}