PaymentScheduleType
An object that represents when we have agreed to take payments from a payment instruction.
Fields
The recorded history of changes to this payment schedule (creation, updates and deletion), most recent first.
The delay configuration for this payment schedule.
If the payment schedule is exempt from payment adequacy.
The ledger number of the payment schedule.
Details of the payment_day value.
The frequency of the payment schedule.
The reason the payment schedule was created.
Every scheduled payment method this payment schedule has had, past, current and future. Each entry specifies either manual collection or a specific payment method.
The method of payment for the schedule.
The supplementary ledger for this payment schedule, if it is on one.
The sum of the payment adequacy contributions on the payment schedule that are expected to be taken before the debt repayment is complete.
The cause for requesting payment on a schedule.
Example
{
"changeHistory": [PaymentScheduleChangeEventType],
"delayConfiguration": PaymentScheduleDelayConfigurationType,
"id": "32826978",
"isExemptFromPaymentAdequacy": true,
"isPaymentHoliday": true,
"isVariablePaymentAmount": true,
"ledgerNumber": "type-minute-turn-million-great",
"paymentAdequacyAdjustment": 64,
"paymentAdequacyAdjustmentExpiryDate": "1984-11-22",
"paymentAmount": 65,
"paymentDay": 17,
"paymentDayDetails": PaymentSchedulePaymentDayDetailsType,
"paymentFrequency": "Weekly",
"paymentFrequencyMultiplier": 36,
"paymentHolidayReason": "trouble-wish-modern-film-read",
"reason": "GENERAL_ACCOUNT_PAYMENT",
"scheduledPaymentMethods": ScheduledPaymentMethodConnectionTypeConnection,
"scheduleType": "BACS_TRANSFER",
"supplementaryLedger": SupplementaryLedgerType,
"totalDebtAmount": 49,
"trigger": "PLAN",
"validFrom": "2025-12-05",
"validTo": "2022-06-22"
}