PIpismo
Statement minimum amount due

Create or update statement minimum amount due

Create statement minimum amount due (MAD) for the current cycle, or update it if it already exists. Using this endpoint bypasses the configured strategy for calculating the MAD. For more information, refer to Minimum amount due calculation.

Notes:

  • Running this endpoint bypasses the configured strategy only for the current cycle. The configured strategy, if it exists, still applies to future statements.
  • The following example demonstrates how the Pismo platform handles the request when you run this endpoint.<br> Suppose the due date for Cycle A is March 10. The next cycle after Cycle A is Cycle B.<br>
    • If the Pismo platform receives the "Create or update statement minimum amount due request" on March 9, it updates the MAD for Cycle A.<br>
    • If it receives the request on March 10, and the platform has not finished closing Cycle A, the endpoint returns an error.<br>Note: This happens even if the platform hasn't started the process of closing Cycle A. The platform doesn't update the MAD for Cycle A on it's cycle closing date.<br>
    • If it receives the request on March 10, and the platform has finished closing Cycle A, it updates the MAD for Cycle B.<br>
    • If it receives the request on March 11, it updates the MAD for the next cycle (Cycle B).<br>
  • To use this endpoint, the Allow overriding the minimum amount due for the current statement program parameter must be set to true. Otherwise, the endpoint generates an error.
post/statements-v2/v1/accounts/{accountId}/minimum-amount-due

Request

  • Base URL
    https://sandbox.pismolabs.io
  • URL
    https://sandbox.pismolabs.io/statements-v2/v1/accounts/{accountId}/minimum-amount-due
  • 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

amount_type'FIXED_AMOUNT' | 'PERCENTAGE' required

Amount type

  • If you set amount_type to FIXED_AMOUNT, then the value you enter for minimum_amount_due should represent that fixed amount.<br>
  • If you set amount_type to PERCENTAGE, then minimum_amount_due should represent a percentage of the current balance. For example, if you set minimum_amount_due to 0.1, then the Pismo platform calculates the MAD as 10% of the current balance.
minimum_amount_duenumber float required

Minimum amount due for the current statement cycle

  • If amount_type is set to FIXED_AMOUNT, then minimum_amount_due represents that fixed amount.<br>
  • If amount_type is set to PERCENTAGE, then minimum_amount_due represents a percentage of the current balance. For example, 0.1 represents 10% of the current balance.

Example request

{
  "amount_type": "FIXED_AMOUNT",
  "minimum_amount_due": 100.07
}

Response

Created

statement_idinteger

Statement ID

amount_type'FIXED_AMOUNT' | 'PERCENTAGE'

Amount type

  • If you set amount_type to FIXED_AMOUNT, then the value you enter for minimum_amount_due should represent that fixed amount.<br>
  • If you set amount_type to PERCENTAGE, then minimum_amount_due should represent a percentage of the current balance. For example, if you set minimum_amount_due to 0.1, then the Pismo platform calculates the MAD as 10% of the current balance.
cycleinteger

Statement cycle

current_balancenumber

Total amount you owe on the account right now. It updates as transactions post, so it can change many times during a billing cycle. current_balance = previous_balance + debits - credits.

minimum_amount_duenumber float

Minimum amount due for the current statement cycle

  • If amount_type is set to FIXED_AMOUNT, then minimum_amount_due represents that fixed amount.<br>
  • If amount_type is set to PERCENTAGE, then minimum_amount_due represents a percentage of the current balance. For example, 0.1 represents 10% of the current balance.
enabledboolean

Is statement minimum amount due enabled?

Example response

{
  "statement_id": 9497889,
  "amount_type": "FIXED_AMOUNT",
  "cycle": 7,
  "current_balance": 99.99,
  "minimum_amount_due": 100.07,
  "enabled": true
}

Changes

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