Sign in

v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB
Penalty

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.
post/v1/deposits/accounts/{accountId}/penalty-simulation

Path parameters

accountIdinteger required

Account ID

Headers

AuthorizationTokenstring required

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

Request body

withdrawal_amountnumber

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.

withdrawal_datestring date-time required

Simulated withdrawal date in ISO 8601 format.

Example request

{
  "withdrawal_amount": 5000,
  "withdrawal_date": "2026-06-15T00:00:00Z"
}

Response

Simulation completed successfully

withdrawal_amountnumber

The withdrawal amount used in the simulation (equals book_balance when omitted in request)

withdrawal_datestring date-time

The withdrawal date used in the simulation in ISO 8601 format.

penalty_amountnumber

The total penalty amount applied to the withdrawal, combining all relevant penalty rules.

currencystring

The currency in ISO 4217 alphabetic format, omitted if no penalty applies.

gross_amountnumber

The gross amount of the deposit account, calculated as the sum of the total balance without interest plus the total interest earned. Always present; 0 when no total record exists.

interest_earned_amountnumber

The total interest earned (paid/capitalized) on the account. Always present; 0 when no total record exists.

net_amountnumber

The net amount after deducting penalties from the gross amount: gross_amount - penalty_amount.

simulation_timestampstring date-time

The date and time of the simulation, formatted according to ISO 8601.

Example response

{
  "withdrawal_amount": 40667.17,
  "withdrawal_date": "2026-12-15T00:00:00Z",
  "penalty_rule_applied": [
    {
      "type": "percentage",
      "value": 2.5,
      "description": "Early withdrawal after opening penalty"
    }
  ],
  "penalty_amount": 231.75,
  "penalty_breakdown": {
    "fixed_amount": 50,
    "percentage_amount": 75.5
  },
  "currency": "BRL",
  "gross_amount": 41329.34,
  "interest_earned_amount": 667.17,
  "net_amount": 41097.59,
  "simulation_timestamp": "2026-06-19T19:22:55Z"
}