Input fields

accountNumber : String! required

The account number.
amount : Int! required

The amount to be collected in the minor unit of currency.
collectionMethod : CollectionMethod

The method by which the payment is being collected.
description : String! required

A description of the purpose of the payment.
isTelephoneInitiated : Boolean

Whether the authorisation to initiate the payment was given over the phone.
ledgerId : ID

The id of the specific ledger against which this payment should be applied.
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 specific ledger against which this payment should be applied.
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-20B8C34F", "amount": 91, "collectionMethod": "CARD", "description": "together-land-say-establish-economic", "isTelephoneInitiated": true, "ledgerNumber": "foot-few-teacher-around-end" }