{"id":28577601,"url":"https://github.com/mastercard/open-banking-reference-application","last_synced_at":"2025-10-13T12:42:20.133Z","repository":{"id":201190168,"uuid":"705758574","full_name":"Mastercard/open-banking-reference-application","owner":"Mastercard","description":"Open Banking reference app is a sample app to Mastercard's Open Banking APIs","archived":false,"fork":false,"pushed_at":"2024-09-30T11:20:05.000Z","size":2142,"stargazers_count":16,"open_issues_count":8,"forks_count":16,"subscribers_count":8,"default_branch":"main","last_synced_at":"2025-06-11T00:49:01.360Z","etag":null,"topics":["github-actions","mastercard","openbanking","sonarcloud"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Mastercard.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-10-16T16:28:34.000Z","updated_at":"2025-06-01T16:43:52.000Z","dependencies_parsed_at":"2023-11-17T07:50:41.742Z","dependency_job_id":"b1921f67-431d-4785-9c51-c15f8cdf8686","html_url":"https://github.com/Mastercard/open-banking-reference-application","commit_stats":null,"previous_names":["mastercard/open-banking-reference-application"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Mastercard/open-banking-reference-application","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Mastercard%2Fopen-banking-reference-application","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Mastercard%2Fopen-banking-reference-application/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Mastercard%2Fopen-banking-reference-application/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Mastercard%2Fopen-banking-reference-application/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Mastercard","download_url":"https://codeload.github.com/Mastercard/open-banking-reference-application/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Mastercard%2Fopen-banking-reference-application/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279015057,"owners_count":26085643,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-13T02:00:06.723Z","response_time":61,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["github-actions","mastercard","openbanking","sonarcloud"],"created_at":"2025-06-11T00:38:32.484Z","updated_at":"2025-10-13T12:42:20.097Z","avatar_url":"https://github.com/Mastercard.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Open Banking Reference Application\n\n[![SonarCloud](https://sonarcloud.io/images/project_badges/sonarcloud-orange.svg)](https://sonarcloud.io/summary/new_code?id=Mastercard_open-banking-reference-application)\n\n[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=Mastercard_open-banking-reference-application\u0026metric=alert_status)](https://sonarcloud.io/summary/new_code?id=Mastercard_open-banking-reference-application)\n[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=Mastercard_open-banking-reference-application\u0026metric=reliability_rating)](https://sonarcloud.io/summary/new_code?id=Mastercard_open-banking-reference-application)\n[![Duplicated Lines (%)](https://sonarcloud.io/api/project_badges/measure?project=Mastercard_open-banking-reference-application\u0026metric=duplicated_lines_density)](https://sonarcloud.io/summary/new_code?id=Mastercard_open-banking-reference-application)\n[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=Mastercard_open-banking-reference-application\u0026metric=coverage)](https://sonarcloud.io/summary/new_code?id=Mastercard_open-banking-reference-application)\n\n## Table of Contents\n\n-   [Overview](#overview)\n    -   [References](#references)\n-   [Set up](#set-up)\n    -   [Compatibility](#compatibility)\n    -   [Installation](#installation)\n    -   [Test](#test)\n-   [Demo](#demo)\n    1. [Generate your credentials](#1-generate-your-credentials)\n    2. [Add credentials in the .env file](#2-add-credentials-in-the-env-file)\n    3. [Setup and run the application](#3-setup-and-run-the-application)\n    4. [Create your first customer](#4-create-your-first-customer)\n    5. [Add a bank account to customer](#5-add-a-bank-account-to-customer)\n    6. [Pull account information](#6-pull-account-information)\n    7. [Explore usecases](#7-usecases)\n-   [Hosting Reference App](#hosting-reference-app)\n-   [Contact Us](#contact-us)\n\n## Overview\n\nThe Open Banking Reference App allows you to explore [Mastercard's Open Banking Service (MOBS)](https://developer.mastercard.com/open-banking-us/documentation/) to incorporate it into your product. This application allows you to:\n\n-   Create test customers\n-   Retrieve the data from the shared accounts\n-   Explore the solutions offered by Mastercard Open Banking\n\n\u003e **IMPORTANT**: Please note that applications accessing the Mastercard Open Banking APIs must be hosted within US.\n\n### References\n\n-   [Test API ](https://developer.mastercard.com/open-banking-us/documentation/test-the-apis/)\n-   [API Reference](https://developer.mastercard.com/open-banking-us/documentation/api-reference/)\n-   [Connect Web SDK](https://developer.mastercard.com/open-banking-us/documentation/connect/connect-implementation/)\n\n## Set up\n\n### Compatibility\n\n-   **Node (v14+)**\n-   **ReactJS (v18.3.1)**\n\nThis application is built using the React framework. React requires Node version 14+.\nHowever, It is recommended that you use one of NodeJS's LTS releases or one of the [more general recent releases](https://github.com/nodejs/Release). A Node version manager such as [nvm](https://github.com/creationix/nvm) (Mac and Linux) or [nvm-windows](https://github.com/coreybutler/nvm-windows) can help with this.\n\n### Installation\n\nBefore using the Reference App, you will need to set up a project in the local machine.\nThe following commands will help you to get the latest code:\n\n```shell\ngit clone https://github.com/Mastercard/open-banking-reference-application.git\n\ncd open-banking-reference-application\n```\n\n### Test\n\nYou can run the following command to execute the test cases against the latest version of the Reference App:\n\n```shell\nnpm run test\n```\n\n![test case result page](docs/test_case_result.png)\n\n## Demo\n\n### 1. Generate your credentials\n\n-   Login to the [Mastercard developer's portal](https://developer.mastercard.com/product/open-banking/)\n-   Log in and click the **Create New Project** button at the top left of the page.\n-   Enter your project name and select Open Banking as the API service, then click on the **Proceed** button.\n-   Select **United States of America** in the Commercial Countries drop down list, and click on the **Proceed** button.\n-   Enter a description of your project on the next page, and click on the **Create Project** button.\n-   Take note of your Partner ID, Partner Secret and App Key. These will be required in the following sections.\n\nFor more details see [Onboarding](https://developer.mastercard.com/open-banking-us/documentation/onboarding/).\n\n![Alt Text](https://user-images.githubusercontent.com/3964455/221236073-5661d083-0a04-4d46-9710-3c0c8c9e9a6a.gif)\n\n### 2. Add credentials in the .env file\n\nThe Open Banking Reference App needs Sandbox API credentials adding to the `.env` file to make the API calls:\n\n1. Create the `.env` file.\n    ```shell\n     cp .env.template .env\n    ```\n2. Update the `.env` file with your Sandbox API credentials generated in step 1.\n3. The default value of `REACT_APP_AUTO_CREATE_CUSTOMER` is set to `false`. If the customer creation needs to be initated automatically then the value should be set to `true`\n\n### 3. Setup and run the application\n\n-   ##### Run without docker\n\n    The following command will install the required depdendancies on your machine. (This command should be executed during the initial setup)\n\n    ```\n    npm i\n    ```\n\n    Execute the following command to start the Reference App:\n\n    ```shell\n    npm start\n    ```\n\n-   ##### Run with docker\n\n    **Pre-requisites** - Docker installed and running on your machine: https://docs.docker.com/get-docker/\n\n    The following command will create the docker image of the application and will start the application.\n\n    ```\n    docker compose up\n    ```\n\n    Launch the web browser and navigate to http://localhost:4000 to view the application.\n\n    **Note:** To update the docker image for the reference application, execute the command `docker compose build`, followed by `docker compose up` to run application.\n\nWhen the application is launched in a browser, it prompts either to proceed with demo or go to GitHub. Select **View Demo**.\nThis will redirect you to the first step of the user flow.\n\n![landing page](docs/landing-page.png)\n\n### 4. Create your first customer\n\n-   To access any financial data, first you need to create a customer.\n    -   This can be done either manually or automatically, depending on `REACT_APP_AUTO_CREATE_CUSTOMER` flag value in the `.env` file.\n        If `REACT_APP_AUTO_CREATE_CUSTOMER` is set to `false`, application will prompt you to provide a unique identifier for the customer. To proceed further, select **Next**.\n\n![create customer page](docs/create-customer.png)\n\nIf the `REACT_APP_AUTO_CREATE_CUSTOMER` is set to `true` then the customer will be created automatically.\n\n![create customer automatic page](docs/create-customer-auto.png)\n\n### 5. Add a bank account to customer\n\nNow that you have a **Customer ID**, the next step is to add a bank account. The screen lists a name of the Financial Institution and credentials to use during Connect flow.\nTo start, select **Connect Bank Account**:\n\n![add bank account page](docs/add-bank-account.png)\n\nThis flow is a simulation of what a customer will see when they share their financial data.\nIn Connect flow:\n\n1. Search for **FinBank Profiles - A**.\n2. Click **Next**.\n3. Type test and profile_02 when asked for a username and password.\n4. Select all accounts, and then click **Save**.\n5. Click **Submit**.\n\n\u003cp align=\"center\"\u003e\n  \u003cimg  height=\"500\" src=\"https://user-images.githubusercontent.com/13854193/277695116-11235128-67d8-47a6-8b1b-c93e35e590da.gif\"\u003e\n\u003c/p\u003e\n\n### 6. Pull account information\n\nAt this point having customer ID allows you to retrieve the financial data. The Reference App shows examples of how to retrieve following data elements with the help of Mastercard open banking API's:\n\n1. Account ID\n2. Account name\n3. Account type\n4. Balance\n5. Currency\n\n![account information page](docs/account-information.png)\n\n### 7. Usecases\n\nThe use cases section provides you with an overview of the different solutions offered by Mastercard Open Banking.\n\n-   **Lend**\n    -   Investigate the ways of generating and obtaining the lending reports, including Verification of Assets, Verification of Income and Cash Flow Report etc. MOBS solution allows you to obtain these reports in  \n        both PDF and JSON format.\n\n![lend](docs/lend.png)\n\n-   **Manage**\n    -   Lean how to request the transaction details for a particular account and data it contains.\n\n![manage](docs/manage.png)\n\n-   **Pay**\n    -   Discover how to obtain the key elements of the customers account required to initiate a payment, such as ACH details and available balance.\n\n![pay](docs/pay_money_transfer_details.png)\n\n![pay2](docs/pay_available_balance.png)\n\n![pay3](docs/pay_account_owner_details.png)\n\n## Hosting Reference App\n\nTo host the Reference App on your server, run the following command to create the application build:\n\n```\nnpm run build\n```\n\nRefer to the below code snippet for creating an [express](https://www.npmjs.com/package/express) application. Note, that to handling proxy requests to MOBS APIs, we are using [http-proxy-middleware](https://www.npmjs.com/package/http-proxy-middleware). Alternatively, you can set up your proxy server for managing CORS (cross-origin-resource-sharing).\n\n```\nconst express = require('express');\nconst {createProxyMiddleware} = require('http-proxy-middleware');\nconst app = express();\nconst port = process.env.PORT || 4000;\n\napp.use(express.static('build'));\napp.use(\n    ['/aggregation', '/connect', '/decisioning'],\n    createProxyMiddleware({\n        target: 'https://api.finicity.com/',\n        changeOrigin: true,\n    })\n);\n\napp.listen(port, () =\u003e {\n  console.log(`Example app listening on port ${port}`);\n});\n```\n\n## Contact Us\n\nHave issues or concerns regarding the application?\nPlease create an issue in the GitHub and our team will try to address the issue as soon as possible.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmastercard%2Fopen-banking-reference-application","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmastercard%2Fopen-banking-reference-application","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmastercard%2Fopen-banking-reference-application/lists"}