Force execute a specific scenario for a transaction (URL param)

POST

/api/v1/sandbox-simulator/force/{transactionId}

Sandbox Simulator

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

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

Path Params

Body Params application/json

Examples

Responses

🟢200OK

application/json

Scenario executed

Body

🟠400Bad Request

🟠401Unauthorized

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/api/v1/sandbox-simulator/force/' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "scenario": "FAILED_PAYMENT",
    "errorCode": "INSUFFICIENT_FUNDS"
}'

Response Example

200 - sample

{
    "success": true,
    "message": "Scenario FAILED_PAYMENT executed successfully for transaction trxn_456",
    "result": {
        "success": true,
        "scenario": "FAILED_PAYMENT",
        "transactionId": "trxn_456"
    }
}

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

Force execute a specific scenario for a transaction (testing only)

List pending sandbox transactions available for simulation