Installment advancements

Get installment advancement

Retrieves an installment advancement by its ID. This endpoint provides enhanced response data including:

Detailed advancement information with status tracking
Contract-specific configurations for MULTIPLE_CONTRACTS mode
Enhanced metadata including creation, update, and cancellation timestamps
Error messages when applicable

The response format differs based on the advancement condition.

ALL_CONTRACTS: Returns root-level calculator, reschedule settings, and no contracts array.
MULTIPLE_CONTRACTS: Returns individual contract configurations in the contracts array.

This endpoint includes additional fields like cancelled_at, error_message, status, and contracts.

get/v2/accounts/{accountId}/installment-advance/{advancementId}

Request

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

Path parameters

accountIdinteger required

Example:6912345

Account ID

advancementIdinteger required

Example:6912345

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

Response

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.