List scenarios

​

Sandbox only — not available in Production.

Returns all pre-defined scenarios available. Use the scenario IDs when calling the run scenario endpoint.

Responses
  • application/json
  • 401

    Unauthorized

  • 404

    Simulator not available in this environment. These endpoints are not registered in production.

Request Example for get/simulate/scenarios
Shell Curl
curl 'https://{prefix}.api.sandbox.checkout.com/simulate/scenarios' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

[
  {
    "id": "go_active",
    "name": "Go Active",
    "description": "Transitions the entity to active status.",
    "action": "set_status",
    "status": "active",
    "requirements_due": [
      "individual.identification.document"
    ]
  }
]

Scenarios listed successfully