Provider availability webhook

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

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": "payment",
	  "payment_method": {
		  "type": "mandate",
		  "mandate_type": "commercial_vrp"
	  }
  },
  "event_id": "502535d9-0d96-453a-af17-210977f69ff2",
  "created": "2024-08-15T08:59:33.9719406+00:00",
  "event_version": "1",
  "type": "provider_healthy",
  "recommended_status": "healthy"
}

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

Field	Subfield	Description
`provider_id`		The ID of the provider. You must enable downtime detection for that provider for us to send any webhooks.
`capability`		An object that indicates what product the event relates to. Currently, these notifications are only for Payments availability changes.
	`type`	The type of the capability involved in the event. Currently, this value can only be `payments`.
	`payment_method`	An object in which you can see information about the payment methods affected.
	`type`	Indicates the type of payment that the event relates to. Possible values: `bank_transfer` (for Payments availability) and `mandate` (for VRP availability).
	`mandate_type`	Only used if `payment_method` is `mandate` . The only possible value is `commercial_vrp` .
`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` .
`recommended_status`		The status that we recommend assigning to the provider, with possible values of `healthy` or `unhealthy`.

Updated 2 days ago