Webhooks allow your application to receive real-time updates when events occur in the system—without needing to continuously poll APIs.

Instead of making repeated API calls (pull), webhooks deliver event data directly to your system (push), making integrations more efficient, scalable, and responsive.

Common use cases include:

Transaction declines or approvals
Settlement updates
Card lifecycle events

How Webhooks Work

Webhooks follow a simple event-driven flow:

Subscribe to Events Register the events you want to receive and provide a secure HTTPS endpoint
Event Occurs An event is triggered in the system (e.g., transaction declined)
Webhook Sent A JSON payload is delivered via HTTP POST to your endpoint
Process & Acknowledge Your system validates and processes the event

Set Up a Webhook Subscription

Follow these steps to configure webhook notifications:

1. Discover Available Events

Before subscribing, review the list of supported events listed on Webhook Events page.

This helps you identify which events are relevant to your use case.

2. Create a Subscription

Use the POST /v1/customer/id/{id}/webhookSubscription API endpoint to register a webhook by providing following key parameters:

Field	Description
`name`	Name of the webhook subscription
`url`	HTTPS endpoint where events will be delivered
`subscribedEventType`	List of events to subscribe to.

You can subscribe to multiple event types across customers, accounts, transactions, and cards in a single webhook.

3. Retrieve Subscription Details

After creating a webhook, use the GET /v1/customer/id/{id}/webhookSubscription/id/{id} API endpoint, to verify its configuration:

Confirm subscribed events
Validate endpoint configuration
Check current status

4. Enable or Disable a Subscription

Control whether your webhook actively receives events:

Enable Webhook POST /v1/customer/id/{id}/webhookSubscription/id/{id}/enable
Disable Webhook POST /v1/customer/id/{id}/webhookSubscription/id/{id}/disable

This is useful for:

Temporarily pausing event delivery
Testing new configurations safely

How to Think About Webhook Setup

Create → Configure → Enable
One webhook can handle multiple event types
Use enable/disable to control event flow without deleting configuration