Simulate penalty

Simulate the penalty applied to a specified withdrawal on a given date. The operation is read‑only and does not modify any data.

Use this endpoint to preview penalty fees before making an actual withdrawal.

The simulation evaluates all penalty rules configured in the product, including:

  • Early withdrawal penalties

  • Grace period penalties

  • Tiered interest forfeiture penalties

  • Withdrawal fees

  • Subsequent withdrawal penalties

Notes:

  • A withdrawal date inside the cool‑off period results in no penalties
  • If withdrawal_amount is omitted, the Pismo platform fetches the current book balance from Get transaction banking account balance.
  • If withdrawal_amount is provided, the balance cannot exceed the current book balance.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

Account ID

Body Params
number

The amount the customer intends to withdraw. When omitted, the system fetches the current book balance from Bank Statements API. When provided, it must not exceed the current book balance.

date-time
required

Simulated withdrawal date in ISO 8601 format.

Headers
string
required

Account token. Token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a 401 Unauthorized error.

Responses

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