Start the sandbox transaction simulator

POST

/api/v1/sandbox-simulator/start

Sandbox Simulator

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Body Params application/json

Examples

Responses

🟢200OK

application/json

Simulator started

Body

🟠401Unauthorized

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/api/v1/sandbox-simulator/start' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "config": {
        "checkInterval": 30,
        "minProgressTime": 1,
        "maxProgressTime": 10,
        "scenarios": {
            "NORMAL_SUCCESS": 60,
            "PARTIAL_PAYMENT": 12,
            "EXCESS_PAYMENT": 10,
            "FAILED_PAYMENT": 8,
            "NETWORK_DELAY": 4,
            "COMPLIANCE_HOLD": 3
        }
    }
}'

Response Example

200 - sample

{
    "success": true,
    "message": "Sandbox transaction simulator started successfully",
    "status": {
        "isRunning": true,
        "activeSimulations": 0,
        "config": {
            "checkInterval": 30,
            "minProgressTime": 1,
            "maxProgressTime": 10,
            "scenarios": {
                "NORMAL_SUCCESS": 60,
                "PARTIAL_PAYMENT": 12,
                "EXCESS_PAYMENT": 10,
                "FAILED_PAYMENT": 8,
                "NETWORK_DELAY": 4,
                "COMPLIANCE_HOLD": 3
            }
        },
        "scheduledTransactions": []
    }
}

Modified at 2025-09-15 21:23:04

Reset all sandbox data for your business (destructive)

Stop the sandbox transaction simulator