L FTP Web Services
FTP web services (v8.0) provide the capability to query Transfer Pricing results from existing account records and execute Transfer Pricing calculations against ad-hoc instruments in near real-time. The FTP web service calculations utilize the same transfer pricing methodologies and calculations that are used when running standard transfer pricing processes. FTP web services apply to all FTP calculations including Transfer Rates (all TP Methods), TP Add-on rates (all methods), and Breakage Charges. FTP web services are available to be called by any third party system within the bank.
FTP web services support the following use cases:
- Ability to query FTP information for existing instrument records for a specified date.
- Ability to query FTP Daily Rate Card information for standard products.
- Ability to execute an existing TP Process in real-time, which can refer to any TP Rule, Prepayment Rule, Adjustment Rule, and (optionally) an Alternate Rate Output Mapping assumption for a single ad-hoc instrument record.
- Ability to calculate an Economic Loss Breakage Charge in real-time, for an ad-hoc instrument record.
Topics:
- Important Changes in OFSAA Release 8.1
- How to test and execute the FTP Web Services?
- Configure the FTP Web Services
- Use the Web API Testing Tool
- Description of FTP Web Services
- Web Service name: getTPRate
- Web Service name: getEconomicCostWithParameters
- Web Service name: getPricing
- Web Service name: getPricingData
- Payment Schedule Enhanced FTP Web Service
- Web Service Changes for GDPR
- Java Programs for Testing the FTP Web Service
- Additional Configuration Needed for Economic Cost Web Services
- Important Changes in OFSAA Release 8.1
Starting with release 8.1, FTP is supporting only Restful services for FTP Web Services. The previous versions were supporting SOAP-based services. OFSAA has decided to move to REST as it is becoming the de facto communication mechanism across various platforms. REST is faster and uses less bandwidth. It is also easier to integrate REST with the existing applications with no need to re-factor infrastructure. This enables integration faster. - How to test and execute the FTP Web Services?
All the web services require a JSON template (request.json) to be submitted along with the web service request. The JSON template provides the necessary details to the web service allowing it to perform the requested action. - Configure the FTP Web Services
FTP Web services configuration parameters are given in the ofsaaws.properties file under $FIC_WEB_HOME/WEB-INF/classes directory. - Use the Web API Testing Tool
Testing of these web services can be done by using any standard web API testing tool available on the Internet like Postman, HTTP Master, or Rest-assured. - Description of FTP Web Services
The following use cases refer to a single java program (FTPWSclient.jar), which is available from the OFSAA Support Team. - Web Service Name: getTPRate
Ability to query existing instrument records that contain FTP information for a specified date. - Web Service Name: getEconomicCostWithParameters
Ability to calculate a breakage charge in real-time, for a specified instrument record. - Web Service name: getPricing
Ability to execute an existing TP Process which can refer to any TP Rule, Prepayment Rule, Adjustment Rule, and (optionally) an Alternate Rate Output Mapping assumption in real time for a single ad-hoc instrument record. - Web Service name: getPricingData
The getPricing service invokes the server process in real-time and waits for the calculated values to be returned by the engine. If the server processing time exceeds the allotted time limit, the web service will return only the REQUEST_ID. In this case, you can re-query the results using the getPricingData web service. - Payment Schedule Enhanced FTP Web Service
Users have the option to pass payment schedule details with the Economic Cost web service if required. - Web Service Changes for GDPR
A new parameter is introduced for FTPgetEconomicCostWithparametersandgetTPRateweb services that determine the lookup column for account number Field in FSI instrument tables. - Java Programs for Testing the FTP Web Services
The following Java programs that call the FTP web services and are referenced in the above examples: - Additional Configuration Needed for Economic Cost Web Services
Economic Cost Web Services make Java Native Interface call to invoke the calculation engine. So the expectation is that the calculation engine libraries to be available in the same box, where the web service is deployed. In your environment, if the webs server and FIC Server are on different boxes, follow these additional setups to use the Economic Cost Web Services: