Input fields

accountNumber : String! required

The number of the account.
bankDetails : BankDetailsInput! required

The details with which to set up the instruction (these will be sent to the vendor).
ledgerId : ID

The id of the ledger on which the instruction should be created (or "main").
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 the instruction should be created.
owners : [OwnerInput]

The owners of the financial account this instruction represents.
useForAutomatedPayments : Boolean

Set newly created payment instruction as the active payment preference.
validFrom : DateTime! required

The date-time that the instruction is valid from.
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-FE1BFAED", "bankDetails": BankDetailsInput, "ledgerNumber": "sister-start-perhaps-public-need", "owners": OwnerInput, "useForAutomatedPayments": true, "validFrom": "2023-05-21T06:00:10.438440+00:00" }