Advancements

Get installment advancement (no cancellation event) (deprecated)

Get an installments advancement by account ID and installments advancement ID. This is a DEPRECATED endpoint. Use the non-deprecated Get installment advancement endpoint instead.<br>

This endpont generates an Installment advanced event.

Notes:

  • Cancelling an installment advancement created with this endpoint does not generate a cancellation event. Pismo recommends that you use the most advanced version of the installment advancement endpoints instead: <br>Create installment advancement <br>Get installment advancement <br>Cancel installment advancement
  • 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.
get/statements/v2/accounts/{accountId}/installment-advance/{id}

Request

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

Path parameters

accountIdinteger required
Example:101

Account ID

idstring required
Example:4101

Payment agreement 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.

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.