Provider availability webhook

We continually monitor the health of the providers that we are connected to.

You can use this information to inform how you present a given bank at provider selection. For example, if a bank is unhealthy, we recommend that you temporarily disallow your users from selecting it. If you are using one of our UIs, for example the web SDK, this functionality is present by default.

If you have preselected a provider that is unhealthy, your user is presented with a screen indicating that the bank is unavailable.

If you have payment retries enabled, they are then given the option to select another bank or return to your page.

When a provider changes status (moving from healthy to unhealthy, or unhealthy to healthy), you receive a webhook letting you know this along with other information about the event.

Contact us to enable this feature for the banks you want to receive these notifications for.

{
  "provider_id": "xs2a-s-pankki-fi",
  "capability_type": "payments.bank_transfer",
  "updated_at": "2024-08-15T08:59:33.9719406Z",
  "event_id": "502535d9-0d96-453a-af17-210977f69ff2",
  "event_version": 1,
  "type": "provider_healthy"
}

{
  "provider_id": "xs2a-s-pankki-fi",
  "capability_type": "payments.bank_transfer",
  "updated_at": "2024-08-15T08:59:33.9719406Z",
  "event_id": "502535d9-0d96-453a-af17-210977f69ff2",
  "event_version": 1,
  "type": "provider_unhealthy"
}

These are the fields you receive in each webhook, and the information they correspond to.