Account Balance

This is an object representing your Frog balance. You can retrieve it to see the balance currently on your Frog account.

https://frogapi.wigal.com.gh/api/v3/balance

Balance Object

Field	Type	Description
status	string	The status of the request
message	string	Provides important information after request
paidvoiceBalance	number	Your Paid Cash Balance
cashBalance	number	Your Cash Balance
bundles	object	Balance of bundles on your account
invoiceSummary	object	Summary of invoices on your account
activeBundleInvoices	object	Active bundle invoices on your account

Responses

Field	Type	Description
status	string	Returns "SUCCESS" when request is successful
message	string	Returns "SUCCESS" on successful request
data	object	Contains balance information including cash balance and bundles

Request samples

Content type

application/json

Example

Get Account Balance

curl -X GET 'https://frogapi.wigal.com.gh/api/v3/balance'
-H "API-KEY: $apikey"
-H "USERNAME: $username"

const apiKey = 'your_api_key_here'; // replace with your api key
const username = 'your_username_here'; // replace with your username

fetch('https://frogapi.wigal.com.gh/api/v3/balance', {
  method: 'GET',
  headers: {
    'API-KEY': apiKey,
    'USERNAME': username
  }
})
.then(response => response.json())
.then(data => {
  console.log(data);
})
.catch(error => {
  console.error('Error:', error);
});

import requests

api_key = 'your_api_key_here' # replace with your api key
username = 'your_username_here' # replace with your username

url = 'https://frogapi.wigal.com.gh/api/v3/balance'
headers = {
  'API-KEY': api_key,
  'USERNAME': username
}

response = requests.get(url, headers=headers)

if response.status_code == 200:
  data = response.json()
  print(data)
else:
  print('Error:', response.status_code, response.text)

<?php
$api_key = 'your_api_key_here'; // replace with your api key
$username = 'your_username_here'; // replace with your username

$url = 'https://frogapi.wigal.com.gh/api/v3/balance';

$headers = [
  "API-KEY: $api_key",
  "USERNAME: $username"
];

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);

if (curl_errno($ch)) {
  echo 'Error:' . curl_error($ch);
} else {
  $httpcode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
  if ($httpcode == 200) {
    $data = json_decode($response, true);
    print_r($data);
  } else {
    echo 'Error: ' . $httpcode . ' - ' . $response;
  }
}

curl_close($ch);
?>

Response samples

Content type

application/json

{
                "status": "SUCCESS",
                "message": "SUCCESS",
                "data": {
                    "paidcashbalance": 0,
                    "cashbalance": 677.56,
                    "bundles": {
                        "VOICE": 15,
                        "KYCVERIFY": 12,
                        "SIMACTIVE": 123,
                        "SMS": 82,
                        "USSD": 100
                    },
                    "invoicesummary": [
                        {
                            "invoicetype": "TOPUP",
                            "count": 2,
                            "totalamount": 2
                        },
                        {
                            "invoicetype": "BUNDLE",
                            "count": 2,
                            "totalamount": 11
                        },
                        {
                            "invoicetype": "CREDIT_NOTE",
                            "count": 6,
                            "totalamount": 126
                        },
                        {
                            "invoicetype": "IOU",
                            "count": 1,
                            "totalamount": 1000
                        }
                    ],
                    "activebundleinvoices": [
                        {
                            "id": 387,
                            "description": "Mashup Bundle dash",
                            "enddate": "2024-08-30",
                            "invoicetype": "BUNDLE",
                            "details": [
                                {
                                    "service": "KYCVERIFY",
                                    "quantity": 12,
                                    "used": 0
                                },
                                {
                                    "service": "VOICE",
                                    "quantity": 15,
                                    "used": 0
                                },
                                {
                                    "service": "SIMACTIVE",
                                    "quantity": 123,
                                    "used": 0
                                },
                                {
                                    "service": "USSD",
                                    "quantity": 100,
                                    "used": 0
                                },
                                {
                                    "service": "SMS",
                                    "quantity": 100,
                                    "used": 18
                                }
                            ]
                        }
                    ]
                }
            }

{
                "status": "FAILED",
                "message": "There is not enough balance.",
            }

{
                "status": "ERROR",
                "message": "Internal server error",
                "data": null
            }