Create installment advancement

Creates an installment advancement for an account. An installment advancement moves one or more future installments to the current cycle.

This version supports two advancement modes:

ALL_CONTRACTS mode: Advances all future installments for all installment agreements in the account. When using this mode:

  • Set condition to ALL_CONTRACTS.
  • The calculator, reschedule, and remove_interest_from_current fields are required at the root level.
  • The contracts array should not be provided.

MULTIPLE_CONTRACTS mode: Advances installments for specific contracts with individual configurations. When using this mode:

  • Set condition to MULTIPLE_CONTRACTS.
  • Provide a contracts array with individual contract configurations.
  • Root-level calculator, reschedule, and remove_interest_from_current fields must not be provided.

When you advance installments, you must specify what to do with the interest. You have three options:

  1. To remove 100% of the interest on the advanced installment(s), set the remove_interest_from_current field to true and the calculator field to REMOVE_ALL_INTEREST.
  2. To advance 100% of the interest on the advanced installment(s), set remove_interest_from_current to false and set calculator to NONE.
  3. To recalculate the interest applied to the advanced installment(s), set calculator to PRESENT_VALUE. You can set the remove_interest_from_current field to either true or false. If true, the system recalculates interest on installments that were already in the current cycle (and did not need to be advanced). Otherwise, interest on those installments remains unchanged.
    For more information, refer to Installment advancements and Creating an installment advancment.

This endpoint triggers an async process in which the transactions are advanced as requested.

Language
Credentials
Bearer
JWT
Response
Click Try It! to start a request and see the response here!