Webhooks Overview

Webhooks let your systems receive Payment, Contract, and Batch events from the Xe Pay API in near real time, instead of polling endpoints like GET /v2/contracts on a schedule. Register an HTTPS endpoint once, tell Xe which event types you want to receive, and Xe sends an HTTP POST to that endpoint whenever a matching event happens on your account.

This guide covers the WebhookRegistrations endpoints of the Xe Pay API (v2.0.0) — registering, listing, retrieving, and deleting webhook registrations — plus the event types, payload and delivery behaviour (authentication, retries, duplicates/ordering).

• Base URL:
  • Sandbox: http://pay-api-sandbox.xe.com
  • Production: https://pay-api.xe.com
• Authentication: Bearer token (Authorization: Bearer <access_token>)
• Format: JSON (Content-Type: application/json)