Statement

Get minimum payout calculation memory

Get a minimum payment calculation memory for a specific account statement. The minimum payout calculation memory is the information used in the calculation of the minimum amount due (MAD) and the results of that calculation.

This this information in a JSON file. For example, in the following sample result, the default calculation strategy was used, the resulting MAD was 150, and two transactions were used in the calculation. { "id": 1, "created_at": "2021-08-10T00:00:00", "org_id": "TN-e7091464-aa1e-4c20-8c68-1e4c57741234", "account_id": 1010, "statement_id": 1, "calc_strategy": "DEFAULT", "minimum_amount": 150, "calculation_memory": [ { "type": "PREVIOUS_STATEMENT_TRANSACTION", "cycle": 4, "amount": 43.74, "balance": 43.74, "percentage": 1.0,
"transaction_id": 77489 }, { "type": "CURRENT_STATEMENT_TRANSACTION", "cycle": 5, "amount": 3.65, "balance": 3.65, "percentage": 1.0, "transaction_id": 77542 } ] }

The calc_strategy field has three possible values: DEFAULT, PERCENTAGE_ONLY, and FIXED_PERCENTAGE_WITH_OVERLIMIT_AND_OVERDUE_AMOUNT. These values correspond to the three possible settings for the Minimum payment calculation method program parameter: 0, 1, and 2. That is, DEFAULT = 0, PERCENTAGE_ONLY = 1, and FIXED_PERCENTAGE_WITH_OVERLIMIT_AND_OVERDUE_AMOUNT = 2. For more information, refer to Minimum amount due calculation.

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.

get/statements-v2/v1/accounts/{accountId}/statements/{statementId}/min-payment-memory

Request

  • Base URL
    https://sandbox.pismolabs.io
  • URL
    https://sandbox.pismolabs.io/statements-v2/v1/accounts/{accountId}/statements/{statementId}/min-payment-memory
  • Auth
    HTTP bearer

Path parameters

accountIdinteger required
Example:101

Account ID

statementIdinteger required
Example:101

Statement ID

Response

Ok

idinteger

Minimum payment calculation memory ID

created_atstring

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

org_idstring

Organization ID

account_idinteger

Account ID

statement_idinteger

Statement that closed with this minimum payment.

calc_strategy'DEFAULT' | 'PERCENTAGE_ONLY' | 'FIXED_PERCENTAGE_WITH_OVERLIMIT_AND_OVERDUE_AMOUNT'

Strategy for caculating minimum payment. For more information, refer to <a href="https://developers.pismo.io/pismo-docs/docs/minimum-amount-due-calculation">Minimum amount due calculation</a>.

minimum_amountnumber float

Minimum payment calculated amount

Example response

{
  "id": 1,
  "created_at": "2021-08-10T00:00:00",
  "org_id": "TN-e7091464-cd1e-4c20-8c68-1e4c5774d972",
  "account_id": 1010,
  "statement_id": 1,
  "calc_strategy": "DEFAULT",
  "minimum_amount": 150,
  "calculation_memory": [
    {
      "type": "PREVIOUS_STATEMENT_TRANSACTION",
      "transaction_id": 77489,
      "balance": 100,
      "percentage": 10,
      "amount": 150,
      "cycle": 1
    }
  ]
}

Changes

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