GetStatus

You can call this endpoint to get the status of your transaction

Verify transactions by agent

GET {{ BASE_URL }}/api/biller/{agentRef}/status

This endpoint allows you to get the transaction status.

Path Parameters

Name
Type
Description

agentRef*

string

agentReference

Headers

Name
Type
Description

x-api-key*

String

3434-4243-ffef-2323

Power/Electricity Only
{
  "isSuccessful": true,
  "message": "string",
  "code": "string",
  "data": {
    "amount": 0,
    "statusCode": "string",
    "transactionStatus": "string",
    "transactionMessage": "string",
    "transactionReference": "string",
    "isSuccessful": true,
    "mainTokenUnits": "string",
    "mainToken": "string",
    "mainTokenTax": 0,
    "mainsTokenAmount": 0,
    "bonusToken": "string",
    "bonusTokenDescription": "string",
    "bonusTokenUnits": "string",
    "productName": "string"
  },
  "transactions": [
        {
            "transactionRef": "string",
            "transactionDate":"dateTime",
            "amount": decimal,
            "transactionType": "string",
            "narration": "string"
        }
    ]
```
}

Data, Airtime, Cable TV
{
  "isSuccessful": true,
  "message": "string",
  "code": "string",
  "data": {
    "amount": 0,
    "statusCode": "string",
    "transactionStatus": "string",
    "transactionMessage": "string",
    "transactionReference": "string",
    "isSuccessful": true,
  },
  "transactions": [
        {
            "transactionRef": "string",
            "transactionDate":"dateTime",
            "amount": decimal,
            "transactionType": "string",
            "narration": "string"
        }
    ]
}

Last updated