The notification events published by the Service Provider are delivered when the recipient has an event subscription following the pub/sub model. Notification Subscription API is used by the recipient to subscribe to the notification events, the second step of three in setting up your systems to receive and process notification events. This page guides you through the integration of this API.

OpenAPI specification

Refer to the Notification Subscription API Reference to help you integrate the API.

In the API request body, you should include service_name , subscriber_bics and event_typesEvent types are unique to the notification provider. for the notification events you want to receive. As of now, notification events are delivered as webhooks which should be used in mechanism element, other types of delivery channels will be supported in the future. Lastly, a webhook endpoint should be defined for each notification subscription. The endpoint URL must include scheme and the SwiftNet domain name that is returned in the response.

The API response includes subscription_id which is a unique reference for making updates to the subscription if needed. At any given moment, there can only be one active subscription for a subscriber BIC8 on a service with a event type. With this, notifications can be uniquely delivered to the recipient.

Choose developer tools

Looking for a faster and easier way to integrate? Consider using one of the developer tools designed to simplify the consumption of API-based services available on the Swift platform. Build your application with Swift SDK to help you with lower-level application plumbing, which includes authentication, authorisation, signing and error handling. Alternatively, consider using Swift Microgateway to configure, monitor all API calls you make on Swift and capture inbound API requests. Finally, Swift zero-footprint is an option that provides reference implementations so that you can create your own SDK or utilities.

Test Notification Subscription API in Pilot

Swift Pilot environment closely resembles the Live environment, and it is intended to fully qualify your API integration. Follow the steps below to access the Notification Subscription API Pilot testing environment.

Step 1: Create an app for Pilot

Create an app for testing in the Pilot environment and select Swift Notification API from the list of API products. Inside the app are consumer-key and consumer-secret which are the application credentials used to identify the application calling the API. After creating the app, promote the app to the Pilot environment.

Step 2: Create Certificate & assign RBAC role for Pilot

Notification Subscription API supports the use of Business certificates and Channel certificates when signing the JWT in the authorisation API call. After creating the certificate, assign the RBAC role swift.notif!p/consumer and the business service on which notification subscription is being requested (for example, assign swift.bank.guarantees.api!p/swift_notif for Bank Guarantees API notification) to the certificate.

Step 3: Making your first test API call in the Pilot environment

After completing the steps above, you now have the credentials you need to access the Notification Subscription API in the Pilot environment. Refer to Authentication to learn how to use the credentials you created above to start testing your integration with this API in Pilot.

Go Live

After successfully testing the Notification Subscription API in Pilot, follow the steps below to start using this API in Live.

Step 1: Create an app for Live

Promote the app you created to the Live environment or create a new app for the Live environment. If you decided to create a new app, select Swift Notification API from the list of API products. After the app is created, promote the app to the Live environment.

Step 2: Create Certificate & assign RBAC role for Live

Follow the same process for creating the certificate for Pilot testing. Notification Subscription API supports the use of Business certificates and Channel certificates when signing the JWT in the authorisation API call. After creating the certificate, assign the RBAC role swift.notif/consumer and the business service on which notification subscription is being requested (for example, assign swift.bank.guarantees.api/swift_notif for Bank Guarantees API notification) to the certificate for Live.

Step 3: Making your first test API call in Live

Swap out the credentials you used for Pilot with Live credentials and start using the Notification Subscription API in your Live applications. When in doubt, refer to Authentication to learn how to use your Live credentials to access this API in Live.