Query Nominal Balance

7 min

purpose returns the current nominal balance for a specified sim the nominal balance is used on certain sim types to monitor usage and determine when devices may be deactivated the target sim is specified using the \<iccid> element applicability this query is only valid for manx telecom issued sims of the following types multinet voda multinet m2m multinet manx 1 net requests submitted for other sim types will return the response invalid iccid nominal tariffs and balances nominal tariffs and balances are used to monitor usage and control deactivation thresholds nominal balances are not the same as the actual commercial fees charged by csl are configurable to suit your application can be adjusted in discussion with the support team pre pay and post pay behaviour in pre pay mode , the nominal balance will be greater than or equal to zero in post pay mode , the nominal balance will be less than or equal to zero returned value the response element \<nominal balance> represents the integer value of the current nominal balance in pence, or cents depending on the tariff assigned to the group endpoint post https //api m2miportal com content type application/xml accept application/xml request (xml) \<query nominal balance version="1" api id="123456"> \<authentication> \<username>username\</username> \<password>password\</password> \</authentication> \<iccid>1234567890123456789\</iccid> \</query nominal balance> response (success) \<query nominal balance response api id="123456"> \<api outcome>success\</api outcome> \<nominal balance>760\</nominal balance> \</query nominal balance response> response (failure) if a request cannot be processed, the response will include api outcome indicating failure an error description explaining the reason failure responses may occur due to invalid authentication credentials invalid or unknown identifiers (for example iccid or msisdn) invalid or missing parameters values not permitted for the specified sim type or account configuration insufficient permissions integrating systems should validate input data before submission and implement appropriate error handling and logging