fins-payments-interbanknatl-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.
FINS Payments InterBank National Process API is to process payment transfers made through ACH and Fedwire processes across national banks.
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:
- FINS Core Banking Accounts System API
- FINS Core Banking Customers System API
- Accelerator Notifications Process API
- FINS Payments Fedwire System API
- FINS Payments ACH System API
- FINS Payments Swift System API
- FINS Foreign Exchange 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 |
|---|---|---|
| FINS Payments Fedwire System API | post:/messages | Post a message in ISO 20022 format |
| FINS Payments ACH System API | post:/messages | Post a message in ISO 20022 format |
| FINS Payments Swift System API | post:/messages | Post a message in ISO 20022 format |
| FINS Core Banking Accounts System API | get:/accounts | Search Account using AccountId |
| FINS Core Banking Accounts System API | get:/transactions | Search Transaction by OriginatorId |
| FINS Core Banking Accounts System API | patch:/transactions/{transactionId} | Update Transaction By TransactionId |
| FINS Core Banking Customers System API | get:/customers/{customerId} | Get Customers By CustomerId |
| FINS Foreign Exchange System API | get:/rate | Get Exchange Rate |
| Accelerator Notifications Process API | post:/notifications | Send Notifications |
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 |
| notifications.notifications-exchange | Exchange to which notifications should be sent |
| notifications.sms-from-phone | Phone number from which the Notification SMS messages should be triggered |
| corebanking-accounts-sys-api.host | FINS Corebanking Accounts System API HostName |
| corebanking-accounts-sys-api.port | FINS Corebanking Accounts System API Port |
| corebanking-accounts-sys-api.base-path | FINS Corebanking Accounts System API Base path |
| corebanking-customers-sys-api.host | FINS Corebanking Customers System API HostName |
| corebanking-customers-sys-api.port | FINS Corebanking Customers System API Port |
| corebanking-customers-sys-api.base-path | FINS Corebanking Customers System API Base path |
| fins-notifications-prc-api.host | FINS Notifications Process API HostName |
| fins-notifications-prc-api.port | FINS Notifications Process API Port |
| fins-notifications-prc-api.base-path | FINS Notifications Process API Base path |
| payments-fedwire-sys-api.host | FINS Payments Fedwire System API HostName |
| payments-fedwire-sys-api.port | FINS Payments Fedwire System API Port |
| payments-fedwire-sys-api.base-path | FINS Payments Fedwire System API Base path |
| payments-ach-sys-api.host | FINS Payments ACH System API HostName |
| payments-ach-sys-api.port | FINS Payments ACH System API Port |
| payments-ach-sys-api.base-path | FINS Payments ACH System API Base path |
| payments-swift-sys-api.host | FINS Payments SWIFT System API HostName |
| payments-swift-sys-api.port | FINS Payments SWIFT System API Port |
| payments-swift-sys-api.base-path | FINS Payments SWIFT System API Base path |
| forex-sys-api.host | FINS Foriegn Exchange System API HostName |
| forex-sys-api.port | FINS Foriegn Exchange System API Port |
| forex-sys-api.base-path | FINS Foriegn Exchange System API Base 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.