FINS Payments Remittances API - Implementation Template

(1 review)

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.

This API processes payment remittances between blockchain wallets.

Getting started

bulb.png 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:

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 nameEndpointAction
FINS Blockchain System APIpost:/paymentsCreate a New Payment to BlockChain node
FINS Core Banking Accounts System APIget:/accountsSearch Account using AccountId
FINS Core Banking Accounts System APIget:/transactionsSearch Transaction by OriginatorId
FINS Core Banking Accounts System APIpatch:/transactions/{transactionId}Update Transaction By TransactionId
FINS Core Banking Customers System APIget:/customers/{customerId}Get Customers By CustomerId
Accelerator Notifications Process APIpost:/notificationsSend 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 NameDescription
api.autodiscoveryIDRequired if using API Manager to secure this API
notifications.notifications-exchangeExchange to which notifications should be sent
notifications.sms-from-phonePhone number from which the Notification SMS messages should be triggered
sys.blockchain.hostFINS Blockchain System API HostName
sys.blockchain.portFINS Blockchain System API Port
sys.corebanking-accounts.hostFINS Core Banking Accounts System API HostName
sys.corebanking-accounts.portFINS Core Banking Accounts System API Port
sys.corebanking-customers.hostFINS Core Banking Customers System API HostName
sys.corebanking-customers.portFINS Core Banking Customers System API Port
prc.notifications.hostFINS Notifications Process API HostName
prc.notifications.portFINS Notifications Process API Port

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


Reviews

TypeTemplate
OrganizationMuleSoft
Published by
MuleSoft Solutions
Published onNov 8, 2023
Asset overview

Asset versions for 1.4.x

Asset versions
VersionActions
1.4.2
1.4.1
1.4.0