Bank Guarantees API
Previous page Changelog
Next pageAuthentication
Bank Guarantees API manages all Corporate to Bank processes involved in the life cycle of a bank guarantee. To learn more about this API, see Bank Guarantees API Overview. In this section, you will find the technical implementation details on how to integrate with Bank Guarantees API as Consumers and Providers.
Refer to the following OpenAPI specifications and guides to integrate this API.
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.
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.
Bank Guarantees API sandbox returns static sample responses and does not contain any application logic. This sandbox is recommended for developers who want to learn and understand the authentication method JWT Bearer grant type by testing it out with a self-signed certificate over the Internet. This sandbox also ensures that the application generates valid requests and can consume valid responses conforming to OpenAPI specifications. It is also recommended for developers who are trying to set up the developer tools aimed to make integration easier.
It is mandatory to share test evidence with Swift to certify your application's ability to generate API requests and process API responses in conformance with the OpenAPI specifications before moving on to testing in the Pilot environment.
You can view, fork or download the Postman collection which includes authentication API calls and sample Bank Guarantees API calls. Also refer to access sandbox where dedicated sandbox credentials are provided. To start testing in the sandbox, create an app and select Bank Guarantees API.
The Pilot environment aims to test production like transactions against a real counterparty, and it is intended to fully qualify your API integration. Follow the steps below to access the Bank Guarantees API Pilot testing environment.
Place the order Pilot Service Subscription and Change for Consumers on Swift.com.
Create a dedicated app for testing in the Pilot environment and select Bank Guarantees 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 the app is created, promote the app to the Pilot environment.
Bank Guarantees API supports the use of Business certificates and Channel certificates in the authorisation API call. After the certificate is created, assign the RBAC role swift.bank.guarantees.api!p 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..
After completing the steps above, you now have the credentials required to access the Bank Guarantees API in the Pilot environment. Refer to Authentication to learn how to use the credentials you created above and start testing your integration with the API in Pilot.
Talk to your bank to agree on a set of criteria to indicate the completion of pilot testing. For example, your application should be able to send and receive expected API requests and responses from your bank.
After successfully testing the Bank Guarantees API in Pilot, follow the steps below to start using the API in Live.
Place the order Live Service Subscription and Change for Consumers on Swift.com.
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 Guarantees 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.
Follow the same process for creating the certificate for Pilot testing. Bank Guarantees API supports the use of Channel certificates and Business certificates when signing the JWT in the authorisation API call. After creating the certificate, assign the RBAC role swift.bank.guarantees.api to the certificate for Live.
This step should be done by a security officerAlliance Lite2 Customer Security Officer. Click to learn more on Swift.com..
Swap out the credentials you used for Pilot with Live credentials and start using the Bank Guarantees API in your Live applications. When in doubt, refer to Authentication to learn how to use your Live credentials to access the API in Live.
Place the order Pilot Service Subscription and Change for Providers on Swift.com.
We recommend the following to be performed by the technical development team in your company.
Refer to the steps defined in Web Server Configurations for Data Providers to deploy your API service in the Pilot environment.
Make sure your application or the application provided by your software vendor can:
After successfully testing the Bank Guarantees API in Pilot with your API clients, follow the steps below to start providing the API in Live.
Place the order Live Service Subscription and Change for Providers on Swift.com. Complete the order details by providing your BIC and implementation date from dropdowns.
Refer to the steps defined in Web Server Configurations for Data Providers to deploy your API service in the Live environment.
Once the Live service is provisioned, you can complete additional testing with your API clients to ensure you get the expected results in the Live environment.