Fast Message APIs
Home
Getting Started
Home
Getting Started
  • SMS API
    • Send SMS
    • Bulk SMS
    • Send Hashed SMS
    • Send OTP
    • Delivery Reports
    • Delivery Status Descriptions
    • SMS Balance
    • Common Errors
    • Response Codes
  • RESELLER SMS CREDIT API
  • USSD GUIDE
  • SHORTCODE GUIDE
  • SMPP API
  • AIRTIME API
  • EMAIL API

SMS ACCOUNT BALANCE

The SMS Account Balance API allows you to check the available balance in your SMS account. This ensures that you have sufficient credits before sending messages.

Tip

Checkout code examples in send SMS

GET Method

Endpoint:

https://{{url}}/api/services/getbalance

Parameters:

ParameterDescription
apikeyYour valid API key
partnerIDYour Partner ID

Example Request (GET):

https://{{url}}/api/services/getbalance?apikey={{apikey}}&partnerID={{partnerID}}

POST Method

https://{{url}}/api/services/getbalance

Request Body:

{
  "apikey": "{{apikey}}",
  "partnerID": "{{partnerID}}"
}

Sample Success Response:

{
  "response-code":200,
  "credit":"545.00",
  "partner-id":"xxxxx"
  
}

Sample Error Response:

{
  "response-code":1006,
  "response-description":"Invalid credentials"
}
Prev
Delivery Status Descriptions
Next
Common Errors