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 to which the instructions will be linked.

useForAutomatedPayments : Boolean

Set newly created payment instruction as the active payment preference.

validFrom : DateTime

The datetime from which the instruction is vaild. If not specified, defaults to the current datetime.

vendorReference : String!


            required

The vendor's reference for this payment method.

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-C72D6E0C",
  "instructionType": "BPAY",
  "ledgerNumber": "government-travel-process-participant-role",
  "useForAutomatedPayments": true,
  "validFrom": "1991-09-17T12:51:50.780877+00:00",
  "vendorReference": "tax-west-voice-mention-can"
}