Instant Cash Reporting (ICR) API is used by banks and corporates to check their company's account balances across all their banks in a unified ISO 20022 format and in real-time. To learn more about this API, see Instant Cash Reporting API Overview. In this section you will find the technical implementation details on how to integrate with the Instant Cash Reporting API.

OpenAPI specification & other guides

Refer to the Instant Cash Reporting API Reference and Community APIs Troubleshooting Guide to help you integrate this API.

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 to configure, monitor all API calls you make on Swift and capture inbound API requests. Finally, 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.

Test Instant Cash Reporting API in the Sandbox

Instant Cash Reporting 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.

You can view, fork or download the Postman collection which includes authentication API calls and sample Instant Cash Reporting API calls. Also refer to access sandbox where dedicated sandbox credentials are provided. To start testing in the sandbox, create an app and select "Instant Cash Reporting API".

Test in Pilot for Consumers

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 Instant Cash Reporting API Pilot testing environment.

Step 1: Place order for testing in Pilot for Consumers

Place the order Pilot Service Subscription and Change for Consumers on Swift.com.

Step 2: Create an app for Pilot

Create a dedicated app for testing in the Pilot environment and select Instant Cash Reporting 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 creating the app, promote the app to the Pilot environment.

Step 3: Create certificate & assign RBAC role for Pilot

Instant Cash Reporting API supports the use of Business certificates and Channel certificates in the authorisation API call. After creating the certificate, assign the RBAC role swift.cash.management!p to the certificate.

Step 4: 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 Instant Cash Reporting API in the Pilot environment. Refer to Authentication to learn how to use the credentials you created above to start testing your integration with the API in Pilot.

Go Live for Consumers

After successfully testing the Instant Cash Reporting API in Pilot with your bank, follow the steps below to start using the API in Live.

Step 1: Place order for Live for Consumers

Place the order Live Service Subscription and Change for Consumers on Swift.com.

Step 2: 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 Instant Cash Reporting API from the list of API products. After creating the app, promote the app to the Live environment.

Step 3: Create certificate & assign RBAC role for Live

Follow the same process for creating the certificate for Pilot testing. Instant Cash Reporting API supports the use of Channel certificates and Business certificates when signing the JWT in the authorisation API call. After the certificate is created, assign the RBAC role swift.cash.management to the certificate for Live.

Step 4: Making your first test API call in Live

Swap out the credentials you used for Pilot with Live credentials and start using the Instant Cash Reporting 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. When the Live service is provisioned, you can complete additional testing with your bank to ensure you get the expected results in the Live environment.

Test in Pilot for Providers

Step 1: Place order for testing in Pilot for Providers

Place the order Pilot Service Subscription and Change for Providers on Swift.com. Complete the order details by providing your BIC and implementation date from dropdowns.

Step 2: Develop the API

We recommend the following to be performed by the technical development team in your company.

• Set up development and UAT environments.
• Define endpoints and implement request handling conforming to the Instant Cash Reporting API Reference.
• Implement business logic (ie, customer accounts identification, data acquiring and processing etc.).
• Implement response and error handling.
• Implement integrations with involved systems.
• Perform testing and deployment of the API.

Step 3: Configure your API service over Swift in Pilot

Refer to the steps defined in Web Server Configurations for Data Providers to deploy your API service in the Pilot environment.

Go Live for Providers

After successfully testing the Instant Cash Reporting API in Pilot with your corporate customers, follow the steps below to start providing the API in Live.

Step 1: Place order for Live for Providers

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.

Step 2: Configure your API service over Swift in Live

Refer to the steps defined in Web Server Configurations for Data Providers to deploy your API service in the Live environment.

Step 3: Live testing with your corporate customers

When the Live service is provisioned, you can complete additional testing with your bank to ensure you get the expected results in the Live environment.