Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Expand
Table of Contents
minLevel1
maxLevel6
outlinefalse
stylenone
typelist
printabletrue

1. Overview

This page provides a list of event notifications provided by the OFP that will be delivered to TPPs when they are subscribed to a given event and have registered a webhook at which to receive the notification.

The event notifications are classified into types for ease of reference.

2. Event Types

Events are classified by event type, which is an enumerated property defined in the OFP Webhook template. The available values are defined as follows:

  • Resource.Created

  • Resource.Updated

  • Resource.Deleted

Please note that these values are provided for information, and do not indicate that a TPP will be notified of each related event. Supported events are detailed below.

3. Events

3.1. Consent State Update

An event notification will be emitted based on consent state change as described in the consent state model: https://openfinanceuae.atlassian.net/wiki/spaces/standardsv1rc1/pages/121372984/Consent+Setup#4.-Consent-States.

Changes to the state of an existing consent will be communicated using the following arguments:

  • Data: The new value of the updated consent resource.

  • Event resource: The URL of the resource that has been updated.

  • Event type: Resource.Updated

  • The ConsentId value that uniquely identifies the consent that has been updated.

3.2. Payment State Update

An event notification will be emitted based on a payment initiation state change as described in the payments state model: https://openfinanceuae.atlassian.net/wiki/spaces/standardsv1rc1/pages/121375612/Common+Rules+and+Guidelines#GRC-15.12-Payment-Status-Model.

Changes to the state of a payment initiation request will be communicated using the following arguments:

  • Data: The new value of the updated payment initiation resource.

  • Event resource: The URL of the resource that has been updated.

  • Event type: Resource.Updated

  • The ConsentId value that uniquely identifies the consent to which the payment initiation request relates.