Skip to main content
GET
/
api
/
v2
/
Balance
{
  "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://accounts.netvox.ng/api/v2/Balance?ApiKey=YOUR_API_KEY&ClientId=YOUR_CLIENT_ID" \
  -H "Content-Type: application/json"

​
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