Get Credit Balance
curl --request GET \
--url https://api.example.com/api/v2/Balanceimport requests
url = "https://api.example.com/api/v2/Balance"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/api/v2/Balance', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"ErrorCode": 123,
"ErrorDescription": "<string>",
"Data": [
{}
],
"Data[].PluginType": "<string>",
"Data[].Credits": "<string>"
}Credit Balance
Get Credit Balance
Check your account balance and available credits
Get Credit Balance
curl --request GET \
--url https://api.example.com/api/v2/Balanceimport requests
url = "https://api.example.com/api/v2/Balance"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/api/v2/Balance', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"ErrorCode": 123,
"ErrorDescription": "<string>",
"Data": [
{}
],
"Data[].PluginType": "<string>",
"Data[].Credits": "<string>"
}Get Credit Balance
Retrieve your current account balance and available credits for SMS services.curl -X GET "https://app.notify.ng/api/v2/Balance?ApiKey=YOUR_API_KEY&ClientId=YOUR_CLIENT_ID" \
-H "Content-Type: application/json"
const response = await fetch('https://app.notify.ng/api/v2/Balance?ApiKey=YOUR_API_KEY&ClientId=YOUR_CLIENT_ID', {
method: 'GET',
headers: {
'Content-Type': 'application/json'
}
});
const data = await response.json();
console.log(data);
import requests
url = "https://app.notify.ng/api/v2/Balance"
params = {
"ApiKey": "YOUR_API_KEY",
"ClientId": "YOUR_CLIENT_ID"
}
response = requests.get(url, params=params)
data = response.json()
print(data)
<?php
$url = "https://app.notify.ng/api/v2/Balance?ApiKey=YOUR_API_KEY&ClientId=YOUR_CLIENT_ID";
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, array('Content-Type: application/json'));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>
Parameters
string
required
Your API key for authentication
string
required
Your client identifier for authentication
Headers
string
application/json or application/xmlstring
json or xml (response format preference)Response
number
Error code (0 for success)
string
Description of the result
array
Array containing balance information
string
Service type (e.g., “SMS”)
string
Available credits in your account (e.g., “€0.6991”)
Success Response
{
"ErrorCode": 0,
"ErrorDescription": "Success",
"Data": [
{
"PluginType": "SMS",
"Credits": "€0.6991"
}
]
}
Error Response
{
"ErrorCode": 001,
"ErrorDescription": "Account details cannot be blank"
}
Use Cases
- Pre-send validation: Check balance before sending SMS messages
- Account monitoring: Monitor credit consumption
- Billing integration: Display current balance to users
- Automated alerts: Set up low balance notifications