---
title: "Create simulation"
method: POST
path: "/v1/simulations"
tags: ["Simulation"]
---

# Create simulation

`POST /v1/simulations`

Create a simulation. 

Prior to calling this endpoint to create a simulation, you must create a simulation configuration via the [Create simulation config](https://developers.pismo.io/pismo-docs/reference/simulationconfigs) endpoint.

Refer to the [Simulation service](https://developers.pismo.io/pismo-docs/docs/simulation-service) guide for additional information.

## Request body

- SimulationRequest — Request
  - `amount` number, required — Total simulation amount
  - `authorization_mode` 'CREDIT' | 'DEBIT', required — Requested simulation authorization mode. Credit cards can operate only in `CREDIT` mode. Debit cards from savings or checking accounts can operate only in `DEBIT` mode. Combo and multi-application cards can operate in both modes. **REQUIRED** for simulation requests, where message type indicator (MTI) is `0100` or `0120`.
  - `card` object — Information related to the card used to perform this simulation. **REQUIRED** if `document_number` is not present.
    - `pan` string — Primary account number of the card being used for simulation. **REQUIRED** if `document_number` is not present.
  - `custom_filters` string[] — Custom filters to be used in the simulation
  - `document_number` string — Document number related to the account to be used as the owner of this request. This field should be used in requests simulation based on client document number. **REQUIRED** if card `pan` is not present.
  - `merchants` string[] — Merchant IDs used to filter the simulation
  - `payment_agreement` object — Payment agreement information
    - `original_principal_amount` number — Principal amount in the original contract
    - `applied_interest_amount` number — Applied interest amount in the original contract
    - `down_payment` number — Down payment
  - `plan_ids` string[] — Plan IDs used to filter the simulation
  - `processing_codes` string[] — Procesing codes used to filter the simulation

## Response `200`

OK

- SimulationResponse — Response
  - `account_id` integer — Pismo ID of the account assigned as the owner of this request
  - `program_id` number — Program ID linked to the user account
  - `amount` number — Total simulation amount
  - `simulation` object — Any valid JSON that contains useful simulation information

## Other responses

- `400` — Bad request
- `422` — Unprocessable Entity
- `500` — Internal Server Error

---

[API](https://skmtc.net/pismo/apis/platform-authentication.md) · [All operations](https://skmtc.net/pismo/apis/platform-authentication/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/pismo/platform-authentication/versions/935b62e16de4/schema)