Simulate sandbox error scenarios for a transaction

POST

/api/v1/sandbox/simulate-error

Sandbox

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

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

Header Params

Body Params application/json

Examples

Responses

🟢200OK

application/json

Simulation result

Body

🟠400Bad Request

🟠401Unauthorized

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/api/v1/sandbox/simulate-error' \
--header 'x-business-id;' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "transactionId": "trxn_123",
    "scenarioType": "PAYMENT_FAILED"
}'

Response Example

200 - sample

{
    "success": true,
    "message": "Error scenario 'PAYMENT_FAILED' simulated successfully",
    "transaction": {
        "id": "trxn_123",
        "status": "FAILED",
        "payoutStatus": "PENDING",
        "failureReason": "Insufficient confirmations",
        "errorCode": "TXN_CONF_LOW"
    },
    "webhook": {
        "url": "https://merchant.example/webhook",
        "status": 200,
        "statusText": "OK",
        "response": "{\"received\":true}"
    }
}

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

List supported currencies

Deliver a test webhook to a URL