17 Dec Get Balance function

 

To retrieve the current balance on the account.

To send a message the request must be submitted one of the following URLs:

HTTP (non-SSL)

HTTPS (SSL) *recommended*

 

6.1 HTTP Methods

All requests should be submitted through the HTTP GET Method.

6.2 Authentication Information

All requests require API Key and API Secret authentication credentials. Account Administrators can login to view their account API Key and API Secret in the “My Profile > Settings” section.

To authenticate a request, please use one of the following options:

In the header of the request for “apiKey

Parameter Name

apiKey

Description

The account’s API username (key). Its a 32 character random string.

Example:

 

Variable Type

String

Mandatory?

YES

 

6.3 Request Parameters

This method has no inbound parameters.

6.4.1 Examples using GET Method

PHP example

 

Java example (with Apache HTTPClient)

 

6.5 Response Parameters

 

Key

Description

Variable Type

responseType

An ENUM that represents the return code for the response. Please reference Response Codes table in Annex A. String

balance

Remaining account balance. Number, Double

requestResponseId

An ENUM that represents the return code for the response. Please reference Response Codes table in Annex A. Integer

requestResponseDescription

An integer representing the return code of the response / error. Please reference Response Codes table in Annex A.

requestResponseDescription

An integer representing the return code of the response / error. Please reference Response Codes table in Annex A. String