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.
    Suppose the due date for Cycle A is March 10. The next cycle after Cycle A is Cycle B.
    • If the Pismo platform receives the "Create or update statement minimum amount due request" on March 9, it updates the MAD for Cycle A.
    • If it receives the request on March 10, and the platform has not finished closing Cycle A, the endpoint returns an error.
      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.
    • If it receives the request on March 10, and the platform has finished closing Cycle A, it updates the MAD for Cycle B.
    • If it receives the request on March 11, it updates the MAD for the next cycle (Cycle B).
  • 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.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int64
required
≥ 1

Account ID

Body Params
string
enum
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.
  • 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.
Allowed:
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.
  • 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.
Responses

Language
Credentials
Bearer
Account JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json