CreatePaymentScheduleInput
Input type for creating a new payment schedule on a ledger. Requires an account_number, ledger_number, valid_from, trigger, payment_frequency and collection_method. When collection_method is KRAKEN_INITIATED, payment_method_id must also be provided.
Input fields
The account number the schedule will be created on.
How payments are collected for this schedule. Use KRAKEN_INITIATED when the schedule uses a selected payment method and Kraken collects payment; use CUSTOMER_INITIATED when there is no selected payment method and the customer arranges payment themselves.
The number of the ledger to create the schedule on.
The fixed payment amount in the smallest currency unit. Required for schedules with a fixed payment amount; must not be provided for schedules with a variable amount (e.g. billed amount).
The day on which payment is collected.
The frequency at which payments are collected.
The frequency multiplier, e.g. 2 with WEEKLY frequency gives bi-weekly. Defaults to 1.
The ID of the payment instruction to use for collection. Required when collection_method is KRAKEN_INITIATED.
When a payment is due.
The date from which the new schedule is valid.
Example
{
"accountNumber": "A-CDEE663F",
"collectionMethod": "KRAKEN_INITIATED",
"ledgerNumber": "identify-gas-suggest-government-travel",
"paymentAmount": 85,
"paymentDay": 71,
"paymentFrequency": "WEEKLY",
"paymentFrequencyMultiplier": 78,
"paymentMethodId": "10766266",
"trigger": "PLAN",
"validFrom": "1991-10-24"
}