I am developing for the

market, looking for the

API Documentation.

Home

>

API Products

>

United Kingdom - Event Notification PSD2 API Documentation

Event Notification PSD2

Summary

The Event Notification API specification allows a TPP to register callback URL with CPB through a secure interface.

The sandbox provides synthetic data to enable a TPP to explore the API and perform preliminary functional testing on a simulated environment. The calls to the API will be validated for correctness and compliance with the API specification to help the TPP uncover issues early when integrating with the API.

Below are some sample test data and unique identifiers that can be used for invoking the APIs and for recreating specific scenarios for validation and testing by the TPP. Some of the characteristics of the sandbox are listed below:

  • The sandbox implements an OAuth 2.0 based Authentication and Authorization flow. In addition to using the API Playground to invoke the APIs, the API keys retrieved while registering an application can be used for calling the APIs from any REST client, such as curl, Postman, SoapUI, or programmatically through REST calls using access tokens retrieved either through a Client Credential or Authorization Code grant types depending on the API being invoked.
  • As the sandbox is open to both TPPs and the general public, the following validations will be deferred to the integration environments: verification of TPP identity, SSA, EIDAS, QSEAL, QWAC certificates, mutual TLS. These validations will be available in the fully functional market integrated interfaces with valid Competent Authority issued certificates.
  • This API allows the registration and de-registration of callback URLs and the delivery of notifications is deferred to the fully functional integration environments.

The Event Notification PSD2 API uses the client_credentials grant type, for authorization details CLICK HERE

Want to try this API out on our Playground?

Go play now
Endpoints on this page
post /open-banking/v3.1/callback-urls Register callback URL
get /open-banking/v3.1/callback-urls Retrieve callback URL details
put /open-banking/v3.1/callback-urls/{CallbackUrlId} Update callback URL details
delete /open-banking/v3.1/callback-urls/{CallbackUrlId} Delete callback URL

Register callback URL

post /open-banking/v3.1/callback-urls
Description

Request CPB to create a callback-url resource. This can be done by making a call to POST that allows TPP to register a callback URL for CPB to send event notifications to TPP. CPB responds with 409 error if the callback-url is already exists for that TPP.

Body Parameters
OBCallbackUrl1Param
required
Create an Callback URI
Show schema
Header Parameters
Accept
string required
application/json
x-fapi-financial-id
string required
The unique id of CPB to which the request is issued. The unique id will be issued by OB.
x-fapi-interaction-id
string Optional
An RFC4122 UID used as a correlation id.
Authorization
string required
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
x-jws-signature
string required
Header containing a detached JWS signature of the body of the payload.
client_id
string required
Client Id generated during application registration
  • cURL
  • Ruby
  • Python
  • PHP
  • Java
  • Node
  • Go
  • Swift

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Responses
201

This operation returns no content.
400

This operation returns no content.
401

This operation returns no content.
403

This operation returns no content.
405

This operation returns no content.
406

This operation returns no content.
415

This operation returns no content.
429

This operation returns no content.
500

This operation returns no content.

Retrieve callback URL details

get /open-banking/v3.1/callback-urls
Description

Used by the TPP to retrieve the callback URL resource for the given CallbackUrId.

Header Parameters
Accept
string required
application/json
x-fapi-financial-id
string required
The unique id of CPB to which the request is issued. The unique id will be issued by OB.
x-fapi-interaction-id
string Optional
An RFC4122 UID used as a correlation id.
Authorization
string required
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
client_id
string required
Client Id generated during application registration
  • cURL
  • Ruby
  • Python
  • PHP
  • Java
  • Node
  • Go
  • Swift

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Responses
200

This operation returns no content.
400

This operation returns no content.
401

This operation returns no content.
403

This operation returns no content.
404

This operation returns no content.
405

This operation returns no content.
406

This operation returns no content.
429

This operation returns no content.
500

This operation returns no content.

Update callback URL details

put /open-banking/v3.1/callback-urls/{CallbackUrlId}
Description

Used by the TPP to update a callback-url resource for a given CallbackUrlId.

Path Parameters
CallbackUrlId
string required
CallbackUrlId
Body Parameters
OBCallbackUrl1Param
required
Create an Callback URI
Show schema
Header Parameters
Accept
string required
application/json
x-fapi-financial-id
string required
The unique id of CPB to which the request is issued. The unique id will be issued by OB.
x-fapi-interaction-id
string Optional
An RFC4122 UID used as a correlation id.
Authorization
string required
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
x-jws-signature
string required
Header containing a detached JWS signature of the body of the payload.
client_id
string required
Client Id generated during application registration
  • cURL
  • Ruby
  • Python
  • PHP
  • Java
  • Node
  • Go
  • Swift

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Responses
200

This operation returns no content.
400

This operation returns no content.
401

This operation returns no content.
403

This operation returns no content.
404

This operation returns no content.
405

This operation returns no content.
406

This operation returns no content.
415

This operation returns no content.
429

This operation returns no content.
500

This operation returns no content.

Delete callback URL

delete /open-banking/v3.1/callback-urls/{CallbackUrlId}
Description

Request CPB to delete a callback-url resource for a given CallbackUrlId.

Path Parameters
CallbackUrlId
string required
CallbackUrlId
Header Parameters
Accept
string required
application/json
x-fapi-financial-id
string required
The unique id of CPB to which the request is issued. The unique id will be issued by OB.
x-fapi-interaction-id
string Optional
An RFC4122 UID used as a correlation id.
Authorization
string required
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
client_id
string required
Client Id generated during application registration
  • cURL
  • Ruby
  • Python
  • PHP
  • Java
  • Node
  • Go
  • Swift

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Responses
204

This operation returns no content.
400

This operation returns no content.
401

This operation returns no content.
403

This operation returns no content.
404

This operation returns no content.
405

This operation returns no content.
406

This operation returns no content.
429

This operation returns no content.
500

This operation returns no content.