Swift Notifications API
Swift Notifications API is used by the service provider to publish notification events to its subscribers and it is also used for the subscribers to process notification events received, the final step 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 Swift Notifications API Reference to integrate the API for providers publishing notification events. For subscribers, refer to the specification to handle the notification events to be received.
Do not include sensitive information in notification events.
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 Swift Notifications API in Pilot for Providers
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 Swift Notifications 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
Swift Notifications 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/provider to the certificate.
This step should be completed by a security officerClick to learn more about SWIFTNet PKI Security Officer registration in the Knowledge Centre..
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 Swift Notifications 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 for Providers
After successfully testing the Swift Notifications 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.
You should promote the app to Pilot first and then Live.
Step 2: Create Certificate & assign RBAC role for Live
Follow the same process for creating the certificate for Pilot testing. Swift Notifications 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/provider to the certificate for Live.
This step should be completed by a security officerClick to learn more about SWIFTNet PKI Security Officer registration in the Knowledge Centre..
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 Swift Notifications 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.