Provider availability webhook

Use the information in this webhook to decide whether to display a bank as healthy at provider selection.

📘
This feature is in private beta
This feature is currently available to a limited number of clients. The content of the webhook that you receive is subject to change -- we'll contact you if it does.
To join the beta for this feature, contact us.

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.

You can use this information to inform how you present a given bank at provider selection. For example, if a bank is unhealthy you may choose to 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.

{
  "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"
}

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

Field	Description
`provider_id`	The ID of the provider. You must enable downtime detection for that provider for us to send any webhooks.
`capability_type`	The type of service that has changed its status. Currently, this value can only be `payments.bank_transfer`.
`event_id`	A unique `id` for the webhook sent.
`created`	Timestamp for when the webhook was created.
`event_version`	The version of the event type.
`type`	The type of the sent webhook. Can be `provider_healthy` or `provider_unhealthy` .

Updated 5 days ago

📘This feature is in private beta

📘
This feature is in private beta