Using Our APIs
Commands
Add Nominal Credit
5 min
purpose adds credit to the current nominal balance available on the sim note this request is only valid for manx telecom–issued sims of the following types multinet voda multinet m2m multinet manx 1net requests for other sim types will return the response invalid iccid nominal tariffs and balances are used on manx telecom sim cards to monitor usage and control when devices are deactivated these nominal fees are not the same as the actual fees charged by caburn telecom nominal tariffs can be configured to suit your application in discussion with the support team the \<credit value> element specifies the amount of credit to add, expressed as an integer value in pence or cents (depending on the tariff assigned to the group) valid range 0–10000 values outside this range are converted to zero adding credit works in both pre pay and post pay modes pre pay credit is added to the current nominal balance post pay credit is applied to the negative nominal balance but will not increase the balance above zero (as a result, the full requested credit may not be applied) the response includes the value of credit successfully applied in the \<credit applied> element operational impact api commands perform live configuration changes changes take effect immediately commands may affect sim status, service availability, charging, or usage limits requests cannot be undone automatically ensure all parameters are validated before submitting requests to the production environment endpoint post https //api m2miportal com content type application/xml accept application/xml request (xml) \<add nominal credit version="1" api id="123456"> \<authentication> \<username>username\</username> \<password>password\</password> \</authentication> \<iccid>1234567890123456789\</iccid> \<credit value>100\</credit value> \</add nominal credit> response (success) \<add nominal credit response api id="123456"> \<api outcome>success\</api outcome> \<credit applied>80\</credit applied> \</add nominal credit 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