Get Simulator Status

GET

/api/v1/sandbox-simulator/status

Sandbox Simulator

Get current status of the sandbox transaction simulator

Request

Authorization

API Key

Add parameter in header

X-API-Key

Example:

X-API-Key: ********************

API Key

Add parameter in header

X-Business-ID

Example:

X-Business-ID: ********************

Responses

🟢200

application/json

Default Response

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET '/api/v1/sandbox-simulator/status' \
--header 'X-API-Key: <api-key>' \
--header 'X-Business-ID: <api-key>'

Response Example

{
    "success": true,
    "status": {
        "isRunning": true,
        "activeSimulations": 0,
        "config": {},
        "scheduledTransactions": [
            "string"
        ]
    }
}

Modified at 2026-04-14 01:46:40

Stop the sandbox transaction simulator

Force Simulator Scenario