fins-payments-intrabankintl-prc-api
home
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 FINS BIAN Payment Execution Process API specification. It supports the following functionalities:
- To process payment transfers made through ACH and FedWire processes.
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:
- Anypoint MQ Destinations
- Accelerator Notifications Process API
- FINS Foreign Exchange System API
- FINS Payments Fedwire System API
- FINS Payments SWIFT System API
- FINS Core Banking System API
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.
API dependencies
The following table lists all endpoints used by this API.
| API name | Endpoint | Action |
|---|---|---|
| Accelerator Notifications Process API | post:/api/notifications | Send Notification |
| FINS Core Banking System API | get:/api/transactions | Retrieve Transaction with the Originator Id |
| FINS Core Banking System API | get:/api/accounts | Retrieve Account By AccountId |
| FINS Core Banking System API | get:/api/customers/{customerId} | Retrieve Customer by customerId |
| FINS Foreign Exchange System API | get:/api/rate | Retrive the exchange rate |
| FINS Payments Fedwire System API | post:/api/messages | Create Transaction On Fedwire |
| FINS Payments SWIFT System API | post:/api/messages | Create Transaction On SWIFT |
| FINS Core Banking System API | patch:/api/transactions/{transactionId} | Update Transaction status by transactionId |
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 to reflect the target deployment environment.
| Property Name | Description |
|---|---|
| api.autodiscoveryID | Required if using API Manager to secure this API |
| fins-payments-intrabankintl-prc-api.http-client.client-id | Client Id of the client app to access other API's |
| fins-payments-intrabankintl-prc-api.http-client.client-secret | Client Secret of the client app to access other API's |
| forex-sys-api.host | Foreign Exchange System API HostName |
| forex-sys-api.port | Foreign Exchange System API Port |
| forex-sys-api.base-path | Foreign Exchange System API Base path |
| forex-sys-api.ping-path | Foreign Exchange System API Ping path |
| payments-fedwire-sys-api.host | Payments Fedwire System API HostName |
| payments-fedwire-sys-api.port | Payments Fedwire System API Port |
| payments-fedwire-sys-api.base-path | Payments Fedwire System API Base path |
| payments-fedwire-sys-api.ping-path | Payments Fedwire System API Ping path |
| payments-ach-sys-api.host | Payments SWIFT System API HostName |
| payments-ach-sys-api.port | Payments SWIFT System API Port |
| payments-ach-sys-api.base-path | Payments SWIFT System API Base path |
| payments-ach-sys-api.ping-path | Payments SWIFT System API Ping path |
| corebanking-accounts-sys-api.host | Core Banking System API HostName |
| corebanking-accounts-sys-api.port | Core Banking System API Port |
| corebanking-accounts-sys-api.base-path | Core Banking System API Base path |
| corebanking-accounts-sys-api.ping-path | Core Banking System API Ping path |
| fins-notifications-prc-api.host | Notifications Process API HostName |
| fins-notifications-prc-api.port | Notifications Process API Port |
| fins-notifications-prc-api.base-path | Notifications Process API Base path |
| fins-notifications-prc-api.ping-path | Notifications Process API Ping path |
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 interfaces.
- Refer to the Accelerators documentation home for more information about the MuleSoft Accelerators.