Request
Response
Postman collection
Environments and Versioning
Progress
post
Cancel a request
get
View the progress and extended information of your requests.
Authentication
post
Create a new user
post
Authenticate a user
post
Get a new set of authorisation tokens
Ownership
post
Request ownership of a payment unit
post
Confirm ownership
post
Remove ownership of a payment unit
get
Show owned payment units
Bulk
post
Display text on the screen of multiple payment units
post
Change the credit balance by a value for multiple payment units
post
Fetch the current credit balance from multiple payment units
post
Set the low credit alert settings on multiple payment units
post
Configure the audio settings for multiple payment units
post
Remove customer information from multiple payment units
post
Set the friendly times of day when the payment unit cannot disconnect supply for multiple payment units
post
Set the Special Days when supply cannot be disconnected for multiple payment units
post
Fetch the current GPRS signal information from multiple payment units
post
Extend available emergency credit for multiple payment units
post
Set the current operational mode for multiple payment units
post
Set the regular deduction for multiple payment units
post
Set a tariff to multiple payment units
post
Configure a meter value to be collected for multiple payment units
post
Fetch the latest value fetched from a meter by multiple payment units
get
View the result or current state of a bulk request by Name or ID
get
View the progress and extended information of a bulk request by Name or ID
post
Set the daylight saving intervals for multiple payment units
Scheduling
del
Cancel a scheduled request
get
Show all scheduled requests.
Caching
get
Retrieve the current stored snapshot of all owned payment units
get
Retrieve the current stored snapshot of the payment unit
get
Retrieve the last known arrears configuration
get
Retrieve the last known arrears configuration for all owned payment units
get
Retrieve the last known credit status value
get
Retrieve the last known credit status value for all owned payment units
get
Retrieve the last known low credit settings
get
Retrieve the last known low credit settings for all owned payment units
get
Retrieve the last received credit report
get
Retrieve the last received credit report for all owned payment units
get
Retrieve the last known currency configuration
get
Retrieve the last known currency configuration for all owned payment units
get
Retrieve the last known daylight saving configuration
get
Retrieve the last known daylight saving configuration for all owned payment units
get
Retrieve the last known emergency credit configuration
get
Retrieve the last known emergency credit configuration for all owned payment units
get
Retrieve the last known firmware version configured
get
Retrieve the last known firmware version for all owned payment units
get
Retrieve the last known friendly disconnection configuration
get
Retrieve the last known friendly disconnection configuration for all owned payment units
get
Retrieve the last known audio settings
get
Retrieve the last known audio configuration for all owned payment units
get
Retrieve the last known half-hourly data values
get
Retrieve the last known half-hourly data values for all owned payment units
get
Retrieve the last known LCD contrast configuration
get
Retrieve the last known LCD contrast configuration for all owned payment units
get
Retrieve the last known home page message configuration
get
Retrieve the last known home page message configuration for all owned payment units
get
Retrieve the last known meter configurations
get
Retrieve the last known meter configurations for all owned payment units
get
Retrieve the last received meter fault report
get
Retrieve the last received meter fault report for all owned payment units
get
Retrieve the last received meter readings
get
Retrieve the last received meter readings for all owned payment units
get
Retrieve the last known omnipower configuration
get
Retrieve the last known omnipower configuration for all owned payment units
get
Retrieve the last known operational mode configuration
get
Retrieve the last known operational mode configuration for all owned payment units
get
Retrieve the last known hidden pages configuration
get
Retrieve the last known hidden pages configuration for all owned payment units
get
Retrieve the last known regular reboot configuration
get
Retrieve the last known regular reboot configuration for all owned payment units
get
Retrieve the last known regular deduction configuration
get
Retrieve the last known regular deduction configuration for all owned payment units
get
Retrieve the last known special days configuration
get
Retrieve the last known special days configuration for all owned payment units
get
Retrieve the last known suggestion calculation configuration
get
Retrieve the last known suggestion calculation configuration for all owned payment units
get
Retrieve the last known supply configuration
get
Retrieve the last known supply configuration for all owned payment units
get
Retrieve the last known tariff configurations
get
Retrieve the last known tariff configurations for all owned payment units
Operational Mode
Pre-payment mode
Credit mode
Factory mode
post
Set the current operational mode
post
Set the current operational mode for multiple payment units
post
Fetch the current operational mode
get
Retrieve the last known operational mode configuration
get
Retrieve the last known operational mode configuration for all owned payment units
Meter
Example 1: Electricity reading and consumption
Example 2: Heat reading, consumption, flow rate, flow temperature, and return temperature
Example 3: Two meters of the same model
Meter Select
Meter Find
Meter Read
Meter Tariff
Meter Report
Meter Consumption
Meter Display
post
Configure a meter value to be collected
post
Configure a meter value to be collected for multiple payment units
post
Fetch the meter configuration from the payment unit
post
Fetch the current fault state of configured meter readings
post
Fetch the last obtained value of the specified meter
post
Fetch the latest value fetched from a meter by multiple payment units
post
Fetch 30-minute values from the payment unit
get
Retrieve the last known half-hourly data values
get
Retrieve the last known half-hourly data values for all owned payment units
get
Retrieve the last known meter configurations
get
Retrieve the last known meter configurations for all owned payment units
get
Retrieve the last received meter fault report
get
Retrieve the last received meter fault report for all owned payment units
get
Retrieve the last received meter readings
get
Retrieve the last received meter readings for all owned payment units
Tariff
post
Set a tariff
post
Set a tariff to multiple payment units
post
Fetch a tariff configuration
get
Retrieve the last known tariff configurations
get
Retrieve the last known tariff configurations for all owned payment units
get
Retrieve a list of tariff units
Payment
post
Add a payment
post
Reverse a payment
post
Find pending payments
Credit
post
Change the credit balance by a value
post
Change the credit balance by a value for multiple payment units
post
Set the credit balance
post
Set the credit balance
post
Fetch the current credit balance
post
Fetch the current credit balance from multiple payment units
post
Fetch the last 9 credits added
post
Fetch a credit report
get
Retrieve the last known credit status value
get
Retrieve the last known credit status value for all owned payment units
get
Retrieve the last received credit report
get
Retrieve the last received credit report for all owned payment units
Low Credit
post
Set the low credit alert settings
post
Set the low credit alert settings on multiple payment units
post
Fetch the low credit alert settings
get
Retrieve the last known low credit settings
get
Retrieve the last known low credit settings for all owned payment units
Emergency Credit
post
Set the available emergency credit
post
Set the available emergency credit
post
Fetch the current emergency credit limit
get
Retrieve the last known emergency credit configuration
get
Retrieve the last known emergency credit configuration for all owned payment units
Loan
post
Extend available emergency credit
post
Extend available emergency credit for multiple payment units
Templates
get
View the progress and extended information of all existing template actions created by template applications
get
View the progress and extended information of all actions for a single template application request
get
Retrieve all created templates
post
Create or update a template
post
Apply a template
post
Bulk apply a template
get
Get available template actions
get
Get recommended base templates
Arrears
post
Set the arrears balance in the payment unit
post
Fetch the current arrears balance
get
Retrieve the last known arrears configuration
get
Retrieve the last known arrears configuration for all owned payment units
Suggestion Calculation
post
Set the suggested top-up calculation parameters
post
Fetch the current suggested top-up calculation settings
get
Retrieve the last known suggestion calculation configuration
get
Retrieve the last known suggestion calculation configuration for all owned payment units
Regular Deduction
post
Set the regular deduction configuration
post
Set the regular deduction for multiple payment units
post
Fetch the regular deduction settings
get
Retrieve the last known regular deduction configuration
get
Retrieve the last known regular deduction configuration for all owned payment units
Supply
Normal Operation
Force On
Force Off
post
Set the supply operating mode
post
Fetch the current supply mode
get
Retrieve the last known supply configuration
get
Retrieve the last known supply configuration for all owned payment units
Daylight Saving
get
Retrieve the last known daylight saving configuration
get
Retrieve the last known daylight saving configuration for all owned payment units
post
Set the daylight saving intervals
post
Set the daylight saving intervals for multiple payment units
post
Fetch the daylight saving intervals
Friendly Disconnection
Friendly Days
Special Days
post
Set the Friendly times of day when the payment unit cannot disconnect supply
post
Set the friendly times of day when the payment unit cannot disconnect supply for multiple payment units
post
Fetch the Friendly Days currently configured
post
Set the Special Days in the payment unit
post
Set the Special Days when supply cannot be disconnected for multiple payment units
post
Fetch the Special Days configured in the payment unit
get
Retrieve the last known friendly disconnection configuration
get
Retrieve the last known friendly disconnection configuration for all owned payment units
get
Retrieve the last known special days configuration
get
Retrieve the last known special days configuration for all owned payment units
Electrical Disconnection
post
Set the Omnipower electrical disconnection capability
post
Fetch the Omnipower configuration settings
post
Fetch the current state of the Omnipower relay
get
Retrieve the last known omnipower configuration
get
Retrieve the last known omnipower configuration for all owned payment units
Currency
post
Set the characters for currency
post
Fetch the active currency characters in use
get
Retrieve the last known currency configuration
get
Retrieve the last known currency configuration for all owned payment units
