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

# Create simulation

`POST /v1/simulations`

## Request

- Base URL: `https://sandbox.pismolabs.io/payment-methods-admin`
- URL: `https://sandbox.pismolabs.io/payment-methods-admin/v1/simulations`
- Auth: none declared

Create a simulation. 

Prior to calling this endpoint to create a simulation, you must create a simulation configuration via the [Create simulation config](ref:simulationconfigs) endpoint.

Refer to the [Simulation service](doc:simulation-service) guide for additional information.

## Request body

- SimulationRequest: Request. Provide `card.pan`, `document_number`, or `plan_ids`. When only `plan_ids` is provided, the simulation runs as a prospect flow without account or program lookup.
  - `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.
    - `pan` string: Primary account number (PAN) of the card being used for simulation. Provide this field when simulating from an existing card.
  - `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. Provide this field for simulations based on a client document number.
  - `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. **REQUIRED** when neither `card.pan` nor `document_number` is provided.
  - `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. Omitted for prospect simulations.
  - `program_id` number: Program ID linked to the user account. Omitted for prospect simulations.
  - `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.dev/pismo/apis/core-platform-payment-methods-admin.md) - [All operations](https://skmtc.dev/pismo/apis/core-platform-payment-methods-admin/llms.txt) - [OpenAPI document](https://skmtc.dev/pismo/apis/core-platform-payment-methods-admin/revisions/68a26b084986?raw)