PIpismo
Advancements

Create installment advancement (no cancellation event) (deprecated)

Create an installment advancement. This is a DEPRECATED endpoint. Use the non-deprecated Create installment advancement endpoint instead.<br> An installment advancement is a transfer of one or more installments from future cycles to the present cycle. For more information, refer to Manage installments on the customer statement.

This endpont generates an Installment advanced event.

Note: This endpoint requires an account token - an access token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a 401 Unauthorized message.

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

Request

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

Path parameters

accountIdinteger required
Example:101

Account ID

Headers

Authorizationstring required

Account token, not a regular access token. Account tokens are encoded with an account ID. Tokens can expire quickly, which can result in an Unauthorized message.

Request body

transaction_idinteger

Installment advanced transaction ID. REQUIRED when mode = single. This parameter can be from any transaction related to the contract.

mode'all' | 'single'

Installment advanced mode. If all, all future account installments are advanced (and transaction_id is ignored).

installments_to_advanceinteger

Number of installments to advance. Only considered when mode = single. If not passed, all installments are advanced.

remove_interest_from_currentboolean

Are the current interests removed from the installment in the current statement (true) or not (false)? This field is considered when mode = all. Note that all interest from future installments are always removed when they are advanced. If mode = single, it is not possible to remove interest from the installment in the current statement. Default is false.

Example request

{
  "transaction_id": 10101,
  "mode": "all",
  "installments_to_advance": 12
}

Response

Ok

idinteger

Installments advanced ID

status'processed' | 'cancelled' | 'pending' | 'error'

Installments advanced status

transaction_idinteger

Transaction ID

created_atstring

Creation date/time. Format = yyyy-mm-ddThh:mm:ss.

cancelled_atstring

Cancellation date/time. Format = yyyy-mm-ddThh:mm:ss.

Example response

{
  "id": 101010,
  "status": "processed",
  "transaction_id": 77489,
  "transactions": [
    {
      "id": 101010,
      "statement_id": 9497889,
      "amount": 150,
      "interest_amount": 12.35,
      "adjusted_amount": 450
    }
  ],
  "created_at": "2021-08-10T00:00:00",
  "cancelled_at": "2021-08-20T00:00:00"
}

Changes

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