Introduction
Welcome! This reference page will list all SWIFT APIs and the detailed documentations pertained to each. Our APIs implement REST with standard HTTP codes, verbs and authentication.
There are two types of SWIFT APIs, one accessible over the internet, and the other accessible only over the secure SWIFT network. The base URL is different for each type. Additionally, we offer a sandbox environment for developers to test out the APIs early, without any provisioning and over the internet.
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 Client Credentials Grant Type with Signed JWT (JWS) assertion. Check the securitySchemes defined in the OpenAPI specification to find out which type of OAuth and which credential should be used.
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.
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.
Sandbox
Overview
You can try out any SWIFT APIs in a harmless and effortless sandbox environment with the sandbox URL: https://sandbox.swift.com. Additionally, we provide a postman collection to help you explore the use cases covered in the sandbox environment, more details in the getting started guide with postman collection.
Getting Started
Create your client application under My Apps. We recommend one API product per app. After the app is created, you will find a unique pair of credentials, consumer-key as client identifier and consumer-secret as shared secret. You are responsible for securing the credentials i.e. at your premises and also within your client applications. The status of the client application shows the environment where the credentials are valid. The default status is Sandbox.
GPI
Overview
APIs in this category are offered via the secure SWIFT 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, gpi Connector for API v3 or lower.
gpi API
gpi v2 will be deprecated with the release of gpi v4. View the Announcement
This set of APIs provide operations for financial institutions to access and update payment transaction information.
Sign in to access our toolbox section to download the specification and other related information.
Try the APIs in the sandbox with Postman or clone the gpi v4 demo app.
g4C API
The API documentation provides detailed information on how to retrieve a corporate payment transaction using API.
Sign in to access our toolbox section to download the specification and other related information.
gCase API
These APIs allow beneficiary and intermediary banks to manage case investigations quickly, reducing the number of manual queries.
Sign in to access our toolbox section to download the specification and other related information.
Pre-validation API
The API documentation provides detailed information on how to validate an beneficiary's account using API.
Sign in to access our toolbox section to download the specification and other related information.
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.
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.
Sign in to access our toolbox section to download the specification and other related information.
SADS API
The API documentation provides detailed information on how to download publication files and entire directory automatically using APIs.
Sign in to access our toolbox section to download the specification and other related information.
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.
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).