Skip to main content

Input fields

accountNumber : String! required

Account number of customer.

amount : Int! required

Amount of credit to add to the meter, in pence.

The channel that the top-up was made through.

deviceId : String! required

Electricity or gas meter device ID.

isTemporaryCredit : Boolean

Apply as temporary credit.

paymentIntentId : ID

The top-up will wait for this payment to clear before proceeding.

reason : String

Reason for top-up.

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

Example

{ "accountNumber": "A-9ECE4FA0", "amount": 50, "channel": "APP", "deviceId": "79129619", "isTemporaryCredit": true, "paymentIntentId": "32118833", "reason": "name-yes-model-bed-effort" }