Testing Webhooks

Available ONLY in Sandbox

POST Request to {Endpoint}/merchant/testWebhook

Use this endpoint to simulate webhooks. Once enrolled in receiving webhooks, you can configure the request body to simulate either a successful or failure (refund) notification.

Header Configuration

Header Parameter	Type
apiKey	String	API key provided by Support
content-type	String	application/json

Body Configuration

Parameter	Type	Details
merchantUserID	String	Merchant username/ID. Same as used in step 1.
success	boolean	Set to true for simulating successful order notifications. Set to false for simulating unsuccessful order notifications.

If the request is successful, meaning that you are properly enrolled in receiving webhooks, a successful response (status 200) will mean that a webhook notification was sent to your endpoint(s).

{
    "success": true
}

If you are not actively enrolled in receiving webhooks, you will receive a request such as the following:

{
    "success": false,
    "error": "Merchant is not enrolled in webhooks. Contact support to enroll."
}