Deliver a test webhook to a URL

POST

/api/v1/sandbox/test-webhook

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

Delivery result

Body

🟠400Bad Request

🟠401Unauthorized

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/api/v1/sandbox/test-webhook' \
--header 'x-business-id;' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "webhookUrl": "https://merchant.example/webhook",
    "eventType": "transaction.completed",
    "testData": {
        "foo": "bar"
    }
}'

Response Example

200 - sample

{
    "success": true,
    "message": "Webhook delivered",
    "delivery": {
        "url": "https://merchant.example/webhook",
        "status": 200,
        "statusText": "OK",
        "response": "ok"
    }
}

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

Simulate sandbox error scenarios for a transaction

List available sandbox error scenarios