Introduction
Welcome! This reference page lists our APIs and the detailed documentations pertained to each. Our APIs implement REST with standard HTTP codes, verbs and authentication methods and they are documented using the OpenAPI 3.0 standard. Read on to get more information about our API guidelines!
Authentication
OAuth 2.0 is an industry standard used to protect access to APIs. Swift OAuth Token API is used to issue tokens needed to access other Swift API products. Depending on the API product you are trying to access, you will be using one of the two types of OAuth, Password Grant Type or JWT Bearer Token Grant Type. Check the securitySchemes defined in the OpenAPI specification to find out which grant type and credential you should use for the API you want to consume.
Versions
Swift uses semantic versioning for our APIs. We will bump up the MAJOR version when a "breaking change" is made to the API, MINOR version number will be incremented when a functional "non-breaking change" is made to the API and "PATCH" version number will be incremented when a bug fix "non-breaking change" is made to the API.
We adopted the URI versioning approach where MAJOR version number is expected to be in the URL.
Errors
Swift uses industry best practices to handle errors. You can expect three outcomes when interacting with our APIs. HTTP status code 2XX indicates success, 4XX indicates an error due to information provided by the client application, 5XX indicates an error with the server.
Pagination
When making an API call to a resource like /payments/changed/transactions, the number of results returned can be very large. To make results easier to handle and to reduce latency and the amount of bandwidth consumed, results are paginated.
There are two pagination behaviors supported by Swift APIs. GPI APIs support maximum_number and next query parameters. If there are more resource objects to be fetched than permitted by maximum_number, a next token is returned to fetch the next set of resource objects. Other Swift APIs support limit and offset query parameters. If there are more resource objects to be fetched than permitted by limit, a next key is returned whose value is a subpath to be used in the subsequent request. Additional keys are also returned such as self, previous, first, last and pageof.
Now you have everything you need to know about our API guidelines, be sure to check out the next section Getting Started with a step-by-step guide on how to kick off your Swift API journey!
Getting Started
For information on getting started with RTGS APIs from the Bank Of England, please follow the link here.
Please note that the RTGS API guide requires additional permissions.Contact Us to request access.
Step 1: Browse our APIs
Swift offers a range of API products that help remove the friction from global transactions. You can find the APIs in the API Catalogue and a number of API use cases in the API Playground to help you find the APIs that best suit your needs.
Step 2: Create your App
Creating your own application allows you to generate a set of credentials to access the API products in the sandbox and production environments.
- Create an account
If you have an account on Swift.com, you can use it to sign in directly.
- Create an App
We recommend one API product per App.
You are responsible for securing your credentials on your premises and within your client applications. Application credentials are exchanged via the Basic Authentication Scheme in the Authorization Header. You will find more information in the Swift OAuth Token API page.
Once you create an App, its status will be set to “Sandbox” and its credentials can be used to access API products in the sandbox environment. You can promote your application to the production environments when you are ready.
Step 3: Making calls to APIs in the Sandbox
You can try all API products in the freely accessible sandbox environment using the application credentials from the app you created and the sandbox credentials that are provided to you below. Sandbox APIs implement the same OpenAPI specifications used for Live APIs to ensure a similar integration experience. Please note that, for the moment, not all sandbox APIs cover the full set of test scenarios.
When generating an OAuth token to access the sandbox APIs, use the following sandbox credentials:
Sandbox License ID:
sandbox-idSandbox License Secret:
sandbox-keySandbox Self-signed Certificate: demo.jks
Find more information on how to use these credentials to generate an OAuth token in the Swift OAuth Token API page.
To help you get started quickly, check out the tutorial videos and postman collections that are embedded with sandbox URL, authentication, API requests and postman tests to help you test with the scenarios covered in the sandbox environment. You can download the postman collection via the Run in Postman button.
Step 4: Promote your App to live!
When you’re ready to use the APIs in the production environment, you can promote your App from the Swift Developer Portal.
Sign in with the option Sign in with swift.com and go to My Apps.
Select the App you want to promote
Click Promote App
Verify information in the pop up window
To confirm, click Promote
After the promotion request is submitted, it takes on average 2 days for some API products to be promoted. You can check the status of the request under My Apps.
SDK
Build your application with Swift SDK to make coding easier. Swift SDK takes care of the lower-level plumbing including authentication, authorization, signing and error handling. In addition, it provides a number of value-added services such as schema validation, monitoring, end-to-end testing and ready to use API use cases. Swift SDK currently supports APIs for accessing customer credit transfer, instant payments, stop and recall, case resolution, cover payments, financial institution transfer, GPI for Corporates, pay and trace, inbound payments, pre-validation, KYC Registry, SWIFTRef, SWIFTRef Automated Download, Banking Analytics and Compliance Analytics services.
Microgateway
Use Swift Microgateway to benefit from the full range of API-based services available on Swift. Swift Microgateway is a software product that allows firms to configure, manage, and monitor all API calls they make on the platform. In the future, the Microgateway will enable you to expose your own APIs on Swift, allowing you to offer your services to our unique community of more than 11,000 financial institutions located in over 200 countries.
Swift GPI
Overview
APIs in this category are offered via the Swift multi-vendor secure IP network (MV-SIPN). Access to highly confidential GPI data requires API client to estabilish a secure session with the API service via the following options: Swift SDK and Swift Microgateway for API v4 or higher.
Find more information in GPI API release policy and versioning.
GPI API (v4)
This set of APIs provide operations for financial institutions to access and update payment transaction information.
Try the APIs in the sandbox with Postman or clone the GPI v4 demo app.
GPI Customer Credit Transfer API
This API is a status confirmation update to inform the Tracker about the updated status of a given customer credit transfer payment.
Try the APIs in the sandbox with Postman or clone the GPI v5 demo app.
PMI API
This API is a status confirmation update to inform the Tracker about the updated status of a given customer credit transfer payment.
GPI Cover Payments API
This API is a status confirmation update to inform the Tracker about the updated status of a given gCOV payment.
Try the APIs in the sandbox with Postman or clone the GPI v5 demo app.
GPI Financial Institutions Transfer API
This API is a status confirmation update to inform the Tracker about the updated status of a given gFIT payment.
Try the APIs in the sandbox with Postman or clone the GPI v5 demo app.
Transaction Details API
This set of APIs retrieve the status of one or more payment transactions.
Try the APIs in the sandbox with Postman or clone the GPI v5 demo app.
Stop and Recall API
This set of APIs allow the rapid halting of payments that are suspected to have been made in error or in a fraudulent manner.
Try the APIs in the sandbox with Postman or clone the GPI v5 demo app.
Swift Go API
The Swift Go API enables Swift Go participants to provide status updates via API to the Tracker for the payment messages they receive.
Instant Payments API
The Instant Payments API is an optional service for Swift GPI members to provide a cross-border instant payments experience by linking the international payments with domestic instant payment systems.
Try the APIs in the sandbox with Postman or clone the GPI v5 demo app.
GPI for Corporates API
The API documentation provides detailed information on how to retrieve a corporate payment transaction using API.
Case resolution API
These APIs allow beneficiary and intermediary banks to manage case investigations quickly, reducing the number of manual queries.
Universal confirmations API
This API allows all non-GPI financial institutions to update the status of the MT 103 payment message they received.
Try the APIs in the sandbox with Postman or clone the GPI v5 demo app.
Pre-Validation
Overview
APIs in this category are offered via the internet and the Swift multi-vendor secure IP network (MV-SIPN).
Payment Pre-validation Consumer API
'Payment Pre-validation Data Provider
Securities
Securities View API
This API provides visibility on the end-to-end transaction flow to all parties involved in securities settlement.
Securities View Notification API
This API provides notifications for the Swift Securities View service, giving you visibility on the end-to-end securities settlement transaction flow.
Compliance
Overview
APIs in this category are offered via the internet.
Swift KYC Registry API
Check KYC Registry API Sandbox Guide to learn more about the sandbox.
Transaction Screening API
The Transaction Screening API enables you to submit a transaction to be screened by the Transaction Screening Service.
Compliance Analytics API
The Compliance Analytics API allows you to programmatically access your Compliance Analytics data and automate your financial crime-related use cases.
RefData
Overview
APIs in this category are offered via the internet.
SWIFTRef API
The API documentation provides detailed information on how to retrieve reference data using APIs.
Business Intelligence
Overview
APIs in this category are offered via the internet.
Banking Analytics API
Swift Banking Analytics API enables institutions to retrieve their own Swift traffic data and the Swift totals, extending to the level of value and currency per market.
Observer Analytics API
The Observer Analytics API enables institutions to access and integrate payments data enriched with Observer computation on speed, fees, end-to-end routing, GPI KPIs, and Swift Totals per market.
Notification Service
Notification API
The Notification API allows clients to subscribe and receive notifications to the Swift services they use via multiple delivery channel(s).
Trade Finance
Trade Finance Validation Service
The Trade Financing Validation Service powered by MonetaGo performs checks on financing documents to prevent domestic and crossborder duplicate financing frauds in trade finance.
Bank Guarantee API
The Demand Guarantee API manages all processes involved in the life cycle of a demand guarantee between applicant and issuing bank & advising bank and beneficiary.
Bank Guarantee Notification API
The Demand Guarantee Notification API manages delivering all events involved in the life cycle of a demand guarantee application between applicant, issuing banks, beneficiary and advising bank informing the lifecycle status of an application or an event require action.
Connectivity
Swift messaging API
The Swift messaging API enables your Back office applications to communicate with any Swift counterparty through Alliance Cloud by embedding Swift messages inside API calls, which offers easy and direct integration with Alliance Cloud via standard RESTful connectivity.
EBA API
Overview
APIs in this category are offered via the Swift multi-vendor secure IP network (MV-SIPN).
STEP2 Continuous Gross Settlement
Provided by EBA Clearing.
STEP2 SEPA Direct Debit B2B
Provided by EBA Clearing.
STEP2 SEPA Direct Debit CORE
Provided by EBA Clearing.
STEP2 SEPA Credit Transfer
Provided by EBA Clearing.
RT1 SEPA Credit Transfer Inst
Provided by EBA Clearing.
Instant Treasury
Payment Initiation API
The Payment Initiation API is used by a debtor to instruct their bank (or other payment service provider) to move funds from their account to a beneficiary account.
Instant Cash Reporting API
The solution for seamless, secure and reliable account data delivery.
Bank of England RTGS 
Overview
RTGS APIs will allow Participants to develop sophisticated and automated real-time tools for accessing RTGS transactional data.
To get an overview of the high level steps to get started, go here: Getting started with RTGS APIs
Accounts API
The Accounts API enables a Participant to retrieve information associated with their RTGS Accounts they are authorised to, like account balance, account details, balance allocations and accounts reports.
Settlement Liquidity Groups API
The Settlement Liquidity Groups API enables Participants to retrieve information associated with the Settlement Liquidity Groups they are authorised to, like basic settlement liquidity group details and associated balance allocations.
Notifications API
The Notifications API enables Participants to retrieve a list of notifications that are triggered when an event occurs in RTGS.
Reconciliation Responses API
The Reconciliation Responses API enables Participants to view a single reconciliation response and create a reconciliation response.
Participants API
The Participants API enables Participants to view and manage their Organisation information and associated key configuration parameters for efficient transaction processing.
CHAPS Payments Controls API
The CHAPS Payments Controls API enables Participants to update the configuration of the CHAPS Payment control parameters for effective processing of CHAPS transactions they are party to.
Transactions API
The Transactions API enables Participants to retrieve Transaction details for all Schemes they are authorised to, including Clearing details for DNS.
Full Payment Message API
The Full Payment Messages API enables Participants to retrieve the raw ISO 20022 payment messages submitted to Bank of England (pac.008, pacs.009, pacs.009COV and pacs.004).
Raw Payment Messages API
The Raw Payment Messages API enables Participants to retrieve the CHAPS ISO 20022 payment messages submitted to Bank of England (pac.008, pacs.009, pacs.009COV and pacs.004) to which they are a party.
Tasks API
The Tasks API enables Participants to retrieve the details and status of Tasks they are authorised to.
Filter Values API
The Filter Values API enables Participants to retrieve the Codes and Names used in various API responses and Filters.