FINS Payments Order Process 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.
Overview
This integration template implements the FINS BIAN Payment Order Process API specification.
FINS BIAN Payments Order Process API handles the bank-side processing of funds transfers. Payment Order handles the internal bank and compliance checks and processing of funds transfers prior to initiating the actual mechanics of transfer which is handled by the service domain Payment Execution.
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
- Payments Router Process API
- Financial Institutions System API
- Payments InterBank International Execution Process API
- Payments IntraBank International Execution Process API
- Payments InterBank National Execution Process API
- Payments IntraBank National Execution Process API
- Payments Remittances Process API
- Accelerator Notifications Process 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 |
---|---|---|
Financial Institutions System API | get:/institutions | Search Institutions |
FINS Core Banking Accounts System API | get:/accounts | Search Account using AccountId |
Fraud Analysis System API | post:/payments | Post balances to check fraud |
Payments Router Process API | post:/PaymentExecution | To determine routing paths based on specific payment details and stage of the process |
Payments InterBank International Execution Process API | post:/PaymentExecution/Initiate | Initiate a payment execution procedure of InterBank International Execution Process |
Payments IntraBank International Execution Process API | post:/PaymentExecution/Initiate | Initiate a payment execution procedure of Payments InterBank National Execution Process |
Payments InterBank National Execution Process API | post:/PaymentExecution/Initiate | Initiate a payment execution procedure of Payments InterBank National Execution Process |
Payments IntraBank National Execution Process API | post:/PaymentExecution/Initiate | Initiate a payment execution procedure of IntraBank National Execution Process |
Payments Remittances Process API | post:/PaymentExecution/Initiate | Initiate a payment execution procedure of Remittances Execution Process |
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 |
fins-payments-order-prc-api.http-client.client-id | Client Id of the client app to access other API's |
fins-payments-order-prc-api.http-client.client-secret | Client Secret of the client app to access other API's |
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.