Bill Status
Gift Bills Bill Status API Intengration
This section contains the endpoints to check any bill service record (single record or to fetch all history).
To Fetch a All Bills Transactions
API Endpoint: /bill/history
GET method
curl -X GET --header 'Authorization: Bearer API_KEY' --header 'MerchantId: username' --header 'content-type: application/json'
Sample Response
{
"success": true,
"code": "00000",
"message": "Fetched successfully",
"data": [
{
"id": 1,
"service_type": "airtime",
"provider": "MTN",
"recipient": "07036218209",
"amount": "100",
"discount": "0",
"fee": "0",
"voucher": "0",
"paid": "100",
"init_bal": "10000",
"new_bal": "9900",
"cg": "0",
"init_cg": "0",
"new_cg": "0",
"debit": "balance",
"trx": "16383452371269788135",
"ref": "16383452382481601229508001",
"api_req_id": null,
"channel": "WEBSITE",
"purchased_code": null,
"cards": null,
"units": null,
"status": "delivered",
"errorMsg": "TRANSACTION SUCCESSFUL",
"refunded": 0,
"created_at": "2021-12-01T07:54:00.000000Z",
"updated_at": "2021-12-01T07:54:00.000000Z"
},
{
"id": 2,
"service_type": "betting",
"provider": "BET9JA",
"recipient": "1028707",
"amount": "100",
"discount": "0",
"fee": "0",
"voucher": "0",
"paid": "100",
"init_bal": "9900",
"new_bal": "9800",
"cg": "0",
"init_cg": "0",
"new_cg": "0",
"debit": "balance",
"trx": "16383454911605187576",
"ref": "211201134044913462",
"api_req_id": null,
"channel": "WEBSITE",
"purchased_code": null,
"cards": null,
"units": null,
"status": "SUCCESS",
"errorMsg": null,
"refunded": 0,
"created_at": "2021-12-01T07:58:14.000000Z",
"updated_at": "2021-12-01T07:58:19.000000Z"
},
{
"id": 14633,
"service_type": "internet",
"provider": "MTN",
"recipient": "08036793166",
"amount": "250.00",
"discount": "5",
"fee": "0",
"voucher": "0",
"paid": "245",
"init_bal": "7290.78",
"new_bal": "7045.78",
"cg": "1",
"init_cg": "0",
"new_cg": "0",
"debit": "balance",
"trx": "2022062913471514250236",
"ref": "GB - 2022062913471514250236",
"api_req_id": null,
"channel": "WEBSITE",
"purchased_code": null,
"cards": null,
"units": null,
"status": "delivered",
"errorMsg": "Dear Customer, You have successfully shared 1000MB Data to 2348036793166. Your SME data balance is 32.56GB expires 11/09/2022. Thankyou",
"refunded": 0,
"created_at": "2022-06-29T12:47:44.000000Z",
"updated_at": "2022-06-29T13:09:39.000000Z"
}
],
"total_count": 3
}
| RESPONSE PROPERTY | DESCRIPTION |
|---|---|
| orderNo | Order number of Gift Bills payment |
| reference | Reseller/Agent reference (unique order number from Reseller/Agent platform) |
| status | delivered successful PENDING SUCCESS FAIL |
| errorMsg | Will return actual response or why error happened |
To Fetch a Bill Transaction Status
API Endpoint: /bill/status/{orderNo}
GET method
curl -X POST --header 'Authorization: Bearer API_KEY' --header 'MerchantId: username' --header 'content-type: application/json'
Sample Response
{
"success": true,
"code": "00000",
"message": "Fetched successfully",
"data": {
"trx": "202206132206791818205",
"orderNo": "GB - 202206132206791818205",
"reference": null,
"status": "delivered",
"errorMsg": "Dear Customer, You have successfully shared 2000MB Data to 2347025150008. Your SME data balance is 872.56GB expires 11/09/2022. Thankyou",
"service_type": null,
"channel": "WEBSITE",
"bill": {
"provider": "MTN",
"recipient": "07025150008",
"amount": "500.00",
"discount": "10",
"fee": "0",
"voucher": "0",
"paid": "490",
"init_bal": "95758.28",
"new_bal": "95268.28",
"cg": "2",
"init_cg": "0",
"new_cg": "0",
"debit": "balance",
"purchased_code": null,
"units": null,
"refunded": false
},
"created_at": "2022-06-13T21:06:57.000000Z",
"updated_at": "2022-06-13T22:51:49.000000Z"
}
}
| RESPONSE PROPERTY | DESCRIPTION |
|---|---|
| orderNo | Order number of Gift Bills payment |
| reference | Reseller/Agent reference (unique order number from Reseller/Agent platform) |
| status | delivered successful PENDING SUCCESS FAIL |
| errorMsg | Will return actual response or why error happened |