PIpismo
Installment advancements

Get installment advancement (deprecated)

Get an installment advancement by its ID. This is a DEPRECATED endpoint. Use the non-deprecated Get installment advancement endpoint instead.

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

Request

  • Base URL
    https://sandbox.pismolabs.io/installment-management
  • URL
    https://sandbox.pismolabs.io/installment-management/v1/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

OK

advancement_idinteger

Advancement ID

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.

created_atstring date-time

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

cancelled_atstring date-time

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

accountIdinteger

Account ID

condition'SINGLE_CONTRACT' | 'ALL_CONTRACTS'

Installments should be advanced for all the contracts for an account (ALL_CONTRACTS) or for a specific contract (SINGLE_CONTRACT). If condition is set to SINGLE_CONTRACT, then the transaction_id field must be set to the transaction ID of the specific contract.

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

Type of calculation to apply. Default is NONE.

reschedule'ADVANCEMENT'

Reschedule mode to apply. Must be ADVANCEMENT.

number_of_installments_to_advanceinteger

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.

Example response

{
  "advancement_id": 67854328,
  "tracking_id": "3ea22692-a209-11eb-89a2-f73e179dcbc2",
  "created_at": "2021-04-14T12:00:00-03:00",
  "cancelled_at": "2021-04-14T12:00:00-03:00",
  "accountId": 67854328,
  "condition": "SINGLE_CONTRACT",
  "calculator": "PRESENT_VALUE",
  "reschedule": "ADVANCEMENT",
  "number_of_installments_to_advance": 3,
  "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
    }
  ]
}

Changes

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