Authentication

OAuth 2.0 is an industry standard used to protect access to APIs.Swift OAuth Token APIis 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 TypeorJWT Bearer Token Grant Type. Check thesecuritySchemesdefined in theOpenAPIspecification 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 code2XXindicates success,4XXindicates an error due to information provided by the client application,5XXindicates 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 supportmaximum_numberandnextquery parameters. If there are more resource objects to be fetched than permitted bymaximum_number, anexttoken is returned to fetch the next set of resource objects. Other Swift APIs supportlimitandoffsetquery parameters. If there are more resource objects to be fetched than permitted bylimit, anextkey is returned whose value is a subpath to be used in the subsequent request. Additional keys are also returned such asself,previous,first,lastandpageof.

gpi API (v4)

This set of APIs provide operations for financial institutions to access and update payment transaction information.

Sign into access our toolbox section to download the specification and other related information.

Try the APIs in the sandbox with Postman or clone thegpi 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.

Sign into access our toolbox section to download the specification and other related information.

Try the APIs in the sandbox with Postman or clone thegpi 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.

Sign into access our toolbox section to download the specification and other related information.

gpi Cover Payments API

This API is a status confirmation update to inform the tracker about the updated status of a given gCOV payment.

Sign into access our toolbox section to download the specification and other related information.

Try the APIs in the sandbox with Postman or clone thegpi 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.

Sign into access our toolbox section to download the specification and other related information.

Try the APIs in the sandbox with Postman or clone thegpi v5 demo app.

Transaction Details API

This set of APIs retrieve the status of one or more payment transactions.

Sign into access our toolbox section to download the specification and other related information.

Try the APIs in the sandbox with Postman or clone thegpi 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.

Sign into access our toolbox section to download the specification and other related information.

Try the APIs in the sandbox with Postman or clone thegpi v5 demo app.

Swift Go API

The Swift Go API enables Swift Go participants to provide status updates via API to the Swift gpi Tracker for the payment messages they receive.

Sign into access our toolbox section to download the detailed specification and other related information.

Instant API

The Instant 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.

Sign into access our toolbox section to download the detailed specification and other related information.

Try the APIs in the sandbox with Postman or clone thegpi v5 demo app.

g4C API

The API documentation provides detailed information on how to retrieve a corporate payment transaction using API.

Sign into access our toolbox section to download the specification and other related information.

Case resolution API

These APIs allow beneficiary and intermediary banks to manage case investigations quickly, reducing the number of manual queries.

Sign into access our toolbox section to download the specification and other related information.

Universal confirmations API

This API allows all non-gpi financial institutions to update the status of the MT 103 payment message they received.

Sign into access our toolbox section to download the detailed specification and other related information.

Try the APIs in the sandbox with Postman or clone thegpi v5 demo app.

Payment Pre-validation Consumer API

付款Pre-validation数据Provider

Securities View

This API provides visibility on the end-to-end transaction flow to all parties involved in securities settlement.

Swift KYC Registry API

CheckKYC Registry API Sandbox Guideto 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.

SwiftRef API

The API documentation provides detailed information on how to retrieve reference data using APIs.

Sign into access our toolbox section to download the specification and other related information.

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.

银行分析过犹不及ium API

The Banking Analytics Premium API services will allow you to compare charging and other practices against the market, understand your sales performance in different markets and rank it over time, and finally use Letter of Credit confirmations and tenor data to assess your competitiveness in key markets.

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 API

The Notification API allows clients to subscribe and receive notifications to the Swift services they use via multiple delivery channel(s).

Trade Finance Validation Service

The Notification API allows clients to subscribe and receive notifications to the Swift services they use via multiple delivery channel(s).

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.

STEP2 Continuous Gross Settlement

Provided by EBA Clearing.

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.