fins-payments-interbanknatl-prc-api

(0 reviews)

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

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 Payments Fedwire System APIpost:/messagesPost a message in ISO 20022 format
FINS Payments ACH System APIpost:/messagesPost a message in ISO 20022 format
FINS Payments Swift System APIpost:/messagesPost a message in ISO 20022 format
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
FINS Foreign Exchange System APIget:/rateGet Exchange Rate
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
corebanking-accounts-sys-api.hostFINS Corebanking Accounts System API HostName
corebanking-accounts-sys-api.portFINS Corebanking Accounts System API Port
corebanking-accounts-sys-api.base-pathFINS Corebanking Accounts System API Base path
corebanking-customers-sys-api.hostFINS Corebanking Customers System API HostName
corebanking-customers-sys-api.portFINS Corebanking Customers System API Port
corebanking-customers-sys-api.base-pathFINS Corebanking Customers System API Base path
fins-notifications-prc-api.hostFINS Notifications Process API HostName
fins-notifications-prc-api.portFINS Notifications Process API Port
fins-notifications-prc-api.base-pathFINS Notifications Process API Base path
payments-fedwire-sys-api.hostFINS Payments Fedwire System API HostName
payments-fedwire-sys-api.portFINS Payments Fedwire System API Port
payments-fedwire-sys-api.base-pathFINS Payments Fedwire System API Base path
payments-ach-sys-api.hostFINS Payments ACH System API HostName
payments-ach-sys-api.portFINS Payments ACH System API Port
payments-ach-sys-api.base-pathFINS Payments ACH System API Base path
payments-swift-sys-api.hostFINS Payments SWIFT System API HostName
payments-swift-sys-api.portFINS Payments SWIFT System API Port
payments-swift-sys-api.base-pathFINS Payments SWIFT System API Base path
forex-sys-api.hostFINS Foriegn Exchange System API HostName
forex-sys-api.portFINS Foriegn Exchange System API Port
forex-sys-api.base-pathFINS 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


Reviews

TypeTemplate
OrganizationMulesoft Inc.
Published by
MuleSoft Solutions
Published onNov 10, 2023
Asset overview

Asset versions for 1.4.x

Asset versions
VersionActions
1.4.2
1.4.1
1.4.0