Get Credit Balance

curl --request GET \
  --url https://api.example.com/api/v2/Balance

import 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

curl --request GET \
  --url https://api.example.com/api/v2/Balance

import 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

ApiKey

string

required

Your API key for authentication

ClientId

string

required

Your client identifier for authentication

Headers

Content-Type

string

application/json or application/xml

Type

string

json or xml (response format preference)

Response

ErrorCode

number

Error code (0 for success)

ErrorDescription

string

Description of the result

Data

array

Array containing balance information

Data[].PluginType

string

Service type (e.g., “SMS”)

Data[].Credits

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

Authentication Get Sent Messages

​Get Credit Balance

​Parameters

​Headers

​Response

​Success Response

​Error Response

​Use Cases

Get Credit Balance

Parameters

Headers

Response

Success Response

Error Response

Use Cases