Skip to main content

Input fields

accountNumber : String

A code that uniquely identifies the account.

ledgerNumber : String

Ledger number for the account.

paymentDay : Int

Payment day for the fixed payment schedule.

useForAutomatedPayments : Boolean

Set newly created payment instruction as the active payment preference.

This flag is accepted for forward compatibility but is currently a no-op.

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-D68358D2", "ledgerNumber": "despite-least-face-again-study", "paymentDay": 72, "useForAutomatedPayments": true }