Skip to main content

What can you build with the API and webhooks?

Connect Ezus Pay to your own tools, and find out which building block you need.

Written by Ezus team

Ezus Pay covers the whole payment journey on its own, and connects natively to Ezus.

But your agency probably runs on other tools too: an accounting package, an ERP, your website, an internal dashboard, a Slack channel. The public API and webhooks let those tools work with Ezus Pay.

They are two sides of the same connection.

The API: your tools act on Ezus Pay

With the API, one of your tools sends a request to Ezus Pay to read or do something:

  • create a booking and a payment link from your own CRM, then send the checkout link to your traveler

  • list the payments received on a booking, or across your agency

  • check a payment's status, its payer and how much can still be refunded

  • refund a payment from your back-office

The API only answers when it is asked. Your tool decides when to call it.

Webhooks: Ezus Pay notifies your tools

With a webhook, it works the other way around. Ezus Pay contacts your tool as soon as something happens. You give Ezus Pay an address (a URL), choose the events you care about, and Ezus Pay sends a message to that address each time one occurs:

  • a traveler paid

  • a payment attempt was declined

  • a payment was refunded

  • a booking is fully paid

Nobody has to check for updates. The information arrives within seconds.

Which one do you need?

You want to…

Use

Create payment links from another tool

API

Be told the moment a traveler pays

Webhook

Send every payment to your accounting tool

Webhook, plus the API for the details

Refund a payment without opening Ezus Pay

API

Post a message in Slack when a booking is fully paid

Webhook

Build a report of all your payments

API

Many integrations use both: a webhook tells your tool that a payment happened, and your tool calls the API to get everything it needs about it.

Common use cases

  • Accounting sync. Every payment received is sent automatically to your accounting software, with the booking reference and the payer's name.

  • Payment links from your CRM. Your team creates the payment link where it already works, and the traveler receives an Ezus Pay checkout link.

  • Real-time alerts. Your sales team gets a notification the moment a deposit comes in, and can confirm the trip right away.

  • Automated follow-ups. When a payment is declined, your tool can remind the traveler, or flag the booking for your team.

  • No-code automations. With tools such as Zapier or Make, you can connect a webhook to hundreds of apps without writing code.

Already using Ezus?

You don't need the API or webhooks to keep Ezus Pay and Ezus in sync: that connection is built in. See Ezus integration for how it works.

The API and webhooks are for everything else: the other tools in your agency.

What you need to get started

  • An administrator account on Ezus Pay. Only administrators can create API keys and webhooks.

  • Someone to build the connection on your side. That can be a developer or your IT provider. For simple automations, a no-code tool such as Zapier or Make is enough.

Everything lives in Settings → Integrations:

  • API Keys: the keys your tools use to call the API

  • Webhooks: the addresses Ezus Pay sends events to (up to 5)

  • Documentation: the full technical reference, with every endpoint, event and code example

Security, built in

  • API keys are shown only once, when they are created. Each key only gets the permissions you choose: for example, a key that can read payments but not refund them.

  • Every webhook is signed. Your tool can check that a message really comes from Ezus Pay before acting on it.

  • You stay in control. You can revoke a key or disable a webhook at any time, and every webhook delivery is logged so you can see exactly what was sent.

Did this answer your question?