Payment Pre-validation API is designed to support banks to prepare their cross-border payment requests and check if the payment information is valid and in good standing with the country-specific requirements at the destination. To learn more about this API, see Payment Pre-validation API Overview. In this section you will find the technical implementation details on how to integrate with Payment Pre-validation API.

OpenAPI specifications and functional specifications

Refer to the OpenAPI specifications and functional specifications, which complements the OpenAPI specification, to help you integrate the API as a consumer or a data provider.

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. For data providers implementing Payment Pre-validation Beneficiary Account Validation scenarios, Swift Microgateway BaaS is a turnkey solution that is highly customizable to meet your needs.

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 Payment Pre-validation API in the Sandbox

The Payment Pre-validation 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. It ensures the application generates valid requests and can consume valid responses conforming to OpenAPI specifications. This sandbox 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 Payment Pre-validation API calls. Also refer to access sandbox where dedicated sandbox credentials are provided. To start testing in the sandbox, create an app and select Payment Pre-validation API.

Test Payment Pre-validation API in Pilot for Consumers

The Swift Pilot environment closely resembles the Live environment. It is intended to fully qualify your API integration. Make sure you are subscribed to Payment Pre-validation. Follow the steps below to access the Payment Pre-validation API Pilot testing environment.

Step 1: Place order for testing in Pilot for Consumers

Place the order Payment Pre-validation for Consumers (Test) on Swift.com. Complete the order details by providing your BIC and implementation date from dropdowns.

Step 2: Create an app for Pilot

Create a dedicated app for testing in the Pilot environment and select Payment Pre-validation 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

Payment Pre-validation 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.preval!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 required to access the Payment Pre-validation 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.

We recommend testing with Swift Test Sparring Partner (TSP), loop test or test the payment pre-validation central services. Refer to the information available in the Knowledge Center to learn more about these options.

Go Live for Consumers

After successfully testing the Payment Pre-validation API in Pilot, follow the steps below to start using this API in Live.

Step 1: Place order for testing in Pilot for Consumers

Place the order Payment Pre-validation for Consumers (Live) on Swift.com. Complete the order details by providing your BIC and implementation date from dropdowns.

Step 2: Promote the app to the Live environment

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 Payment Pre-validation 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 to create the certificate for Pilot testing. Payment Pre-validation 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.preval 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 Payment Pre-validation 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.

Test in Pilot for Providers

Make sure you are subscribed to Payment Pre-validation. Follow the steps below to configure your web server in the Pilot testing environment.

Step 1: Place order for testing in Pilot for Providers

Place the order Payment Pre-validation for Providers (Test) 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 Payment Pre-validation for Providers API Reference.
• Implement business logic for Beneficiary Account Validation scenarios, refer to functional specifications.
• Implement response and error handling.
• Implement integrations with involved systems.
• Perform testing and deployment of the API.

Step 3: Configure your API service in the Pilot environment

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

If you are deploying your API service in MV-SIPN. Sent your web server certificate for the Pilot environment to prevalidation@swift.com. If you are deploying your API service on the Internet, make sure your server is using a certificate issued by a well-known public certificate authorityTrusted by most major browsers, such as Chrome Root Program or Mozilla Root Program.. If you are changing your Webserver Certificate, ensure this has been communicated with Swift to avoid potential interruption of service. To ensure the API calls are indeed forwarded from Swift to your web server, you can explicitly trust Swift's Internet API gateway's certificate. See the DN information below.

Step 4: Test your API in the Pilot environment

We recommend testing with Swift Test Sparring Partner (TSP) or loop test to validate your implementations. Refer to the information available in the Knowledge Center to learn more about these options.

Go Live for Providers

After successfully testing the Payment Pre-validation API in Pilot, follow the steps below to start providing the API in Live.

Step 1: Place order for Live for Providers

Place the order Payment Pre-validation for Providers (Live) on Swift.com. Complete the order details by providing your BIC and implementation date from dropdowns.

Step 2: Configure your API service the Live environment

Refer to the steps defined in Web Server Configurations for Data Providers to deploy your API service in Swift's MV-SIPN in the Live environment.

If you are deploying your API service in MV-SIPN. Sent your web server certificate for the Live environment to prevalidation@swift.com. If you are deploying your API service over the Internet, make sure your server is using a certificate issued by a well-known public certificate authorityTrusted by most major browsers, such as Chrome Root Program or Mozilla Root Program.. If you are changing your Webserver Certificate, ensure this has been communicated with Swift to avoid potential interruption of service. To ensure the API calls are indeed forwarded from Swift to your web server, you can explicitly trust Swift's Internet API gateway's certificate. See the DN information below.

Step 3: Live testing

Once the Live service is provisioned, you can complete additional testing to ensure you get the expected results in the Live environment.