1.1 API’s of OBTFPMCS
The API’s listed below are required for OBTFPMCS application:
| S.No | Service Name | Service Description | Method | Header Details | Request Param | Response |
|---|---|---|---|---|---|---|
| 1. | obtfpmgatewayservices/i mport-lcissuance | Import LC Issuance Initiation Services This service owns the responsibility of initiating Import LC Issuance Trade Finance process | POST | Accept: application/json appId: OBTFPMGW branchCode: ContentType:application/js on source: sourceCode: userId: | Refer section '1.2.1 Import LC Issuance' | { "feedRespons e": { "field1": "203ILCIS002 0235", "field2": "203ILSN1832 65509", "data": null } } field1 : Application No field2 : DCN No from back office |
| 2. | obtfpmgatewayservices/i mport-lcamendment | Import LC Amendment Initiation Services This service owns the responsibility of initiating Import LC Amendment Trade Finance process. | POST | Accept: application/json appId: OBTFPMGW branchCode: ContentType:application/js on source: sourceCode: userId: | Refer section '1.2.2 Import LC Issuance' | { "feedRespons e": { "field1": "203ILCIS002 0235", "field2": "203ILSN1832 65509", "data": null } } field1 : Application No field2 : DCN No from back office |
| 3. | obtfpmgatewayservices/ discrepa ncyacceptan ce-byapplicant | Discrepancy Acceptance by Applicant Services This service owns the responsibility of initiating Discrepancy Acceptance by Applicant Services | POST | Accept: application/json appId: OBTFPMGW branchCode: ContentType:application/js on source: sourceCode: userId: | { "feedName": "discrepancyA cceptance" "feedData": {Json formated discrepancy acceptance details} } | { "feedRespons e": { "field1": "203ILCIS002 0235", "field2": "203ILSN1832 65509", "data": null } } field1 : Application No field2 : DCN No from back office |
| 4. | obtfpmgatewayservices/ guarante eissuance | Guarantee Issuance Initiation Services This service owns the responsibility of initiating Guarantee Issuance Trade Finance process | POST | Accept: application/json appId: OBTFPMGW branchCode: ContentType:application/js on source: sourceCode: userId: | Refer section '1.2.3 Guarantee Issuance Gateway Request Payload' | { "feedRespons e": { "field1": "203ILCIS002 0235", "field2": "203ILSN1832 65509", "data": null } } field1 : Application No field2 : DCN No from back office |
| 5. | obtfpmgatewayservices/i mport-lcdrawings - customer - acceptance | This service owns the responsibility of initiating Import LC Drawings - Customer Acceptance Trade Finance process. | POST | Accept: application/json appId: OBTFPMGW branchCode: ContentType:application/js on source: sourceCode: userId: | { "feedName": "importLcDraw ingsCustomer Acceptance" "feedData": {Json formated Import LC Drawings customerAcceptance contract details} } | { "feedRespons e": { "field1": "203ILCIS002 0235", "field2": "203ILSN1832 65509", "data": null } } field1 : Application No field2 : DCN No from back office |
| 6. | obtfpmgatewayservices/i mport-lcdrawings - applicant - response | This service owns the responsibility of initiating Import LC Drawings Applicant Response Trade Finance process. | POST | Accept: application/json appId: OBTFPMGW branchCode: ContentType:application/js on source: sourceCode: userId: | { "feedName": "importLcDraw ingsApplicant Response" "feedData": {Json formated Import LC Drawings Applicant response contract details} } | { "feedRespons e": { "field1": "203ILCIS002 0235", "field2": "203ILSN1832 65509", "data": null } } field1 : Application No field2 : DCN No from back office |
| 7. | obtfpm - gateway - services/i mport -lc - liquidation | This service owns the responsibility of initiating Import LC Liquidation Trade Finance process | POST | Accept: application/json appId: OBTFPMGW branchCode: Content - Type:application/js on source: sourceCode: userId: | Refer section '1.2.4 Import LC Liquidation Gateway Request' | { "feedRespons e": { "field1": "203ILCIS002 0235", "field2": "203ILSN1832 65509", "data": null } } field1 : Application No field2 : DCN No from back office |
| 8. | obtfpm - gateway - services/ export -lc - amendment - beneficiary - consent | This service owns the responsibility of initiating Export LC Amendment Beneficiary Consent Trade Finance process. | POST | Accept: application/json appId: OBTFPMGW branchCode: Content - Type:application/js on source: sourceCode: userId: | Refer section '1.2.5 Export LC Amendment Beneficiary Consent Request | { "feedRespons e": { "field1": "203ILCIS002 0235", "field2": "203ILSN1832 65509", "data": null } } field1 : Application No field2 : DCN No from back office |
| 9. | obtfpm - gateway - services/import - documentary - collection | This service owns the responsibility of initiating Import Documentary Collection Trade Finance process | POST | Accept: application/json appId: OBTFPMGW branchCode: Content - Type:application/js on source: sourceCode: userId: | Refer section '1.2.6 Import Documentary Collection Gateway Request' | { "feedRespon se": { "field1": "000IDCB000 027007", "field2": "000ISNC140 015013", "data": null } } |
| 10. | obtfpm - gateway - services/ export - documentary - collection | This service owns the responsibility of initiating Export Documentary Collection Trade Finance process. | POST | Accept: application/json appId: OBTFPMGW branchCode: Content - Type:application/js on source: sourceCode: userId: | Refer section '1.2.7 Export Documentary Collection Gateway Request' | { "feedRespon se": { "field1": "000EDCB000 027008", "field2": "000ESNC140 012503", "data": null } } |
| 11. | obtfpm - gateway - services/import - documentary - collection -update | This service owns the responsibility of initiating Import Documentary Collection Update TradeFinanc e process. | POST | Accept: application/json appId: OBTFPMGW branchCode: Content - Type:application/js on source: sourceCode: userId: | Refer section '1.2.8 Import Documentary Collection Update' | { "feedRespo nse": { "field1": "000IDCU000 027767", "field2": "null", "data": null } } |
| 12. | obtfpm - gateway - services/ export - documentary - collection -update | This service owns the responsibility of initiating Export Documentary Collection Update Trade Finance process. | POST | Accept: application/json appId: OBTFPMGW branchCode: Content - Type:application/js on source: sourceCode: userId: | Refer section '1.2.9 Export Documentary Collection Update Gateway Request:' | { "feedRespo nse": { "field1": "000EDCU000 027768", "field2": "null", "data": null } } |
| 13. | obtfpm - gateway - services/import - documentary - collection -liquidate | This service owns the responsibility of initiating Import Documentary Collection Liquidate Trade Finance process | POST | Accept: application/json appId: OBTFPMGW branchCode: Content - Type:application/js on source: sourceCode: userId: | Refer section '1.2.10 Import Documentary Collection Liquidate' | { "feedRespo nse": { "field1": "000IDCL0000 27771", "field2": "null", "data": null } } |
| 14. | obtfpm - gateway - services/ export - documentary - collection -liquidate | This service owns the responsibility of initiating Export Documentary Collection LiquidateTrade Finance process. | POST | Accept: application/json appId: OBTFPMGW branchCode: Content - Type:application/js on source: sourceCode: userId: | Refer section '1.2.11 Export Documentary Collection Liquidate' | { "feedRespo nse": { "field1": "000EDCL000 027770", "field2": "null", "data": null } } |
| 15. | platoorchservice/a pi/v1/extn /customactions/q ueries/ta sks | Trade Finance Application Search Services. These services provide the process management API's for the external systems to consume. This service contains API's to, 1) Search the status of a given Trade Finance application | POST | appId: platoorch branchCode: Content-Type: application/json source: EXTSYS sourceCode: EXTSYS userId: | {"userId":"SUJA NA01","taskStatu s":["ALLTASK"] ,"queryType":"A VAILABLE","q": "customerNumbe r eq 000823","custom erCondition":{"o perator":"IN","op erantList":["0008 23"]}} | Refer section '1.2.12 Task Search Response' |
| 16. | obtfpmverificatio nservices/ approve/ | These services allow customers of the bank to provide their acceptance or rejection of Trade Finance application from being further processed in the system. | POST | NA | NA | NA |
| 17. | cmc-documentmanage mentservices | This provides the API to retrieve list of documents to be uploaded for a given process | POST | branchCode: Content-Type: application/json source: gwhhtp sourceCode: gwhhtp userId: | Path Param: processCode stageCode applicationCat egoryCode | Refer section '1.2.13 Document management Response' |
| 18. | cmcdocument-services | This service is used to uploaded documents for a given Trade Finance Transaction | POST | NA | NA | Refer section '1.2.13 Document management Response' |
| 19. | cmccomment sservices | This service is used to capture remarks for a given Trade Finance Transaction | GET | branchCode: Content-Type: application/json userId: | Path Param: applicationNu mber | NA |
| 20. | NA | NA | POST | branchCode: Content -Type: application/json userId: | {"commentList ":[{"application NO":"NG1ELC A000004241", "entityRefNo":" NG1ELCA000 004241","emai l":"test@mail.c om","initiatorE mail":"test@m ail.com","initiat orName":"PA UL01","isInter nalToBank":tr ue,"sourceTyp e":"html","stag e":"Scrutiny"," subject":"TFP M_FA_ELCAD V_SCRTY","te xtObject":"LC document uploaded"}]} | {"commentList ":[{"id":"95ae7 4eb -9384 - 4b35 -871a - e75f2e3f401c" ,"applicationN O":"NG1ELCA 000004241","e ntityRefType": null,"entityRef No":"NG1ELC A000004241", "parentId":null, "recordStat":" O","stage":"Sc rutiny","source Type":"html"," subject":"TFP M_FA_ELCAD V_SCRTY","is InternalToBan k":true,"email": "test@mail.co m","initiatorEm ail":"test@mail .com","textObj ect":"LC document uploaded","ver sionNo":1,"initi atorName":"P AUL01","creat edDate":1551 346926000}]} |
| 21. | cmc - sequencegenerator - services | Generates Unique reference number based on keys | POST | Content -Type: application/json branchCode: source: OBTFPM sourceCode: OBTFPM appId: OBTFPM userId: | Refer section '1.2.14 Sequence Generator Request' | Refer section '1.2.15 Sequence Generator Response' |
| 22. | obtfpm - extsys - replicate d-dataproviderservices | This service caters to providing the list of products which are replicated from the back -office system. | GET | branchCode: Content -Type: application/json source: OBTFPM sourceCode: OBTFPM userId: | Path Param: productType tenorCode revolving | Refer section '1.2.16 Product Service Response' |
Parent topic: OBTFPMCS API’s