Input fields

accountNumber : String! required

The account number.
amount : Int! required

The payment amount (in pence).
collectionMethod : PaymentType

The type of the payment instruction.
description : String! required

The reason a payment is being collected, for internal audit purposes.
idempotencyKey : String! required
ledgerId : ID

The ID of the ledger on which to collect the payment.
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.
ledgerNumber : String

The number of the ledger on which to collect the payment.
paymentDate : Date! required

The date to attempt to take the payment. Cannot be a date in the past. Payment will be collected on the requested date or as soon as possible after that date.
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-3372353E", "amount": 63, "collectionMethod": "BPAY", "description": "where-budget-over-impact-brother", "idempotencyKey": "far-eat-see-about-couple", "ledgerNumber": "keep-again-physical-paper-structure", "paymentDate": "1981-09-09" }