The Open Banking Reference App allows you to explore Mastercard's Open Banking Service (MOBS) For Australia to incorporate it into your product. This application allows you to:
- Create test customers
- Obtain consent to access test accounts data
- Retrieve the data from the shared accounts
IMPORTANT: Please note that applications accessing the Mastercard Open Banking APIs must be hosted within Australia.
The Reference App includes a launch of Connect - a MOBS product which facilitates the collection of consent from an end user (customer) to access their financial data. Consent is required by CDR regulation in Australia to get access to the consumer’s financial data. Integrating Connect with your product will streamline the process of obtaining consent while following the compliance rules. After consent is given, the Reference App shows how the consent receipt ID can be fetched in order to make further calls to FIs.
- Node (v14+)
- ReactJS (v18.2.21)
This application is built using the ReactJS framework. ReactJS requires Node version 14+. However, It is recommended that you use one of NodeJS's LTS releases or one of the more general recent releases. A Node version manager such as nvm (Mac and Linux) or nvm-windows can help with this.
Before using the Reference App, you will need to set up a project in the local machine. The following commands will help you to get the latest code and install the required dependencies on your machine:
git clone https://github.com/Mastercard/open-banking-reference-application-australia.git
cd open-banking-reference-application-australia
npm iYou can run the following command to execute the test cases against the latest version of the Reference App:
npm run test
- Login to the Mastercard developer's portal
- Log in and click the Create New Project button at the top left of the page.
- Enter your project name and select Open Banking as the API service, then click on the Proceed button.
- Select Australia in the Commercial Countries drop down list, and click on the Proceed button.
- Enter a description of your project on the next page, and click on the Create Project button.
- Take note of your Partner ID, Partner Secret and App Key. These will be required in the following sections.
For more details see Onboarding.
The Open Banking Reference App needs Sandbox API credentials adding to the .env file to make the API calls:
- Create the
.envfile.cp .env.template .env
- Update the
.envfile with your Sandbox API credentials generated in step 1.
Execute the following command to start the Reference App:
npm startWhen the application is launched in a browser, it prompts either to proceed with demo or go to GitHub. Select View Demo. This will redirect you to the first step of the user flow.
To access any financial data, first you need to create a customer. Provide a unique identifier for the customer. To proceed further, select Next.
Now 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. To start, select Connect Bank Account:
This flow is a simulation of what a customer will see when consenting to share their financial data with you. In Connect flow:
- Search for Finbank Aus OAuth.
- Check all boxes, and then click I consent.
- Click Next.
- Type profile_4100 and profile_4100 when asked for a username and password.
- Select all accounts, and then click Submit/Continue.
- Click Submit to receive the customer’s consent.
When the consent to access accounts is successfully obtained and Connect is closed, the Reference App is now ready to access the consented accounts.
At this point having customer ID and consent receipt ID allows you to retrieve the financial data from consented accounts. The Reference App shows examples of how to retrieve:
- The account's Money Transfer details
- The available balance
To host the Reference App on your server, run the following command to create the application build:
npm run build
Refer to the below code snippet for creating an express application. Note, that to handling proxy requests to MOBS APIs, we are using http-proxy-middleware. Alternatively, you can set up your proxy server for managing CORS (cross-origin-resource-sharing).
const express = require('express');
const {createProxyMiddleware} = require('http-proxy-middleware');
const app = express();
const port = process.env.PORT || 4000;
app.use(express.static('build'));
app.use(
['/aggregation', '/notifications', '/connect'],
createProxyMiddleware({
target: 'https://api.openbanking.mastercard.com.au/',
changeOrigin: true,
})
);
app.use(
'/token',
createProxyMiddleware({
target: 'https://webhook.site/',
changeOrigin: true,
})
);
app.listen(port, () => {
console.log(`Example app listening on port ${port}`);
});
Have issues or concerns regarding the application? Please create an issue in the GitHub and our team will try to address the issue as soon as possible.
