This section describes how to configure the webhooks.

Webhook Types

Basic use case - getting status of the payment

• payment.statusChange - This hook is called, when payment’s status changes (e.g. processing, successful/failed, money received etc.). Implementation of this webhook type would be sufficient for most of the clients.

For special use cases

• order.statusChange - This hook is called, when order’s state changes. This hook is useful, if your order entity can aggregate multiple payments (applicable only when API v2 is used).

• payment.statusCheck - This hook is called, when Everifin paygate wants to check the state of the payment entity in client’s system. This is used to check if the payment originally initiated by the client should be really executed.

Defining webhooks

Webhook management is provided by Everifin Back Office (only available for users with Client role). Client can set up hooks, as well as hook secrets (see Webhooks Security).

These steps are required to set up a hook:

1. Choose hook type.

2. Setup custom hook validity (optional). We support multiple hooks of same type. This might be useful in case of migrations between hook consumers.
   When hook is created without changing the validity settings, hook is valid from the moment of creation. End of validity is not set by default.

3. Choose valid hook URL. The URL must satisfy these requirements, mainly because of security reasons:

   • HTTPS protocol must be used

   • custom port must not be specified (defaults to HTTPS 443 port)

   • hostname must be publicly available top-level domain