Stop and Recall API enable payment originators to rapidly and efficiently request a payment to be stopped and to have the funds recalled to the sender. To learn more about this API, see Stop and Recall API overview. In this section you will find the technical implementation details on how to integrate with this API.

OpenAPI specification & detailed specification

Refer to the Stop and Recall API Reference and the Stop and Recall API detailed specification, which complements the OpenAPI specification, to help you integrate the API.

Rulebook

Understanding the business rules are necessary when integrating with Stop and Recall APIs. These rules are explained in the Stop and Recall rulebook in the Swift Knowledge Centre.

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

Test Stop and Recall API in the Sandbox

The Stop and recall 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 Stop and Recall API calls. Also refer to access sandbox where dedicated sandbox credentials are provided. To start testing in the sandbox, create an app and select gpi API.

Test Stop and Recall API in Pilot

The Swift Pilot environment closely resembles the Live environment. It is intended to fully qualify your API integration. Follow the steps below to access the Stop and Recall API Pilot testing environment.

Step 1: Create an app for Pilot

Create a dedicated app for testing in the Pilot environment and select gpi 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 2: Create Certificate & assign RBAC role for Pilot

Stop and Recall API supports the use of Business certificates and Channel certificates when signing the JWT in the authorisation API call. After creating the certificate, assign the RBAC role swift.apitracker!p to the certificate.

Step 3: 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 Stop and Recall API in the Pilot environment. Refer to Authentication to learn how to use the credentials you created above to start testing your integration with this API in Pilot.

Go Live

After successfully testing the Stop and Recall API in Pilot, follow the steps below to start using this API in Live.

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

Step 2: Create Certificate & assign RBAC role for Live

Follow the same process for creating the certificate for Pilot testing. Stop and Recall API supports the use of Business certificates and Channel certificates when signing the JWT in the authorisation API call. After creating the certificate, assign the RBAC role swift.apitracker to the certificate for Live.

Step 3: Making your first test API call in Live

Swap out the credentials you used for Pilot with Live credentials and start using the Stop and Recall API in your Live applications. When in doubt, refer to Authentication to learn how to use your Live credentials to access this API in Live.