OpenAPI specifications

EBA CLEARING APIs OpenAPI specifications are composed of the following:

• STEP2 Continuous Gross Settlement API Reference
• STEP2 SEPA Direct Debit B2B API Reference
• STEP2 SEPA Direct Debit CORE API Reference
• STEP2 SEPA Credit Transfer API Reference
• RT1 SEPA Credit Transfer Inst API Reference
• EBA CLEARING FPAD API Reference (Additional permission required)
• FPAD VOP for Responding PSP API Reference (Additional permission required)
• R2P API Reference

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 EBA CLEARING APIs in Pilot for Consumers

The Swift Pilot environment closely resembles the Live environment, and it is intended to fully qualify your API integration. Make sure you are provisioned to start testing in the Pilot environment by following the steps below.

Step 1: Create an app for Pilot

Create a dedicated app for testing in the Pilot environment and select EBA RT1 API which includes RT1 API, R2P API and FPAD API. Or select EBA STEP2 APIs which includes STEP2 APIs and FPAD API. 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.

Step 2: Create Certificate & assign RBAC role for Pilot

EBA CLEARING APIs support the use of Business certificates and Channel certificates when signing the JWT in the authorisation API call. After the certificate is created, assign the RBAC role eba.rt1.api!p for EBA CLEARING RT1 API / R2P API or eba.step2.api!p for EBA CLEARING STEP2 APIs or one of these two roles for EBA CLEARING FPAD API 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 EBA CLEARING APIs 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 for Consumers

After successfully testing the EBA CLEARING APIs 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 EBA RT1 API which includes RT1 API, R2P API and FPAD API. Or select EBA STEP2 APIs which includes STEP2 APIs and FPAD API. After the app is created, 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. EBA CLEARING APIs supports the use of Business certificates and Channel certificates when signing the JWT in the authorisation API call. After the certificate is created, assign the RBAC role eba.rt1.api for EBA CLEARING RT1 API / R2P API or eba.step2.api for EBA CLEARING STEP2 APIs or one of these two roles for EBA CLEARING FPAD API 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 EBA CLEARING APIs 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 VOP FPAD Providers

Follow the steps below to configure your web server and request for provision in the Pilot testing environment.

Step 1: Configure your web server

Refer to API providers to set up your web server.

Step 2: Request for provision in the Swift API Gateway (Pilot)

Place the order EBA VOP FPAD (Pilot) on Swift.com. Complete the order details by providing your BIC, implementation date and other important information about your web server.