get https://payments-instore.sandbox.tingg.africa/merchants/payments
This API is meant to be called in situations where the IPN did not come as expected due to errors or internal incidents. The API is not to be used as the primary means of confirming transactions.
Please note the following:
- By default, the API will return 1000 transactions conducted in the last 24 hours
- The difference between the fromDate and the toDate can not exceed seven (7) days
- The pagination is controlled by you as we will not be returning the total parameter to you due to technical reasons. How do I know that’s all the records? When the combination of your page and size parameter returned an empty array.
Response
{
"statusCode": 200,
"message": "Successful",
"success": true,
"data": [
{
"transactionID": "1919772758",
"payerTransactionID": "RKK9UGBUM5",
"currencyCode": "KES",
"statusDescription": "Payment Accepted",
"requestOriginName": "Tingg Instore USSD",
"amountPaid": 1.0,
"paymentStatus": 140,
"payerNarration": "The service request is processed successfully.",
"paymentDate": "2023-11-20T10:06:41",
"receiverClientCode": "INSTOREDEMOKE",
"storeCode": "542",
"counterCode": "12150",
"msisdn": "254705568254",
"merchantTransactionID": "4551274",
"requestOriginCode": "TINGG_INSTORE_USSD"
}
]
}
Response Param
Parameter | Type | Description |
---|---|---|
data.*.transactionID | String | This is the transactionID of the transaction |
data.*.payerTransactionID | String | This is the transactionID of the transaction |
data.*.currencyCode | String | This is the currencyCode of the transaction |
data.*.statusDescription | String | This is the statusDescription of the transaction |
data.*.requestOriginName | String | This is the requestOriginName of the transaction |
data.*.amountPaid | Double | This is the amount paid for the transaction |
data.*.paymentStatus | Integer | This is the paymentStatus of the transaction |
data.*.payerNarration | String | This is the requestOriginName of the transaction |
data.*.paymentDate | String | The payment date connected with the transaction. E.g. 2023-11-20T10:06:41 |
data.*.storeCode | String | This is the identifier of the Store connected to this transaction |
data.*.counterCode | String | This is the identifier of the Counter connected to this transaction |
data.*.msisdn | String | This is the mobile number that performed the transaction for Mobile Money payment methods |
data.*.merchantTransactionID | String | This is the same ID returned from initiating a Mobile Money transaction described in section 3.4 |
data.*.requestOriginCode | String | This data point indicates the origin of the transaction. Common values are TINGG_INSTORE_USSD, TINGG_INSTORE_INTEGRATIONS |