Credit balance – specification

API URL

The URL used to send the HTTP requests:

https://portal.bulkgate.com/api/1.0/simple/info

Note

If the request does not reach its destination, repeat it on the backup server backup1.bulkgate.com.

Supported HTTP methods

GET
POST - application/x-www-form-urlencoded
POST - application/json

See request methods for examples of each.

Parameters table

PARAMETER NAME	VALUE	MANDATORY	DEFAULT VALUE
application_id	Application indentificator	Yes	-
application_token	Application authentication token	Yes	-
wallet	Identifier of the wallet whose balance you want to read. Without it the account's default wallet is returned.	No	-

Request example

POST /api/1.0/simple/info HTTP/1.1 Host: portal.bulkgate.com Content-Type: application/json { "application_id": 451, "application_token": "NKN02TWE6NfBkfl-your-secret-token-Wf05GaqLIWLW4aBj" }

Response

In case of success:

{ "data": { "wallet": "bg1805151838000001", "credit": 215.8138, "currency": "credits", "free_messages": 51, "datetime": "2018-06-13T09:57:21+02:00" } }

In case of error:

{ "type": "unknown_identity", "code": 401, "error": "Unknown identity / unauthorized / empty application_id", "detail": null }

Where:

type and error (description of the error) can be found in the error types table
code represents http error
detail is an additional info about the error

Was this page helpful?

Ask AI Copied