FINS Thought Machine Accounts System API - Implementation Template
home
This asset is a component of the MuleSoft Accelerator for Financial Services, which accelerates 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 Accounts System API specification. This API is for working with Thought Machine Vault Core instance.
The FINS Thought Machine Accounts System API can be used to manage financial accounts, and transactions in a Thought Machine Vault Core instance.
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:
- Thought Machine Vault Core instance.
- Service Account User with Access to Core API and Audit API. The generated token will be used by the System API and details can be found in the Required property overrides section.
- Products for Checking Account and Savings Account are uploaded into the sandbox. These Product IDs are configured in the System API and details can be found in the Required property overrides section.
- A Posting API Client is created and configured to post batches to Thought Machine.
- An Internal Bank Account is setup so that Financial Transactions are posted using the Internal Bank Account ID.
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.
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. In particular, make sure the common properties for your environment have been provided in the CloudHub-DEV profile (e.g., Anypoint Platform client ID and secret).
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 to reflect the target deployment environment.
| Property Name | Description |
|---|---|
| thought-machine.core-api.base-uri | The base uri of the Thought Machine Core API |
| thought-machine.core-api.token | The token of the Service Account User for connecting to the Core API |
| thought-machine.audit-api.base-uri | The host name of the Thought Machine Audit API |
| thought-machine.audit-api.token | The token of the Service Account User for connecting to the Audit API |
| thought-machine.savings-account-product-id | The Product ID of US Savings Account in Thought Machine instance |
| thought-machine.checking-account-product-id | The Product ID of US Checking Account in Thought Machine instance |
| thought-machine.internal-bank-account-id | The Inernal Bank Account ID that is involved in Financial Transactions |
| thought-machine.posting-api-client-id | The Posting API Client that is involved in posting of Financial Transactions |
Implementation notes
- Creation of Financial Accounts with Account Type BlockchainAccount, GeneralLedgerAccount, LoanAccount, CreditCardAccount, and DepositAccounts of Type Money Market are not supported by Thought Machine.
- Search for Financial Accounts by External Id, Account Type, or Account Number returns no results.
- Only the Global Id, notes, accountLabel, name, and accountNumber of the Financial Account can be changed using the patch:/account/{accountId} endpoint.
- Currency is always defaulted to USD.
- Retrieval and Search of Financial Transactions does not support retrieval of auditInfo fields: the results returned will contain configured default values.
- An update to Financial Transaction is not supported by Thought Machine.
- An Account ID or Transaction ID is needed to retrieve the transaction. If either of them are not provided in the input it is treated as a Bad Request by the implementation.
- Search for Financial Transactions by External Id returns no results if the Transaction is created in Thought Machine.
- Thought Machine Connector returns 100 records in a page for Posting Batch Instructions. The implementation supports retrieval of 1000 Financial Transactions at a time based on a configuration parameter. If more records are to be retrieved, the config may need to be changed or the search parameters fromDate and toDate may need to be adjusted.
- Financial Transactions of type PaymentTransaction is not supported by the implementation.
- Financial Transactions are posted using an Async Batch create operation. Balances are only rightly reflected after the jobs are completed.
- Filtering of records is done by the Implementation as Thought Machine System always returns a superset of records that meet the input criteria.
- This implementation does not support cards with Card Type as CreditCard.
Additional resources
- The Data mappings tab describes how the request and response data structures are mapped between the API interfaces.
- Refer to the Accelerators documentation home for more information about the MuleSoft Accelerators.