Prerequisites

WSO2 Open Banking Accelerator is a collection of technologies that increases the speed and reduces the complexity of adopting open banking compliance. Instead of building an open banking solution from scratch, you can use WSO2 Open Banking Accelerator to meet all open banking requirements with additional benefits beyond compliance. You can use the WSO2 Open Banking Accelerator on top of the following WSO2 products.

You can use any of the following combinations:

WSO2 Identity Server WSO2 API Manager WSO2 Streaming Integrator
Combination 01 5.11.0 4.1.0 or 4.0.0 4.1.0 or 4.0.0
Combination 02
 6.1.0 or 6.0.0 4.2.0 4.2.0

The accelerator mainly addresses the open banking requirements such as API consumer application onboarding, consent management, and access authorization among numerous other features to set up an open banking solution. You can easily implement a toolkit to customize the accelerator and help you comply with any regional open banking requirements. For more information on customization, see the Develop section.

Note

In a standalone setup, these products are deployed in a single server. However, in a typical production environment, it is recommended to deploy the components in separate servers (distributed) for better performance.

Product Matrix

Given below is a product matrix for different versions of WSO2 Open Banking:

Version Mandatory Components Additional Components
3.0.0 wso2ob-apim-accelerator-3.0.0
wso2ob-is-accelerator-3.0.0
wso2is-extensions-1.2.10		 wso2ob-bi-accelerator-3.0.0
2.0.0 wso2-obam-2.0.0
wso2-obiam-2.0.0		 wso2am-analytics-3.1.0
wso2-obbi-2.0.0
wso2ei-6.6.0
1.5.0 wso2-obam-1.5.0
wso2-obkm-1.5.0		 wso2am-analytics-2.6.0
wso2-obbi-1.5.0
wso2ei-6.4.0
1.4.0 wso2-obam-1.4.0
wso2-obkm-1.4.0		 wso2am-analytics-2.6.0
wso2-obbi-1.4.0
wso2ei-6.4.0
1.3.0 wso2-obam-1.3.0
wso2-obkm-1.3.0		 wso2am-analytics-2.6.0
wso2-obbi-1.3.0
wso2ei-6.4.0
1.2.0 wso2ob-am-2.6.0
wso2ob-km-5.7.0		 wso2ob-am-analytics-2.6.0
wso2ob-ei-6.4.0

Compatible Base Product Versions

Given below is the compatible base product matrix for WSO2 Open Banking 3.0:

Base Product Compatible Versions
Combination 01 Combination 02
WSO2 Identity Server 5.11.0 6.0.0
WSO2 API Manager
 4.1.0
4.0.0		 4.2.0
WSO2 Streaming Integrator 4.0.0 4.2.0

Prerequisites for a Deployment

Listed below are the prerequisites for a successful deployment:

Hardware requirements

Disk space 40 GB free disk space
The disk space is based on the expected storage requirements that are calculated by considering the file uploads and the backup policies.
CPU Minimum required: 2 cores
Memory 4 GB RAM

Software requirements

Operating system
  • Windows
  • Linux
    • In a production deployment, it is recommended that WSO2 products are installed on the latest releases of RedHat Enterprise Linux or Ubuntu Server LTS.

    See the following documentation to find the environments that the WSO2 products are tested with:
JDK Version
  • OpenJDK 11 or OpenJDK 17

    • See Compatibility for compatible JDK versions based on the base product versions.
DBMS
  • MySQL 8.0
    • See Compatibility if you are using MySQL 8.0.
  • Oracle 19c
  • Microsoft SQL Server 2017
  • PostgreSQL 13
We do not recommend configuring the H2 database in the production environment.
User store It is not recommended to use Apache DS in a production environment due to scalability issues. Instead, use an LDAP such as OpenLDAP, RDBMS, Active Directory or custom user stores for user management.

Compatibility

WSO2 Open Banking Accelerator 3.0.0 is supported on the following platforms:

Info

If you are using WSO2 Identity Server 6.0.0 and WSO2 API Manager 4.2.0 as the base products, it is recommended to use OpenJDK 17. For other base products, use OpenJDK 11.

Note

To use MySQL 8.0, you need to create the database with charset latin1 as shown below:

create database regdb
character set latin1;
Supported JDK versions
  • OpenJDK 11
  • Oracle JDK 11
  • OpenJDK 17
Supported Operating Systems
  • Ubuntu 18.04.5 LTS
  • Windows Server 2016
Tested DBMSs
  • MySQL 8.0
  • Oracle 19c
  • Microsoft SQL Server 2017
  • PostgreSQL 13
Tested Web Browsers
  • Google Chrome 69
  • Firefox 88.0

Security Guidelines for Production Deployment

When deploying WSO2 Open Banking in a production server, make sure to comply with the following common security guidelines for production deployment.

If you have difficulty in setting up any WSO2 product in a specific platform or database, contact us.

Top