OpenAPI specifications

Bank of England RTGS APIs OpenAPI specifications are composed of the following:

• Accounts API Reference
• Settlement Liquidity Groups API Reference
• Notifications API Reference
• Reconciliation Responses API Reference
• Participants API Reference
• CHAPS Payments Controls API Reference
• Transactions API Reference
• Full Payment Message API Reference
• Raw Payment Messages API Reference

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.

Not sure which tool is right for you? Try the connectivity option selector to get recommendations from our expert. After you select a tool, try setting it up in the API sandbox (available over the Internet) to quickly get started.

Test Bank of England RTGS APIs in Pilot

The Swift Pilot environment closely resembles the Live environment. It is intended to fully qualify your API integration. Make sure you are subsribed to the Bank of England RTGS API service. Follow the steps below to access the Bank of England RTGS APIs Pilot testing environment.

Step 1: Create an app for Pilot

Create a dedicated app for testing in the Pilot environment and select Bank of England RTGS APIs or Bank of England RTGS APIs (TS2) or both 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 the app is created, promote the app to the Pilot environment.

Step 2: Create Certificate & assign RBAC role for Pilot

Bank of England RTGS APIs supports the use of Business certificates only when signing the JWT in the authorisation API call. After the certificate is created, assign the RBAC role boe.rtgs.api!pi1 or boe.rtgs.api!pi2 or boe.rtgs.api!pi3 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 Bank of England RTGS APIs 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 Bank of England RTGS APIs 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 Bank of England RTGS APIs or Bank of England RTGS APIs (TS2) or both 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. Bank of England RTGS APIs supports the use of Business certificates only in Live when signing the JWT in the authorisation API call. After the certificate is created, assign the RBAC role boe.rtgs.apii1 or boe.rtgs.apii2 or boe.rtgs.apii3 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 Bank of England RTGS APIs in your Live applications. When in doubt, refer to Authentication to learn how to use your Live credentials to access this API in Live.