Skip to main content

Input fields

accountNumber : String! required

The account number.

instructionType : PaymentType! required

The type of the new payment instruction.

ledgerId : String

The ledger 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.
ledgerNumber : String

WARNING: Will be mandatory in future versions

The number of the ledger.

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-A4E563AD", "instructionType": "BPAY", "ledgerNumber": "region-a-among-book-cause" }