Skip to main content

Fields

creditTransfers : [PrepayCreditTransferType]

Transfers of credit from the account ledger to a smart prepay meter.

currentBalance : Int

The current final balance of the ledger in pence.

id : ID
Deprecation
The 'ledgerId' field is deprecated.

Please use 'ledgerNumber' instead. This is in the form of 'L-123456789A'

- Marked as deprecated on 2024-10-22.
- Scheduled for removal on or after 2025-06-25.
ledgerType : String
name : String

The display name of the ledger.

number : String

The canonical name of the ledger.

paymentAdequacy : PaymentAdequacyDetailsType
payments : [PrepayPaymentType]

Payments made to add credit to a smart prepay meter.

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

{ "creditTransfers": [PrepayCreditTransferType], "currentBalance": 95, "ledgerType": "wide-spring-understand-two-soon", "name": "care-model-offer-yeah-six", "number": "reflect-second-gun-walk-poor", "paymentAdequacy": PaymentAdequacyDetailsType, "payments": [PrepayPaymentType] }