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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int64
required

Account ID

Body Params

Parameters for requesting an advancement (V2)

string
enum
required

Installments should be advanced for all the contracts for an account (ALL_CONTRACTS) or for multiple specific contracts (MULTIPLE_CONTRACTS).

Allowed:
string
required

Tracking ID. A client-supplied tracking ID that can be used to keep track of an advancement. Must consist of the characters [a-z,A-Z,0-9,-,:] with a range from 1 to 128.

string
enum

Type of calculation to apply. Default is NONE.

Allowed:
string
enum

Reschedule mode to apply. Must be ADVANCEMENT.

Allowed:
boolean
Defaults to false

Whether interest should be removed when an installment is advanced.

contracts
array of objects

Array of contract advancement configurations (required for MULTIPLE_CONTRACTS condition)

contracts
Headers
string

The Correlation Identifier field is used to link related API requests and events. The x-cid can help the Pismo engineering team track everything related to a call. You can find the x-cid field in the response header from an API endpoint call. If this field isn't passed, one is automatically generated.

Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json