API Documentation

Use this endpoint to get the network id, airtime pricing, data plans etc.

Example Request:

Example Response:

{
  "status": "success",
  "msg": "Network Retrieved",
  "response": [
    {
      "id": "1",
      "network": "MTN",
      "status": "On"
    },
    {
      "id": "2",
      "network": "AIRTEL",
      "status": "On"
    },
    {
      "id": "3",
      "network": "GLO",
      "status": "On"
    },
    {
      "id": "4",
      "network": "9MOBILE",
      "status": "On"
    }
  ]
}

Retrieve your current account balance.

Example Response:

{
  "name": "Yusuf Ibrahim",
  "balance": "5,577.00",
  "status": "success"
}

Purchase airtime for any Nigerian network.

Payload:

{
  "network": "1",
  "phone": "07032529431",
  "ref": "AIRTIME123456789",
  "airtime_type": "VTU",
  "ported_number": true,
  "amount": "100"
}

Response:

{
  "status": "success",
  "Status": "successful"
}

Purchase data bundles for all networks.

Payload:

{
  "network": "1",
  "phone": "07032529431",
  "ref": "DATA12345",
  "plan": "1",
  "ported_number": true
}

Response:

{
  "status": "success",
  "Status": "successful",
  "true_response": "MTN SME 500 MB for 09130593857. Response: Dear Customer, You have successfully shared 500MB Data to 2349130593857. Your SME data balance is 30424.18GB expires 26/10/2024. Thankyou"
}

Verify cable TV subscription details.

Payload:

{
  "provider": "1",
  "iucnumber": "73737267672"
}

Response:

{
  "status": "success",
  "Status": "successful",
  "msg": "Ibrahim Yusuf",
  "Customer_Name": "Ibrahim Yusuf"
}

Purchase cable TV subscriptions.

Payload:

{
  "provider": "1",
  "iucnumber": "73737267672",
  "plan": "3",
  "ref": "4545567k4h5300",
  "subtype": "renew/change",
  "phone": "07032529431"
}

Response:

{
  "status": "success",
  "Status": "successful"
}

Verify electricity bill details.

Payload:

{
  "provider": "1",
  "meternumber": "24567665767",
  "metertype": "prepaid/postpaid"
}

Response:

{
  "status": "success",
  "Status": "successful",
  "msg": "Ibrahim Yusuf",
  "Customer_Name": "Ibrahim Yusuf"
}

Pay electricity bills.

Payload:

{
  "provider": "1",
  "meternumber": "24567665767", 
  "amount": "1000",
  "metertype": "prepaid",
  "phone": "07032529431",
  "ref": "METER_2eertt567ye678"
}

Response:

{
  "status": "success",
  "Status": "successful", 
  "msg": "123456789",
  "token": "123456789"
}

Purchase examination pins (WAEC, NECO, etc.).

Payload:

{
  "provider": "1",
  "quantity": "2",
  "ref": "2eertt567ye678"
}

Response:

{
  "status": "success",
  "Status": "successful",
  "msg": "123456,123456,123456",
  "pin": "123456,123456,123456",
  "pins": "123456,123456,123456",
  "token": "123456,123456,123456"
}

Generate and manage recharge pins.

Payload:

{
  "network": "1",
  "quantity": "2",
  "plan": "5",
  "businessname": "Prime Biller",
  "ref": "EPIN_34356787653"
}

Response:

{
  "status": "success",
  "Status": "successful",
  "quantity": "3",
  "pin": "123456,123456,123456",
  "serial": "123456,123456,123456",
  "load_pin": "*123*2*pin#",
  "check_balance": "*223#"
}

Generate and manage data pins.

Payload:

{
  "network": "1",
  "quantity": "2",
  "data_plan": "5",
  "businessname": "Prime Biller",
  "ref": "34356787653535354"
}

Response:

{
  "status": "success",
  "Status": "successful",
  "quantity": "3",
  "pin": "123456,123456,123456",
  "serial": "123456,123456,123456",
  "load_pin": "*123*2*pin#",
  "check_balance": "*223#"
}

Check the status of a transaction using the reference.

Example Request:

Response:

{
  "status": "success",
  "msg": "Transaction Details Retrieved Successfully",
  "response": {
    "transref": "DATA_461305381726952097",
    "amount": "261",
    "status": "success",
    "oldbal": "3135.25",
    "newbal": "2874.25",
    "date": "2024-09-21 21:55:40",
    "service": "Data",
    "description": "MTN SME 1GB for 07032529431. Response: Dear Customer, You have successfully shared 1GB Data to 2347032529431. Your SME data balance is 24067.74GB expires 28/10/2024. Thankyou"
  }
}