put https://api-dev.tingg.africa/api/v1/payments/
This page will help you get started with Payment ACK service.
Payment Acknowledgement refers to a merchant notification that confirms if they have accepted or rejected the payment. The Payment ACK API has been enhanced to offer security through Bearer Token authentication. This mechanism ensures that only authorized users can access the API, adding an extra layer of protection.
Generate Token
Use the link below to access the Generate token API.
https://docs.tingg.africa/reference/generate-token-api
Post payment api
The post payment api will expect the below request parameters.
Headers
| Parameter Name | Type | Mandatory | Description |
|---|---|---|---|
| {X-Country-Code} | String | Yes | Country code i.e. KEN,NGA,ZAR |
| {Content-Type} | String | Yes | application/json |
Request Payload
| Parameter Name | Type | Mandatory | Description |
|---|---|---|---|
| Receipt Number {receiptNumber} | String | Yes | This contains the receipt number which is unique per service. |
| Status {status} | String | Yes | The payment status i.e. ACCEPTED OR REJECTED. |
| Description {description} | String | Yes | The payment status description |
| Amount {amount} | Integer | No | t contains the amount of the merchant payment ID. Should be greater than 0 |
Sample Request
{
"receiptNumber": "00",
"status": "ACCEPTED",
"description": "Accepted from the guy",
"amount": 2000
}
Response Payload
| Parameter Name | Type | Mandatory | Description |
|---|---|---|---|
| {authStatusCode} | Integer | Yes | The api user authentication code |
| {authStatusDescription} | String | Yes | The api user authentication description |
| {statusCode} | Integer | Yes | Transaction processing status code |
| {statusDescription} | String | Yes | Transaction processing status description |
| {receiptNumber} | String | No | The merchant’s receipt number |
| {beepTransactionID} | String | No | The transaction’s unique identifier in CPG |
Sample Response
{
"message": "Authentication was successful",
"success": true,
"statusCode": 174,
"data": {
"statusDescription": "Acknowledgement Received",
"beepTransactionID": "81139052"
}
}
Status Codes
| Status Code | Status Description |
|---|---|
| 132 | User authentication failed |
| 143 | Payment does not exist in CPG |
| 152 | The acknowledgement has been successfully received and is being processed. |
| 174 | Generic error code. Sent for failed validation, could not connect to RabbitMQ etc |
| 200 | Request processed successfully. The data node will have a value |
| 239 | Payment already escalated. Sent in the response when the payment being acknowledged is already in the escalated final status |
| 240 | Payment already accepted. Sent in the response when the payment being acknowledged is already in the accepted final status. |
| 241 | Payment already rejected. Sent in the response when the payment being acknowledged is already in the rejected final status |
| 245 | Payment already delivered |