Installment advancements

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 <i>not</i> be passed.

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 passed.

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

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.
To advance 100% of the interest on the advanced installment(s), set remove_interest_from_current to false and set calculator to NONE.
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.

post/v2/accounts/{accountId}/installment-advance

Request

Base URL
https://sandbox.pismolabs.io/installment-management
URL
https://sandbox.pismolabs.io/installment-management/v2/accounts/{accountId}/installment-advance
Auth
HTTP bearer

Path parameters

accountIdinteger required

Example:6912345

Account ID

Headers

x-cidstring

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.

Request body

condition'MULTIPLE_CONTRACTS' | 'ALL_CONTRACTS' required

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

tracking_idstring 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.

Note: For a given account ID, the tracking ID must be unique. You cannot reuse the same tracking ID in another call to this endpoint, even if the earlier call returned an error, unless you use a different account ID.

calculator'PRESENT_VALUE' | 'REMOVE_ALL_INTEREST' | 'NONE'

Type of calculation to apply. Default is NONE.

reschedule'ADVANCEMENT'

Reschedule mode to apply. Must be ADVANCEMENT.

remove_interest_from_currentboolean

Whether interest should be removed when an installment is advanced.

interest_removal_end_datestring date

Cutoff date used for interest recalculation when calculator is PRESENT_VALUE. Reflects the value passed in the request. null if not passed. Format = yyyy-mm-dd.

Example request

{
  "condition": "MULTIPLE_CONTRACTS",
  "tracking_id": "3ea22692-a209-11eb-89a2-f73e179dcbc2",
  "calculator": "PRESENT_VALUE",
  "reschedule": "ADVANCEMENT",
  "interest_removal_end_date": "2021-04-14",
  "contracts": [
    {
      "authorization_id": 12345,
      "calculator": "PRESENT_VALUE",
      "reschedule": "ADVANCEMENT",
      "contract_condition": "ALL_INSTALLMENTS",
      "number_of_installments": 3
    }
  ]
}

Response

Accepted

idinteger

Advancement ID

condition'MULTIPLE_CONTRACTS' | 'ALL_CONTRACTS'

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

tracking_idstring

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.

calculator'PRESENT_VALUE' | 'REMOVE_ALL_INTEREST' | 'NONE'

Type of calculation to apply. Default is NONE.

reschedule'ADVANCEMENT'

Reschedule mode to apply. Must be ADVANCEMENT.

remove_interest_from_currentboolean

Whether interest should be removed when an installment is advanced.

number_of_installmentsinteger

Number of installments to advance

This field is REQUIRED if contract_condition is set to SPECIFIC_NUMBER_OF_INSTALLMENTS. If contract_condition is set to ALL_CONTRACTS, this field is ignored.

created_atstring date-time

Date/time advancement was created. Format = yyyy-mm-dd:hr:mm:ss.

updated_atstring date-time

Date/time advancement was last updated. Format = yyyy-mm-dd:hr:mm:ss.

cancelled_atstring date-time

Date/time advancement was canceled. Format = yyyy-mm-dd:hr:mm:ss.

error_messagestring

Error message if advancement failed

status'CREATED' | 'PROCESSED' | 'CANCELLED' | 'ERROR' | 'CANCELLATION_ERROR'

Current status of the advancement

Example response

{
  "id": 67854328,
  "condition": "MULTIPLE_CONTRACTS",
  "tracking_id": "3ea22692-a209-11eb-89a2-f73e179dcbc2",
  "calculator": "PRESENT_VALUE",
  "reschedule": "ADVANCEMENT",
  "number_of_installments": 3,
  "created_at": "2021-04-14T12:00:00-03:00",
  "updated_at": "2025-09-01T10:05:00",
  "cancelled_at": "2021-04-14T12:00:00-03:00",
  "contracts": [
    {
      "authorization_id": 12345,
      "number_of_installments": 3,
      "calculator": "PRESENT_VALUE",
      "reschedule": "ADVANCEMENT"
    }
  ],
  "installments": [
    {
      "id": 98457355,
      "new_amount": 99.9,
      "old_amount": 102.9,
      "new_interest_amount": 9.9,
      "old_interest_amount": 11.9,
      "new_statement_id": 1,
      "old_statement_id": 10
    }
  ],
  "error_message": "Operation error",
  "status": "PROCESSED"
}

Changes

No recorded changes to this operation across all 1 revision of this API.