FINS Payments Web UI Experience API - Implementation Template
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.
FINS Payments Web UI Experience API provides operations for Payments WebUI to initiate domestic and international payments. Additionally Payments WebUI also provides socket end point to subscribe for payment notifications.
Overview
This integration template implements the FINS Payments Web UI Experience API. It supports the following functionalities:
- Initiate domestic and international payments.
- Socket endpoint to subscribe for payment notifications.
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
- FINS Core Banking System API
- FINS Foreign Exchange System API
- FINS Open Banking PISP International Experience API
- FINS Open Banking PISP Domestic Experience 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 Open Banking PISP Domestic Experience API | POST:/domestic-payments | Create PISP domestic payments |
| FINS Foreign Exchange System API | GET:/rate | Retrive Exchange rates |
| FINS Open Banking PISP International Experience API | POST:/international-payments | Create PISP International payments |
Anypoint MQ Destinations
In addition to the Anypoint MQ client application credentials, the following destinations must be created and made accessible to this API:
- fins-payments-webui-queue
The FINS Common Resources asset contains a Postman collection, which can be used to create the destinations and client application required for use by accelerator applications.
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 |
| anypoint-mq.server-url | Anypoint-mq server host url |
| anypoint-mq.client-id | Anypoint-mq client id |
| anypoint-mq.client-secret | Anypoint-mq client secret |
| 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-openbanking-pisp-intl-exp-api.host | FINS Open Banking PISP International Experience API HostName |
| fins-openbanking-pisp-intl-exp-api.port | FINS Open Banking PISP International Experience API Port |
| fins-openbanking-pisp-intl-exp-api.base-path | FINS Open Banking PISP International Experience API Base path |
| fins-openbanking-pisp-dom-exp-api.host | FINS Open Banking PISP Domestic Experience APII HostName |
| fins-openbanking-pisp-dom-exp-api.port | FINS Open Banking PISP Domestic Experience API Port |
| fins-openbanking-pisp-dom-exp-api.base-path | FINS Open Banking PISP Domestic Experience 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.