Skip to content
Home » Octopush Gateway SMS API » Check SMS balance

Check SMS balance

GET
https://api.octopush.com/v1/public/wallet/check-balance

Encoding : UTF-8

Authentication

Your “api-key” and “api-login” must be added in the headers.

Definition

This web service allows you to retrieve your balance by SMS.
The result gives you your balance in Premium and LowCost.

Special parameters

FieldTypeDescription
with_detailsboolean(optional) Adds the details of all the packs in your portfolio.
country_codestring(optional) Code of the country where you want to get your balance. You must also fill in the product_name.
product_namestring(optional) Name of the product in which you want to get your balance (sms_low_cost, sms_premium, vocal_sms, hlr). You must also fill in the country_code.

Curl Example

curl -X GET \ 
'https://api.octopush.com/v1/public/wallet/check-balance' \ 
-H 'Content-Type: application/json' \ 
-H 'api-login: ******@email.org' \ 
-H 'api-key: ************' \ 
-H 'cache-control: no-cache'

Command to copy/paste

curl -X GET 'https://api.octopush.com/v1/public/wallet/check-balance' -H 'Content-Type: application/json' -H 'api-login: ******@email.org' -H 'api-key: ************' -H 'cache-control: no-cache'

JSON Server Response

Success : 200 OK

{
  "amount": 12.54,
  "unit": "euros"
}