---
updatedAt: 2026-03-25T12:33:35.000Z
---

Fetch the complete documentation index at: https://developers.pismo.io/pismo-docs/llms.txt. Use this file to discover all available pages before exploring further.

# Create simulation

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.


# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Core platform - Payment methods admin",
    "version": "beta",
    "description": "API to handle administrative operations for payment methods.",
    "contact": {
      "name": "API Support",
      "email": "support@pismo.io",
      "url": "https://developers.pismo.io/support/"
    },
    "license": {
      "name": "Copyrigth Pismo",
      "url": "https://developers.pismo.io/licenses/"
    }
  },
  "servers": [
    {
      "url": "https://sandbox.pismolabs.io/payment-methods-admin",
      "description": "Sandbox API server for testing"
    }
  ],
  "tags": [
    {
      "name": "Simulation",
      "description": "Endpoints to handle administrative operations for simulations."
    }
  ],
  "components": {
    "schemas": {
      "UnexpectedError": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string",
            "description": "Error code",
            "example": "DO0001"
          },
          "message": {
            "type": "string",
            "description": "Error description",
            "example": "An unexpected error happened."
          },
          "violations": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "code": {
                  "type": "string",
                  "description": "Violation error code",
                  "example": "AC000"
                },
                "message": {
                  "type": "string",
                  "description": "Violation error description",
                  "example": "An unexpected error has occurred"
                }
              }
            }
          }
        }
      },
      "SimulationRequest": {
        "description": "Request",
        "required": [
          "amount",
          "authorization_mode"
        ],
        "properties": {
          "amount": {
            "type": "number",
            "description": "Total simulation amount",
            "example": 100
          },
          "authorization_mode": {
            "type": "string",
            "description": "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`.\n",
            "enum": [
              "CREDIT",
              "DEBIT"
            ]
          },
          "card": {
            "type": "object",
            "description": "Information related to the card used to perform this simulation. **REQUIRED** if `document_number` is not present.",
            "properties": {
              "pan": {
                "type": "string",
                "description": "Primary account number of the card being used for simulation. **REQUIRED** if `document_number` is not present.",
                "example": "5555550000000001"
              }
            }
          },
          "custom_filters": {
            "type": "array",
            "description": "Custom filters to be used in the simulation",
            "items": {
              "type": "string",
              "example": "custom filter1"
            },
            "example": [
              "custom filter1",
              "custom filter2",
              "custom filter3"
            ]
          },
          "document_number": {
            "type": "string",
            "description": "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.",
            "example": "39947739977"
          },
          "merchants": {
            "type": "array",
            "description": "Merchant IDs used to filter the simulation",
            "items": {
              "type": "string",
              "example": "MERCH01"
            },
            "example": [
              "MERCH01",
              "MERCH02",
              "MERCH03"
            ]
          },
          "payment_agreement": {
            "description": "Payment agreement information",
            "properties": {
              "original_principal_amount": {
                "description": "Principal amount in the original contract",
                "type": "number",
                "example": 80
              },
              "applied_interest_amount": {
                "description": "Applied interest amount in the original contract",
                "type": "number",
                "example": 80
              },
              "down_payment": {
                "description": "Down payment",
                "type": "number",
                "example": 50
              }
            }
          },
          "plan_ids": {
            "type": "array",
            "description": "Plan IDs used to filter the simulation",
            "items": {
              "type": "string",
              "example": "000900"
            },
            "example": [
              "000700",
              "000800",
              "000900"
            ]
          },
          "processing_codes": {
            "type": "array",
            "description": "Procesing codes used to filter the simulation",
            "items": {
              "type": "string",
              "example": "000900"
            },
            "example": [
              "000700",
              "000800",
              "000900"
            ]
          }
        }
      },
      "SimulationResponse": {
        "description": "Response",
        "properties": {
          "account_id": {
            "type": "integer",
            "description": "Pismo ID of the account assigned as the owner of this request",
            "example": 123
          },
          "program_id": {
            "type": "number",
            "description": "Program ID linked to the user account",
            "example": 1
          },
          "amount": {
            "type": "number",
            "description": "Total simulation amount",
            "example": 100
          },
          "simulation": {
            "type": "object",
            "description": "Any valid JSON that contains useful simulation information"
          }
        }
      }
    }
  },
  "paths": {
    "/v1/simulations": {
      "post": {
        "operationId": "post-v1-simulation",
        "summary": "Create simulation",
        "description": "Create a simulation. \n\nPrior 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.\n\nRefer to the [Simulation service](https://developers.pismo.io/pismo-docs/docs/simulation-service) guide for additional information.\n",
        "tags": [
          "Simulation"
        ],
        "requestBody": {
          "description": "Create simulation",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SimulationRequest"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SimulationResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UnexpectedError"
                },
                "examples": {
                  "Invalid payload": {
                    "value": {
                      "code": "DO0002",
                      "message": "Invalid Request.",
                      "violations": [
                        {
                          "code": "field",
                          "message": "required"
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable Entity",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UnexpectedError"
                },
                "examples": {
                  "Invalid payload": {
                    "value": {
                      "code": "SI001",
                      "message": "An unexpected error happened.",
                      "violations": [
                        {
                          "code": "SI003",
                          "message": "Card doesn't have authorization mode created."
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal Server Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UnexpectedError"
                }
              }
            }
          }
        }
      }
    }
  }
}
```