Version 1.0 Pilot

Notifications API

Bank of England

Notifications are messages generated for the Participant organisation to inform that an event has occurred in RTGS. The Bank of England RTGS Notifications API enables an organisation to Retrieve a list of notifications they are authorised to for up to past 30 days.

Notification API

Below are the list of attributes that are retrieved for each Notification. To view or update your notification preferences refer to Participants API for further details

notification attributes

There are two notification categories:

  1. Non-Task Notifications: These are triggered when
    1. a Window is opened or closed in RTGS,
    2. a transaction queue is blocked or unblocked in RTGS,
    3. an Account Report fails in RTGS or
    4. a Target Average Balance (TAB) Boundary has breached in RTGS
  2. Task Notifications: These are triggered when
    1. a task has changed status in RTGS (e.g., when a Multi Step Review request has been approved or rejected). Note: These are received via the participant UI only

The type of non-task Notification that can be retrieved using Notifications API are:

notification codes

Filter Values:

The Notifications API has various fields thats have a predefined set of values i.e. Participant ID, Inserted At, Notification Type Code. To retrieve the possible values of all these fields Participants can use the Filters API Get Resource by passing the relevant Resource Name of the field. For detailed information around fields thats have a predefined set of values across all RTGS API please refer to the following page Filter Values API.

Notification API Use Cases & Benefits

  • Ability to automate the Notification process
  • Near real-time management of RTGS events
  • Fuels innovation
  • Promotes automation
  • Reduction of manual effort
  • Cost saving
  • Integrated user experience

Supported Developer Toolkit:

Bank of England RTGS APIs will be supported by Swift Microgateway and Swift SDK.Both solutions, provided by Swift, offer access to the APIs. Bank of England hosts a reference implementation based on Swift Microgateway and we can help you start with the API connectivity using this option.

If you are already a user of any of these solutions, just download the API Specification and follow the Swift recommended steps to import it into your implementation.