Get Started

WSO2 Open Banking Accelerator is a technology stack catered to speed up the implementation of an open banking solution. You can use the WSO2 Open Banking Accelerator on top of the WSO2 Identity Server and API Manager to obtain an environment for Identity Access Management and API management in open banking.

This section guides you on how to set up the solution in a local environment. Follow the instructions to find how you can quickly set up and try out a basic flow.


  1. Download Open Java Development Kit (OpenJDK) version 11 or 17 to the local environment based on the base product versions you use.


    See Compatibility for compatible JDK versions.

  2. In the environment variables, update the JAVA_HOME and PATH variables. For instance, you can do this on a Mac/Linux server by adding the following to the ~/.bashrc file:

    export PATH=$PATH:$JAVA_HOME/bin

  3. Setup a database server using any of the following:

    • MySQL 8.0
    • Oracle 19c
    • Microsoft SQL Server 2017
    • PostgreSQL 13


    See Compatibility if you are using MySQL 8.0.


    We do not recommend configuring H2 database in the production environment.

Installing base products

  1. Download and extract the required base 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.0.0 4.2.0 4.2.0

  2. To configure the Identity Server with the API Manager, download the respective WSO2 IS Connector according to the API Manager version you have downloaded.

Installing WSO2 Open Banking Accelerator

  1. If you have an active WSO2 Open Banking subscription, contact us via WSO2 Online Support System to download Open Banking Accelerator 3.0.0.


    If you don't have a WSO2 Open Banking subscription, contact us for more information.

  2. Extract the downloaded WSO2 Open Banking Accelerator zip files. WSO2 Open Banking Accelerator contains the following accelerators:

    • wso2-obiam-accelerator-3.0.0
    • wso2-obam-accelerator-3.0.0
    • wso2-obbi-accelerator-3.0.0
  3. This document uses the following placeholders to refer to the following products:

    Product Placeholder
    WSO2 Identity Server <IS_HOME>
    WSO2 API Manager <APIM_HOME>
    WSO2 Open Banking Identity Server Accelerator <OB_IS_ACCELERATOR_HOME>
    WSO2 Open Banking API Manager Accelerator <OB_APIM_ACCELERATOR_HOME>
    WSO2 IS Connector for API Manager <IS_EXTENSION>

Getting WSO2 Updates

The WSO2 Update tool delivers hotfixes and updates seamlessly on top of products as WSO2 Updates. They include improvements that are released by WSO2. You need to update the base products and accelerators using the relevant script.

  1. Go to <PRODUCT_HOME>/bin and run the WSO2 Update tool:

    • Repeat this step for the WSO2 Identity Server, API Manager, and Stream Integrator products.

  2. Go to <ACCELERATOR_HOME>/bin and run the WSO2 Update tool:

    • Repeat this step for the WSO2 Open Banking Identity Server, API Manager, and Business Intelligence accelerators.


For more information, see the WSO2 Updates documentation.