Skip to content
Home » Octopush Gateway SMS API » Check credit (in Euros)

Check credit (in Euros)

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

Encoding : UTF-8

Authentication

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

Definition

This Web Service allows you to retrieve the amount of credits per product, according to the countries chosen.

The result is a list, country by country, of the credits for each type of product (Premium SMS, Voice SMS, HRL, etc…

Special parameters

NomTypeDescription
country_codes[]string[](optional) The list of countries for which you wish to obtain the number of credits per product.

Curl Example

curl -X GET \ 
'https://api.octopush.com/v1/public/wallet/check-credits' \ 
-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-credits' -H 'Content-Type: application/json' -H 'api-login: ******@email.org' -H 'api-key: ************' -H 'cache-control: no-cache'

JSON Server Response

Success : 200 OK

{
   "ES" : {
     "premium_sms": 5,
     "vocal_sms": 0,
     "low_cost_sms": 0,
     "hlr": 87
   },
   "FR": {
     "premium_sms": 10,
     "vocal_sms": 0,
     "low_cost_sms": 21,
     "hlr": 87
   },
   "??": {"..."},
   "??": {"..."},
   "??": {"..."},
   "GB": {
     "premium_sms": 5,
     "vocal_sms": 0,
     "low_cost_sms": 0,
     "hlr": 87
   }
 }