Change or preview a change of payment frequency for a flexible repayment mortgage account

POST 
/loans/{loanId}/payment-schedule:change-payment-frequency

Changes the payment frequency (WEEKLY/FORTNIGHTLY/MONTHLY) of an active Flexible Repayment Mortgage loan account from the given date onward.

When preview is true, the recomputed payment schedule is returned without persisting anything or modifying the account. When absent or false, the change is applied: a payment frequency change event is persisted and the account's schedule is updated.

Request

Responses

200

Payment schedule computed or updated successfully

404

Loan account not found for the given identifier.

422

Invalid frequency/date combination, or the loan account does not support a payment frequency change.