v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB

Simulation

Update simulation config

Update a simulation configuration.

Note: EXTERNAL engine plans (with calculation_url) can only be set via this endpoint — not during creation (POST). Once calculation_url is set, it cannot be changed.

put/v1/simulation/configs/{simulation_config_id}

Path parameters

simulation_config_idstring required

Simulation configuration ID

Request body

descriptionstring required

Simulation configuration description

Example request

{
  "description": "This is my simulation configurations",
  "plans": [
    {
      "id": "customId1",
      "description": "Electronics",
      "engine": "PISMO",
      "calculation_url": "https://api.example.com/calculate",
      "authentication": {
        "authentication_method": "JWT_DEFAULT"
      },
      "calculation_parameters": {
        "fixed": 50,
        "percentage": 1.3,
        "fixed_iof_rate": 0.38,
        "daily_iof_rate": 0.0082,
        "interest_rate": 2.3
      },
      "interest_limitation": {
        "calculation_basis": "PRINCIPAL_AMOUNT",
        "percentage": 3.2
      },
      "down_payment_method": {
        "type": "PERCENTAGE",
        "value": 20
      },
      "installments": [
        6,
        10,
        12
      ],
      "day_count_method": "MONTH_30_YEAR_360",
      "billing_method": "BNPL",
      "frequency": "MONTHLY",
      "installment_parameters": {
        "minimum_installment_value": {
          "type": "FIXED",
          "value": 10
        },
        "number_of_initial_periods_to_skip": {
          "type": "FIXED",
          "value": 1
        }
      },
      "filters": {
        "merchants": [
          "abcdef"
        ],
        "processing_codes": [
          "01",
          "02"
        ],
        "custom_filters": [
          "custom_filter_01",
          "custom_filter_02"
        ]
      }
    }
  ]
}

Response

config_idstring uuid

Embosser configuration/group ID.

You can call Get nominal card embossing info to get a card's embossing group.

You can also call Get org embosser info to get an embossing group's configuration ID.

descriptionstring

Simulation configuration description

Example response

{
  "config_id": "acde070d-8c4c-4f0d-9d8a-162843c10333",
  "description": "This is my simulation configurations",
  "plans": [
    {
      "id": "customId1",
      "description": "Electronics"
    },
    {
      "id": "customId2",
      "description": "Furniture"
    }
  ]
}