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:

  • withdrawal_date must be the current date (UTC); past and future dates are rejected.
  • A withdrawal date inside the cool‑off period, or an inactive penalty record, returns penalty_amount: 0 and net_amount = gross_amount, with penalty_rule_applied, penalty_breakdown and currency omitted.
  • The account balance comes from Get transaction banking account balance: book_balance for DEPOSIT_BASIS products, or the balance_type balance for BALANCE_BASIS products. When withdrawal_amount is omitted, the account balance is used as the withdrawal amount. withdrawal_amount cannot exceed the account balance.
  • gross_amount reflects the account's resolved balance until a capitalization total record becomes available.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length ≤ 60

Account ID. Accepts either the Pismo account_id or your external_account_id. Send the same ID used to generate the access token.

Body Params
date-time
required

The simulated withdrawal date in ISO 8601 format. The value must match the current UTC date. Requests that use a past date return error EIBACC0294, while requests that use a future date return error EIBACC0407.

float

The amount to withdraw. When omitted, the account balance is used: book_balance for DEPOSIT_BASIS products, or the balance_type balance for BALANCE_BASIS products. The amount provided cannot exceed that balance.

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