FINS Core Banking Customers System API - Implementation Template

This API implementation template is a component of MuleSoft Accelerators, which accelerate the implementation of essential integration use cases.

The solution includes pre-built APIs, connectors, and integration templates that help unlock business-critical data from external systems and guide you in adopting best practices synthesized from thousands of customer implementations. Use these assets as is or extend them to meet your company’s unique needs.

---

Overview

This integration template implements the Core Banking Customers API specification. This API is for working with a generic Core Banking System. A scaled down version of the Core Banking System has been implemented on MariaDB; this should be replaced with a real back-end. This API follows the Cloud Information Model (CIM) and uses a DB Schema replicating the CIM schema.

Getting started

The Getting Started with MuleSoft Accelerators guide provides general information on getting started with the accelerator components. This includes instructions on setting up your local workstation for configuring and deploying the applications.

Once your workstation has been set up and the application template imported into Anypoint Studio, proceed with the Prerequisites section.

Prerequisites

This implementation template has the following dependencies:

• MariaDB

Please review the use cases described on the MuleSoft Accelerator for Financial Services solution pages for more information about dependencies on other APIs and services.

Configuring the MariaDB

These instructions assume that you have a MariaDB version 10.6.8 or later. There are DB Scripts located under the src/test/resources/scripts folder.

To initialize a new database, run the following scripts in order:

• create-customers-schema.sql
• create-reference-data.sql
• create-logging-scripts.sql (optional, for debugging)
• generate-sp-create-script (produces a script to create all stored procs)
• create-stored-procedures.sql

To upgrade a database from a prior release, run the following scripts in order:

• upgrade-customers-schema.sql
• drop-stored-procedures.sql
• generate-sp-create-script (produces a script to create all stored procs)
• create-stored-procedures.sql

To drop the tables and stored procedures, execute the scripts drop-customers-schema.sql and drop-stored-procedures.sql, respectively. To truncate data from the tables, use the truncate-data.sql script.

Deployment

Each Accelerator implementation template in Exchange includes Bash and Windows scripts for building and deploying the APIs to CloudHub. These scripts depend on repositories, global settings, deployment profiles, and associated properties configured in the Maven settings.xml file.

For additional details, please refer to the Application Deployment section of the Getting Started Guide.

Preparation

Ensure the Maven profile CloudHub-FINS-DEV has been properly configured in your settings.xml file. In particular, make sure the common properties for your environment have been provided (e.g., Anypoint Platform client ID and secret).

Required property overrides

At a minimum, the following properties must be customized for this application to reflect the target deployment environment.

Testing

Use Advanced Rest Client or Postman to send a request over HTTPS. The template includes a Postman collection in the src/test/resources folder. Update the collection variable(s) after successful import.

Additional resources

• The Data mappings tab describes how the request and response data structures are mapped between the API interface and the CoreBanking DB.
• Refer to the Accelerators documentation home for more information about the MuleSoft Accelerators.