Configure callbacks

Configure in the portalCopy Anchor Link

1. Select TEST in the portal's environment switcher.
2. Open Settings → Webhooks and create a webhook.
3. Enter your HTTPS callback URL, for example https://merchant.example.com/callbacks/vantra.
4. Select PAYMENT or ALL, add a description, and enable the endpoint.
5. Open its details to copy the signing secret into your receiver's server-side secret storage.
6. Create a test payment and simulate an outcome in Sandbox.

The portal sends the selected environment with webhook creation. Register separate TEST/LIVE destinations or enforce the expected environment in your receiver. An endpoint must already exist and be enabled when the payment transition occurs; adding it afterwards does not backfill prior events.

URL requirementsCopy Anchor Link

The endpoint must use HTTPS on port 443 and resolve exclusively to public IP addresses. Credentials and fragments in the URL are rejected. Delivery does not follow redirects. For local development, provide a public HTTPS forwarding URL for your local receiver rather than localhost or a private IP.

Management API alternativeCopy Anchor Link

The signed-in merchant management API uses a Bearer token, not payment HMAC credentials:

POST /api/v1/webhooks
Authorization: Bearer YOUR_MERCHANT_SESSION_TOKEN
Content-Type: application/json

{
  "environment": "TEST",
  "webhookUrl": "https://merchant.example.com/callbacks/vantra",
  "type": "PAYMENT",
  "enabled": true,
  "description": "Test payment events"
}

The creation response includes data.signingSecret. Listing uses GET /api/v1/webhooks?environment=TEST; details use GET /api/v1/webhooks/{id}. Update with PATCH and disable using { "enabled": false }. Deleting uses DELETE and disables the destination. Do not put session tokens in public documentation or browser checkout integrations.

The callback URL is configured on the webhook, not in the payment creation body. Card switchBackURL is only the customer's browser return destination.