API Function: check_user_balance
API Function Application: Return a user balance
API Function Request Type: HTTP Request is sent from your server to our server.
API Function Status: Available as standard
API Function Examples: Click Here to view online examples.


To check a user account balance simply use the 'check_user_balance' function and send a URL string like so:
Please Note: For this function to work Cloud9 must be holding the user account balance.

 

http://api.wire9.com/api.cgi?transaction_id=1001&request_type=check_user_balance&carrier_id=1&password=test&timestamp=2007-03-08%2023:43:437&query=%2B447700000000

IMPORTANT: You must URL Encode your HTTP string. URL Encoding replaces unsafe ASCII characters with "%" followed by their hex equivalent. Safe characters are defined in RFC2396. For example a '+' will become '%2B'

 

The URL is made up of the following variables:

URL

http://api.wire9.com/api.cgi

TRANSACTION_ID

The transaction ID your system assigned to the CHECK USER BALANCE request.

REQUEST_TYPE

This variable must be set to check_user_balance.

CARRIER_ID

This variable must contain the carrier ID that has been assigned to you for use with our API. Please contact support@cloud9-mobile.co.uk if you do not have your API carrier ID.

PASSWORD

This variable must contain the password that has been assigned to you for use with our API. Please contact support@cloud9-mobile.co.uk if you do not have your API password.

TIMESTAMP

This variable is set by your system. It should contain a valid date and time in yyyy-mm-dd HH:mm:ss format. This time stamp is used for the API CDR records.

QUERY

This variable must contain the MSISDN or IMSI of the subscriber of who's balance you wish to query. If passing a MSISDN may use the following formats: 07xxx, 447xxx or +447xxx.

 

Please Note: All of the above variables are required within the HTTP request string.
The check_balance request will fail if the required variables are not passed in the correct format.

When a valid check_user_balance request is made the Cloud9 system will return a standard XML (version 1 tree)
which your system must then phase through and pull out the required data:

 

<?xml version="1.0" ?>

<Wire9_data>

<STATUS_Response>

<BALANCE>50.00</BALANCE>

<CURRENCY>Pounds</CURRENCY>

<IMSI>234180000000000</IMSI>

<MSISDN>+447700000000</MSISDN>

<REQUEST_STATUS>1</REQUEST_STATUS>

<TIME_STAMP>2007-03-08 23:43:43</TIME_STAMP>

<TRANSACTION_ID>1000</TRANSACTION_ID>

</STATUS_Response>

</Wire9_data>


The XML output is made up like so:

BALANCE

This variable contains your current balance in 0.00 format

CURRENCY

This variable contains the currency of your balance (Pounds, Dollars or Euros)

IMSI

This variable will contain the IMSI of the subscriber.

MSISDN

This variable will contain the MSISN of the subscriber.

REQUEST_STATUS

This variable will contain the request status responce.
Options: 0 = Request Failed 1 = Request Successful

TIME_STAMP

The returned TIMESTAMP that you passed within the HTTP request string.

TRANSACTION_ID

The transaction ID your system assigned to the IMSI Status request.

 

If our server is unable to process the request or a system error occurs we will send back a formatted XML
error message like so stating what error occurred within the <Error_Message></Error_Message> tag::

 

<? xml version="1.0" ?>

<Error>

 <Error_Message>Error: Unknown user </Error_Message>
</Error>

 

ERROR_MESSAGE

This variable will contain information to why the request could not be processed by our system.

 

Top of page      Email page    Print page

Last Review 16/08/2008 @ 21:08:19

Privacy Statement | HTTP/XML System API © 2010 Cloud9 Mobile International Ltd. All Rights Reserved.