1.1 ServicesRequired for Integration
The services listed below are required for OBTFPMCS integration. P
Please make sure that the following services are available before the implementation.
| S No. | Provider System | Service URL | Service Description | Stage/Domain/Reason When Called | Remarks |
|---|---|---|---|---|---|
| 1. | ELCM | ELFacilityService/QueryFacility | Verify facilities availability | Scrutiny Stage/Trade Finance processes/Verify Limits Availability |
Service API which is used to verify the Limit for the specific customer Service used in (Scrutiny stage) : All Trade Process |
| 2. | ELCM | ELFacilityBlockService/CreateFacilityBlock | Earmark facilities available | Data Enrichment Stage/Trade Finance processes/Earmark Limits |
Service API which is used to block the Limit for the specific customer Service used in (Data Enrichment stage) : All Trade Process |
| 3. | ELCM | ELFacilityBlockService/CloseFacilityBlock | Release earmarking facilities available | Handoff Stage/Trade Finance processes/Release earmarked limits |
Service API which is used to Release the Limit for the specific customer Service used in (Hand off stage) : All Trade Process |
| 4. | FCUBS | FCUBSSTService/QueryKYCDetails | Verify KYC of a customer | Data Enrichment Stage/Trade Finance processes/To verify KYC of the customers |
Service API which is used to perform KYC check for the specific customer in back office / external system Service used in (Data Enrichment stage) : All Trade Process |
| 5. | OBTF | OBTFLCService/QueryContractSim | Contract Reference Number Generation | Registration, Scrutiny Stage(first stage)/Trade Finance processes/To generate contract reference number |
Service API which is used to generate a unique contract reference number from back office system. Service used in (Registration stage) : All Trade Process |
| 6. | OBTF | OBTFLCService/CreateContractSim | Simulation of LC Contract Creation |
Data Enrichment Stage/Import LC Issuance/Retrieve charges, commissions, taxes Data Enrichment Stage/Export LC Advise/Retrieve charges, commissions, taxes |
Service API which is used to calculate the charges, commissions and taxes at enrichment stage from back office system. Service used in (Data Enrichment stage) : Import LC Issuance Export LC Advise |
| 7. | OBTF | OBTFLCService/SummaryQueryContractSim | Summary Query For Contract |
Registration Stage/Import LC Amendment/To retrieve list of issued LC Registration Stage/Export LC Amendment/To retrieve list of advised LC Registration Stage/Import LC Drawing/To retrieve list of issued LC Registration Stage/Export LC Drawing/To retrieve list of advised LC |
Service API which is used to fetch the Approved Letter of credit contracts (summary) from back office system. Service used in (Registration stage) : Import LC Amendment Export LC Amendment Import LC Drawing Export LC Drawing process |
| 8. | OBTF | OBTFLCService/CreateContract | Create LC contract |
Handoff / Import LC Issuance / Handoff to the back-office system. Handoff / Export LC Advise / Handoff to the back-office system. |
Service API which is used to hand off the letter of credit contract details to back office system and create a new contract in back office. Service used in (Post Approval stage) : Import LC Issuance Export LC process |
| 9. | OBTF | OBTFLCService/QueryContract | Query LC Contract |
Registration Stage/Import LC Amendment/To retrieve details of a issued LC Registration Stage/Export LC Amendment/To retrieve details of a advised LC Registration Stage/Import LC Drawing/To retrieve details of a issued LC Registration Stage/Export LC Drawing/To retrieve details of a advised LC |
Service API which is used to fetch the Letter of credit contracts (details) from back office system. Service used in (registration stage) : Import LC Amendment Export LC Amendment Import LC Drawing Export LC Drawing process |
| 10. | OBTF | OBTFLCService/ModifyContract | Modify LC Contract | NA | - |
| 11. | OBTF | OBTFLCService/QueryAmendConfirm | Query LC Amendment Input |
Scrutiny Stage/Import LC Amendment/Retrieve details of a single LC Amendment Scrutiny Stage/Import LC Amendment Beneficiary Consent/Retrieve details of a single LC Amendment Scrutiny Stage/ Export LC Amendment and beneficiary Consent/Retrieve details of a single Amendment |
Service API which is used to fetch the Single amendment of Letter of credit contracts (details) from back office system. Service used in (Scrutiny stage) : Import LC Amendment Export LC Amendment process |
| 12. | OBTF | OBTFLCService/CreateAmendConfirm | Create LC Amendment Input | Handoff / Import LC Amendment |
Service API which is used to hand off the amendment details of letter of credit contract to back office system and create a new contract in back office. Service used in (Post approval stage) : Amendment of Import LC process Amendment of Export LC process |
| 13. | OBTF | OBTFLCService/ConfirmAmendConfirm | Confirm LC Amendment Input | Handoff Stage/Import LC Amendment Beneficiary Consent /Handoff the details to back-office system. |
Service API which is used to handoff Import LC / Export LC Amendment on Beneficiary Consent to back-office system. Service used in (Hand off stage) : Amendment of Import LC Beneficiary Consent process Amendment of Export LC Beneficiary Consent process |
| 14. | OBTF | OBTFLCService/AuthorizeAmendConfirm | Authorize LC Amendment Input | Handoff Stage/Import LC Amendment Beneficiary Consent /Authorize the handed off details to back-office system through OBTFLCService/ConfirmAmendConfirm |
Service API which is used to Authorize the Import LC / Export LC Amendment in back-office system. Service used in (Hand off stage) : Amendment of Import LC Beneficiary Consent process Amendment of Export LC Beneficiary Consent process |
| 15. | OBTF | OBTFLCService/SummaryQueryAmendConfirm | Summary Query LC Amendment Input | Registration Stage/Import LC Amendment Beneficiary Consent/Summary query to retrieve list of LC Amendments |
Service API which is used to fetch the amendment details of Letter of credit contracts (summary) from back office system. Service used in (Registration stage) : Amendment of Import LC Beneficiary Consent process Amendment of Export LC Beneficiary Consent process |
| 16. | OBTF | OBTFBCService/QueryContract | Query BC Contract |
Registration Stage / Import LC Drawing Amendment Import/Export update Documentary Collection / Retrieve the details of a single Import LC Drawing/ / Retrieve the details of a single Import Export Documentary Collection Booking/ Registration Stage / Import LC Drawing Liquidation / Retrieve the details of a single Import LC Drawing |
Service API which is used to fetch the Import / Export Bills contracts (details) from back office system. Service used in (Registration stage) : Import LC Drawing Amendment process Import LC Drawing Liquidation process Import/Export Update Documentary Collection Import/Export Documentary Collection Liquidation |
| 17. | OBTF | OBTFBCService/CreateContract | Create BC Contract |
Handoff Stage / Import /Export LC Drawing Import/Export Documentary Collection Booking / Handoff the details of a Import /Export LC Drawing Import/Export Documentary Collection Booking |
Service API which is used to create an Import / Export Bills contracts (details) in back office system. Service used in (Hand off stage) : Import /Export LC Drawing Import/Export Documentary Collection Booking |
| 18. | OBTF | OBTFBCService/ModifyContract | Modify BC Contract |
Handoff Stage / Import /Export LC Drawing Amendment / Handoff the details of a Import LC Drawing Amendment/Import/Export Update Documentary Collection Handoff Stage / Import LC Drawing Acceptance / Handoff the details of a Import LC Drawing Acceptance Import/Export Update Documentary Collection |
Service API which is used to amendment on the Import / Export Bills contracts (details) in back office system. Service used in (Hand off stage) : Import /Export LC Drawing Amendment Import /Export LC Drawing Acceptance Import/Export Update Documentary Collection Booking |
| 19. | OBTF | OBTFBCService/LiquidateContract | Liquidate BC Contract |
Handoff Stage / Import /Export LC Drawing Liquidation Import/Export Documentary Collection Liquidaton / Handoff the details of a Import /Export LC Drawing Liquidation Import/Export Documentary Collection Liquidation |
Service API which is used to Liquidate the Import / Export Bills contracts in back office system. Service used in (Hand off stage) : Import /Export LC Drawing Liquidation Import/Export Documentary Collection Liquidation |
| 20. | FCUBS | FCUBSBCService/ SummaryQueryBCContractSim | Summary Query BC Contract |
Registration Stage / Import LC Drawing Amendment Import/Export Update Documentary Collection / List of Import LC Drawing available/List of Import/Export Documentary collection bookings are available Registration Stage / Import LC Drawing Liquidation /Import/Export update and Liquidation of Documentary Collection/ List of Import LC Drawing available / List of Import /Export Documentary Collection available |
Service API which is used to fetch the Import / Export Bills contracts (summary) in back office system. Service used in (Hand off stage) : Import /Export LC Drawing Amendment Import /Export LC Drawing Liquidation Import/Export Update Documentary Collection Import/Export Documentary Collection Liquidation |
| 21. | OBTF | OBTFLCService/CreateGuarantee | Create Guarantee Contract | Handoff / Guarantee Issuance / Handoff to the back-office system. Handoff / Guarantee Advise / Handoff to the back-office system. | Service API which is used to create a guarantee contract (details) in back office system. Service used in (Hand off stage) : Guarantee Issuance Guarantee Advise |
| 22. | OBTF | OBTFLCService/QueryGuarantee | Query Guarantee Contract | NA | - |
| 23. | OBTF | OBTFBCService/CreateBCContractSim | Simulation of BC Contract Creation |
Scrutiny Stage / Import /Export LC Drawings / Import/Export Documentary Collection Booking Retrieve charges, commissions, taxes |
Service API which is used to calculate the charges, commissions and taxes of Bills contract from back office system. Service used in Scrutiny Stage ) : Import /Export LC Drawings Import/Export Documentary Collection Booking |
| 24. | OBTF | OBTFBCService/ModifyBCContractSim | Simulation of BC Contract Modification |
Scrutiny and Data Enrichment / Import /Export LC Drawing Amendment Import/Export Update Documentary Collection/ / Handoff the details of a Import LC Drawing Amendment/ Import/Export update Documentary Collection Scrutiny and Data Enrichment / Import LC Drawing Acceptance / Handoff the details of a Import LC Drawing Acceptance |
Service API which is used to modify the Bills contract in back office system. Service used in (Scrutiny and Data Enrichment stage) : Import LC Drawing Amendment Import LC Drawing Acceptance Import/Export Update Documentary Collection Process |
| 25. | OBTF | OBTFBCService/LiquidateBCContractSim | Simulation of BC Contract Liquidation |
Data Enrichment Stage / Import /ExportLC Liquidation/ Import/Export Documentary Collection Liquidation / Retrieve charges, commissions, taxes |
Service API which is used to fetch the charges, commission and charges during the liquidation of the Bills contract in back office system. Service used in ( Data Enrichment stage) : Import/Export LC Liquidation Import /Export Documentary Collection Liquidation |
| 26. | FCUBS | FCUBSCustomerService/QueryCustomer | Query Customer | Data Enrichment Stage/Trade Finance processes/ To retrieve customer details of a customer. | Service API which is used to fetch the customer details from back office system. Service used in ( Registration, Scrutiny and Data Enrichment stage) : All trade process |
| 27. | FCUBS | FCUBSCoreService/QueryAmountConversion | Query Amount Conversion | Data Enrichment Stage/Trade Finance processes/ Used for amount conversion as per the local currency and arrive at the number of approval levels needed. | Service API which is used to perform currency conversion in back office system. It is used to arrive the number of approvals is required to approve the contract Service used in (Data Enrichment stage) : All trade process |
| 28. | FCUBS | FCUBSAccService/QueryCustAcc | Query Customer Account | Data Enrichment Stage/Trade Finance processes/ To verify the account balance of a given customer account. | Service API which is used to fetch the account balance from back office system. Service used in (Data Enrichment stage) : All trade process |
| 29. | OBTF | OBTFMSService/QueryGetDcnMessages | Query Incoming Messages | Registration Stage / Export LC Advise / Retrieve the message of a given contract reference number. | Service API which is used to fetch the unprocessed SWIFT incoming message (details) from back office system. Service used in (Scrutiny stage) : Export LC Advise Process Amendment on Export LC Advise Process Guarantee advise Process |
| 30. | OBTF | OBTFMSService/ModifyGetDcnMessages | Modify Incoming Messages | Registration Stage / Export LC Advise / Modify the status of a message of a given contract reference number. This status denotes whether the message has been processed in the MID-OFFICE. | Service API which is used to update the status of the specific SWIFT incoming message in back office system. Service used in (Scrutiny stage) : Export LC Advise Process Amendment on Export LC Advise Process Guarantee advise Process |
| 31. | OBTF | OBTFMSService/SummaryQueryGetDcnMessages | SummaryQuery Incoming Messages | Registration Stage / Export LC Advise / Retrieve the list of messages for a given message type. Say for example list of messages of type MT700. | Service API which is used to fetch the all unprocessed SWIFT incoming messages (summary) from back office system. Service used in (Scrutiny stage) : Export LC Advise Process Amendment on Export LC Advise Process Guarantee advise Process |
| 32. | OBTF | OBTFCSService/QueryTFEvent | Query Contract Events | Registration Stage/Import LC Amendment//To retrieve the events on an Import LC Issuance. | Service API which is used to fetch the LC contract events details from back office system. Service used in (Registration stage) : Import LC Issuance Process |
| 33. | FCUBS | FCUBSFXService/SummaryQueryContract | SummaryQuery FX Contract | Data Enrichment Stage / Import LC Drawings / To retrieve list of FX contracts | Service API which is used to fetch the ForEx contract details (summary) from back office system. Service used in (Data Enrichment stage) : Import LC Drawings Process |
| 34. | FCUBS | FCUBSFXService QueryContract | Query FX Contract | Data Enrichment Stage / Import LC Drawings / To retrieve the details of a given FX contract | Service API which is used to fetch the ForEx contract details for a given contract (detail) from back office system. Service used in (Data Enrichment stage) : Import LC Drawings Process |
| 35. | FCUBS | FCUBSCustomerService.CreateAmtBlk | Create Amount Block | Data Enrichment Stage / Trade Finance processes / Create Amount Block | Service API which is used to block the amount for a given account Service used in (Data Enrichment stage) : All trade Process |
| 36. | FCUBS | FCUBSCustomerService.QueryAmtBlk | Query the details of an Amount Block. | Data Enrichment Stage / Trade Finance processes / Query the details of an Amount Block | Service API which is used to fetch the amount blocks for a given amount block reference no from back office Service used in (Data Enrichment stage) : All trade Process |
| 37. | FCUBS | FCUBSCustomerService.CloseAmtBlk | Close Amount Block | Handoff Stage / Trade Finance processes / Release Amount Block | Service API which is used to release the amount blocks for a given reference, in back office Service used in (Data Enrichment stage) : All trade Process |
| 38. | EXTERNAL SYSTEM | Sanctions Check | Perform Sanctions Check for a given transaction | Data Enrichment Stage/Trade Finance processes/To perform Sanctions Check of the customers | Service API which is used to trigger the external system - Sanction check service with customer details. It is an external service call. Service used in (Data Enrichment stage) : All trade Process |
| 39. | EXTERNAL SYSTEM | Anti-Money Laundering Check | Perform Anti Money Laundering Check for a given transaction | Data Enrichment Stage/Trade Finance processes/To perform AML Check of the customers | Service API which is used to trigger the external system
- Anti Money laundering check system with customer details. It is an
external service call.
Service used in (Data Enrichment stage) : All trade Process |
| 40 | OBA | obcdda-pp-transaction-balance-service/ob/oba/tbs/v1/balances/.search | Query Customer Account | Data Enrichment Stage/Trade Finance processes/ To verify the account balance of a given customer account. | Service API which is used to fetch the account balance from back office system. Service used in (Data Enrichment stage) : All trade process |
| 41 | OBA | obcdda-pp-transaction-balance-service/ob/oba/tbs/v1/transactions/legalBlocks | Create Amount Block | Data Enrichment Stage / Trade Finance processes / Create Amount Block | Service API which is used to block the amount for a given account Service used in (Data Enrichment stage) : |
| 42 | OBA | obcdda-pp-transaction-balance-service/ob/oba/tbs/v1/transactions/amountBlocks | Close Amount Block | Handoff Stage / Trade Finance processes / Release Amount Block | Service API which is used to release the amount blocks for a given reference, in back office Service used in (Data Enrichment stage) : All trade Process |
| 43 | OBTF | OBTFMSService/QueryTFInMsgBrowser | IncomingBrowserDetailedQuery | Trade Finance processes /To view Incoming Browser Details | Service API which is used to view the incoming message details for particular Reference No( Using view button in the Incoming Browser Screen) All trade process |
| 44 | OBTF | OBTFMSService/SummaryQueryTFInMsgBrowser | IncomingBrowserSummary | Trade Finance processes /To view Incoming Browser Summary Details | Service API which is used to list the incoming messages from the mszb_tf_dly_msg_in table ( Using search button in the Incoming Browser Screen). All trade process |
| 45 | OBTF | OBTFMSService/QueryTFOutmessage | OutgoingBrowserDetailedQuery | Trade Finance processes /To view Outgoing Browser Details | Service API which is used to list the outgoing messages from the mszb_tf_dly_msg_out table ( Using search button in the Outgoing Browser Screen). All trade process |
| 46 | OBTF | OBTFMSService/SummaryQueryTFOutmessage | OutgoingBrowserSummary | Trade Finance processes /To view Outgoing Browser summary Details | Service API which is used to list the outgoing messages from the mszb_tf_dly_msg_out table ( Using search button in the Outgoing Browser Screen). All trade process |
| 47 | OBTF | OBTFIFService/QueryTFContracts | ContractSummaryQuery | Trade Finance processes /To view Contract summary details | Service API which is used to list all the module related the contract details ( Using Reference No Lov call). All trade process |
| 48 | OBTF | OBTFMSService/QueryQueue | QueueSummaryQuery | Trade Finance processes /Queue summary Details | Service API which is used to list the Queue details( Using Queue Lov call). All trade process |
| 49 | OBTF | OBTFMSService/QueryLinkContract | LinkedContractQuery | Trade Finance processes /To link contract Details | Service API which is used to link contract Details. All trade process |
| 50 | OBTF | OBTFIFService/QueryTFContractList | SwiftContractSummaryQuery | Trade Finance processes /Swift related contract summary details | Service API which is used to query swift related contract details. ALL trade process enabled for SWIFT. |
Note:
If the above listed are not used, then the other back office/external systems must have similar APIs to achieve full benefits of OBTFPMCS application.| S. No. | Provider System | Service URL | Service Description | Stage/Domain/Reason When Called | Remarks |
|---|---|---|---|---|---|
| 1. | OBTF | OBTFBCService/CloseContract | CloseContract | / Handoff BC /Documentary Collection contract to the back-office system. Handoff / closing the contract / Handoff to the back-office system. |
Service API which is used to Close BC contract (details) in back office system. Service used in (Hand off stage) : Close BC contract Close Import/Export Documentary collection Contract |
| 2. | OBTF | OBTFBCService/CloseBCContractSim | CloseBCContractSim | Data Enrichment Stage BC/ Import/export Documentary Collection Contracts / Retrieve charges, commissions,taxes. | Service API which is used to close the Bills contract in back office system. Service used in (Scrutiny and Data Enrichment stage) : Import /export Documentary Collection Return process |
Parent topic: Integration Services