Open Banking Refresh V2 Provider Completed

open_banking.v2.refresh.provider.completed

This webhook triggers when a refresh task is completed.

Event Message

The table below describes the structure of the event.

Field

Description

Values

account_ids

An array listing all account ids that were updated as part of this task

Array of strings

consent_ids

An array listing all consents that were updated as part of this task

Array of strings

customer_id

The customer this event relates too.

String UUID

event

The event type for this event

open_banking.v2.refresh.provider.completed

has_new_transactions

To describe whether new transactions have been pulled from the relevant ASPSP during the refresh

Boolean

provider

Name of the provider (banking institution)

String

reconnect_required

Indicator as to whether the account needs to be connected again, through SCA authentication.

Boolean

result

The specific result of this task

success or one of Connect API errors

status

The overall status of this task

Completed, Failed

task_id

The task identifier that this event relates too

String UUID

consent_details

An array of objects listing the consent details for consents involved in this refresh.

Array of objects containing fields id - the id of the consent expiration_date - the expiration date of the consent

Examples

{
  "account_ids": [
    "082f6378-0d6b-4e86-8b2d-4fe9562bdd20",
    "27c633ee-988d-4f08-a149-f86257f8d0d9",
    "2c252bbe-3c46-4986-ab7e-66691e906098",
    "4d283655-524f-416f-ad1f-46ea87a39c72",
    "77a79027-00d5-48f9-9a58-d377029befc7",
    "a58d1702-e170-4184-ab55-d96377bb36d0",
    "bde9f97c-b124-4b68-a53f-c3b4547a36ea",
    "bfc1b2a1-047e-4eb0-93c9-8fea39124fa9",
    "c5814a06-4f6d-4e68-9eaf-4263da8d978b",
    "d558d16a-d746-4d11-bd6a-b038f54db392",
    "f1e2a9be-c870-4980-be27-b2fbf4781c15"
  ],
  "consent_ids": [
    "65f4ea18-47f2-4bb3-97c3-a01755df233f"
  ],
  "consent_details": [
		{
    	"id": "65f4ea18-47f2-4bb3-97c3-a01755df233f",
      "expiration_date": "2026-09-30T15:00:00Z"
		}
  ],
  "customer_id": "49d6a33b-7e3e-4052-96cb-04b82fcbdb2f",
  "event": "open_banking.v2.refresh.provider.completed",
  "has_new_transactions": false,
  "provider": "Lloyds",
  "reconnect_required": false,
  "result": "success",
  "status": "Completed",
  "task_id": "030dabd0-7e5d-4b69-afd8-e747f119b049"
}
{
  "account_ids": [
    "082f6378-0d6b-4e86-8b2d-4fe9562bdd20",
    "27c633ee-988d-4f08-a149-f86257f8d0d9",
    "2c252bbe-3c46-4986-ab7e-66691e906098",
    "4d283655-524f-416f-ad1f-46ea87a39c72",
    "77a79027-00d5-48f9-9a58-d377029befc7",
    "a58d1702-e170-4184-ab55-d96377bb36d0",
    "bde9f97c-b124-4b68-a53f-c3b4547a36ea",
    "bfc1b2a1-047e-4eb0-93c9-8fea39124fa9",
    "c5814a06-4f6d-4e68-9eaf-4263da8d978b",
    "d558d16a-d746-4d11-bd6a-b038f54db392",
    "f1e2a9be-c870-4980-be27-b2fbf4781c15"
  ],
  "consent_ids": [
    "65f4ea18-47f2-4bb3-97c3-a01755df233f"
  ],
  "customer_id": "49d6a33b-7e3e-4052-96cb-04b82fcbdb2f",
  "event": "open_banking.v2.refresh.provider.completed",
  "has_new_transactions": false,
  "provider": "Lloyds",
  "reconnect_required": false,
  "result": "provider_failure",
  "status": "Failed",
  "task_id": "030dabd0-7e5d-4b69-afd8-e747f119b049"
}

How and when this event is triggered

Legend

IconDescription
For this webhook to trigger, the process needs to reach this point in the process.

Manual Refresh Using The Initiate Refresh V2 Endpoint

The diagram below describes how the webhook is triggered when using the Initiate Refresh V2 endpoint.

Note that for each refresh v2 task this webhook will be sent for each specific to a provider. This means you will receive this webhook for each provider and additionally an overall webhook covering all providers.