Skip to main content
GET
/
sandbox
/
scenarios
List available simulation scenarios
curl --request GET \
  --url https://api.platform.dakota.xyz/sandbox/scenarios \
  --header 'x-api-key: <api-key>'
{
  "scenarios": [
    {
      "name": "success_immediate",
      "description": "Simulates an immediate successful settlement callback sequence.",
      "valid_for": [
        "ach_inbound",
        "wire_inbound"
      ],
      "stateful": false,
      "example_webhook_sequence": [
        "transaction.created",
        "transaction.completed"
      ]
    }
  ]
}

Authorizations

x-api-key
string
header
required

Response

Catalog of available scenarios

scenarios
object[]
required