Import LC APIs
The following APIs are end to end integrated with Transact.
| Name | Description | Introduced In |
|---|---|---|
| createImportLC | This API creates the letter of credits imports. | 2021.10 |
The following are the Experience APIs for Import LC.
| Name | Description | Introduced In |
|---|---|---|
| getImportLCs | This API retrieves the letter of credit imports. | 2021.10 |
| getLetterOfCreditsById | This API retrieves the letter of credit imports by ID. | 2021.10 |
| deleteImportLC | This API deletes the letter of credits imports. | 2021.10 |
| generate | This API downloads the letter of credit imports. | 2021.10 |
| updateImportLCByBank | This is a mock service to update Import LC by Bank. | 2023.01 |
| Object Data Model | This Object Data Model describes the parameter name and other attribute details for Trade Finance. |
| Description: | This API creates the letter of credits imports. |
| Method: | POST |
| URL: | {base_url}/services/data/v1/TradeFinance/operations/LetterOfCredit/createImportLC |
| Security Level: | Authenticated App User |
| Header Request: | X-Kony-Authorization |
| Body Request: |
Parameters tolerancePercentage Specifies the number for tolerance Percentage. tranferable(Mandatory) Specifies whether transferable or not. lcAmount(Mandatory) Specifies the LC amount. chargesAccount(Mandatory) Specifies the chages for the account. isDraft(Mandatory) Specifies whether it can be draft account or not. This is a Boolean. documentsRequired Specifies whether documents are required or not. beneficiaryName(Mandatory) Specifies the name of beneficiary. expiryPlace(Mandatory) Specifies the place for expiry. lcReferenceNo(Mandatory) Specifies the lcReferenceNo. paymentTerms(Mandatory) Specifies the terms of payment. beneficiaryState(Mandatory) Specifies the state name of the beneficiary. incoTerms(Mandatory) Specifies the incoTerms. confirmationInstruction(Mandatory) Specifies the confirmation instruction. descriptionOfGoods Specifies the Goods description. lcCurrency(Mandatory) Specifies the name of currency . placeOfFinalDelivery Specifies the place for final delivery. latestShippingDate Specifies the last shipping date. messageTobank Specifies the message to the bank. beneficiaryBankCity(Mandatory) Specifies the city name of the beneficiary bank. additionalAmountPayable Specifies the additional payable amount. maximumCreditAmount Specifies the maximum credit amount . beneficiaryBank(Mandatory) Specifies the name of beneficiary bank. presentationPeriod Specifies the period. marginAccount Specifies the margin amount. additionalPayableCurrency(Mandatory) Specifies the currency name for additional payable amount. otherAdditionalConditions Specifies the additional conditions. fileToUpload(Mandatory) Specifies whether there is file to upload. portOfDischarge Specifies the country name for port of discharge. modeOfShipment Specifies the mode of shipment. commisionAccount Specifies the total commission account. beneficiaryAddressLine1(Mandatory) Specifies the first line of beneficiary address. beneficiaryAddressLine2(Mandatory) Specifies the second line of beneficiary address. expiryDate(Mandatory) Specifies the expiry date. beneficiaryPostCode(Mandatory) Specifies the postal code for beneficiary. supportDocuments Specifies whether there are support documents. issueDate(Mandatory) Specifies the date of issue. standByLC(Mandatory) Specifies whether the standByLC. partialShipments Specifies whether there are partial shipments. transshipment Specifies whether there are transhipment. benficiaryBankCountry(Mandatory) Specifies the beneficiary name of country. documentCharges Specifies whether if there are document charges. beneficiaryBankState(Mandatory) Specifies the beneficiary bank state name. beneficiaryCity(Mandatory) Specifies the beneficiary bank city name. softDeleteFlag(Mandatory) Specifies if there is softDeleteFlag. additionalConditionsCode Specifies the additional condition codes. beneficiaryBankPostCode(Mandatory) Specifies the beneficiary bank postal code. beneficiaryBankAddressLine1(Mandatory) Specifies the first line of address of beneficiary bank.beneficiaryBankAddressLine2(Mandatory) Specifies the second line of address of beneficiary bank. portOfLoading Specifies the country name of loading. flowType(Mandatory) Specifies the type of flow. Case 1: Flow type = draft {
"tolerancePercentage": "",
"transferable": "Yes",
"lcAmount": "6000",
"chargesAccount": "",
"isDraft": "false",
"documentsRequired": "No",
"beneficiaryName": "Rashmi",
"expiryPlace": "abc",
"lcReferenceNo": "LC125471234",
"paymentTerms": "Negotiation",
"beneficiaryState": "TN",
"incoTerms": "CIF",
"confirmationInstruction": "May Add",
"descriptionOfGoods": "NIL",
"lcCurrency": "USD",
"placeOfTakingIncharge": "India",
"beneficiaryCountry": "India",
"placeOfFinalDelivery": "India",
"latestShippingDate": "12/12/76",
"messageToBank": "NIL",
"beneficiaryBankCity": "Chennai",
"additionalAmountPayable": "",
"beneficiaryBank": "ABCBank",
"presentationPeriod": "",
// "marginAccount": "121908",
"additionalPayableCurrency": "INR",
"otherAdditionalConditions": "NIL",
"fileToUpload": "No",
"portOfDischarge": "India",
"modeOfShipment": "Air",
// "commisionAccount": "121908",
"beneficiaryAddressLine1": "abc",
"beneficiaryAddressLine2": "B",
"expiryDate": "12/12/2020",
"beneficiaryPostCode": "122",
"supportDocuments": "No",
"issueDate": "12/12/2020",
"standByLC": "No",
"partialShipments": "Not Allowed",
"transshipment": "Yes",
"beneficiaryBankCountry": "India",
"documentCharges": "12",
"beneficiaryBankState": "TN",
"beneficiaryCity": "Chennai",
"additionalConditionsCode": "20123",
"beneficiaryBankPostCode": "222",
"availableWith1": "123",
"availableWith2": "Q",
"availableWith4": "B",
"availableWith3": "V",
"beneficiaryBankAdressLine2": "",
"portOfLoading": "India",
"beneficiaryBankAdressLine1": "abc",
"flowType": "draft"
}Case 1: Flow type = finalSubmit {
"tolerancePercentage": "",
"transferable": "Yes",
"lcAmount": "6000",
"chargesAccount": "",
"isDraft": "false",
"documentsRequired": "No",
"beneficiaryName": "Rashmi",
"expiryPlace": "abc",
"lcReferenceNo": "LC125471234",
"paymentTerms": "Negotiation",
"beneficiaryState": "TN",
"incoTerms": "CIF",
"confirmationInstruction": "May Add",
"descriptionOfGoods": "NIL",
"lcCurrency": "USD",
"placeOfTakingIncharge": "India",
"beneficiaryCountry": "India",
"placeOfFinalDelivery": "India",
"latestShippingDate": "12/12/76",
"messageToBank": "NIL",
"beneficiaryBankCity": "Chennai",
"additionalAmountPayable": "",
"beneficiaryBank": "ABCBank",
"presentationPeriod": "",
// "marginAccount": "121908",
"additionalPayableCurrency": "INR",
"otherAdditionalConditions": "NIL",
"fileToUpload": "No",
"portOfDischarge": "India",
"modeOfShipment": "Air",
// "commisionAccount": "121908",
"beneficiaryAddressLine1": "abc",
"beneficiaryAddressLine2": "B",
"expiryDate": "12/12/2020",
"beneficiaryPostCode": "122",
"supportDocuments": "No",
"issueDate": "12/12/2020",
"standByLC": "No",
"partialShipments": "Not Allowed",
"transshipment": "Yes",
"beneficiaryBankCountry": "India",
"documentCharges": "12",
"beneficiaryBankState": "TN",
"beneficiaryCity": "Chennai",
"additionalConditionsCode": "20123",
"beneficiaryBankPostCode": "222",
"availableWith1": "123",
"availableWith2": "Q",
"availableWith4": "B",
"availableWith3": "V",
"beneficiaryBankAdressLine2": "",
"portOfLoading": "India",
"beneficiaryBankAdressLine1": "abc",
"flowType": "finalSubmit"
} |
| Response: |
Parameters srmsReqOrderID(Mandatory) Specifies the unique ID for srmsReqOrderID. status(Mandatory) Specifies the status. Case 1: Flow type = draft {
"srmsReqOrderID": "LOCI22181457FU",
"status": "Draft",
"opstatus": 0,
"httpStatusCode": 0
}
Case 1: Flow type = finalSubmit {
"srmsReqOrderID": "LOCI21281D8LXV",
"status": "Approved",
"opstatus": 0,
"httpStatusCode": 0
}
|
| Error Code(s): |
|
| Enterprise Provider: |
Transact |
| Enterprise API: |
{base_url}/api/v3.0.0/holdings/letterOfCredits/initiations |
Field Mapping
| UI Field | Experience API field | Transact API Field |
|---|---|---|
| Tolerance Percentage | tolerancePercentage | PERCENTAGE.CR.AMT (S) |
| Beneficiary | beneficiaryName | BENEFICIARY |
| Goods of description | descriptionOfGoods | DESC.GOODS (M) |
| Place Of Taking Incharge | placeOfTakingIncharge | SHIP.DISPATCH |
| Beneficiary Address | beneficiaryCountry | BENEFICIARY |
| Beneficiary Address | beneficiaryBankCity | ADVISING.BK |
| Beneficiary Bank | beneficiaryBank | ADVISING.BK |
| Other Additional Conditions | otherAdditionalConditions | ADDITIONL.CONDS |
| Port Of Discharge | portOfDischarge | TRANSPORTATION |
| Mode Of Shipment | modeOfShipment | MODE.OF.SHIPMENT(S) |
| Beneficiary Address | beneficiaryAddressLine1 | BENEFICIARY |
| Beneficiary Address | beneficiaryAddressLine2 | BENEFICIARY |
| Expiry Date | expiryDate | ADVICE.EXPIRY.DATE |
| Beneficiary Address | beneficiaryPostCode | BENEFICIARY |
| Issue Date | issueDate | ISSUE.DATE (S) |
| Partial Shipments | partialShipments | PART.SHIPMENTS |
| Transshipment | transshipment | TRANSSHIPMENTS |
| Beneficiary Address | beneficiaryBankCountry | ADVISING.BK |
| Charges | documentCharges | NARRATIVE.CHRGS |
| Beneficiary Bank Address | beneficiaryBankState | ADVISING.BK |
| Beneficiary Address | beneficiaryCity | BENEFICIARY |
| Beneficiary Address | beneficiaryConditionsCode | BENEFICIARY |
| Available With | availableWith1 | AVAILABLE.WITH |
| Available With | availableWith2 | AVAILABLE.WITH |
| Available With | availableWith4 | AVAILABLE.WITH |
| Available With | availableWith3 | AVAILABLE.WITH |
| Beneficiary Bank Address | beneficiaryBankAddressLine2 | ADVISING.BK |
| Port Of Loading | portOfLoading | OTHER.DESPATCH.DET |
| Beneficiary Bank Address | beneficiaryBankAddressLine1 | ADVISING.BK |
| Beneficiary Address | beneficiaryState | BENEFICIARY |
| Beneficiary Bank Address | beneficiaryBankPostCode | ADVISING.BK |
| Additional Condition Code |
| Description: | This API retrieves the letter of credit imports. |
| Method: | POST |
| URL: | {base_url}/services/data/v1/TradeFinance/operations/LetterOfCredit/getImportLCs |
| Security Level: | Authenticated App User |
| Header Request: | X-Kony-Authorization |
| Body Request: |
Parameters searchString Specifies the free text that can be entered to search for a set of records that matches the text that is entered. pageSize Specifies the total number of pages retrieved by search.pageOffset Specifies the fist page number to display the search, sortByParam Specifies the field in the response based on which the list of records must be sorted. By default, the list of records would be sorted based on the date on which the request was sent (sentDate). sortOrder Specifies the order in which the list of fetched records must be sorted, such as in ascending or descending (ASC/DESC) order. By default, the value is set to DESC for the date on which the request was sent (sentDate). timeParam Specifies the uploaded date. timeValue Specifies the last number of periods (Days, Weeks, Months, Year). filterByValue Specifies the value based on which the fetched files must be filtered. filterByParam Specifies the parameter value to filter. fromDateFilter Specifies the start date for the search. toDateFilter Specifies the end date for the search. {
"tolerancePercentage": "1234566",
"transferable": "Yes",
"lcAmount": "18",
"chargesAccount": "1",
"isDraft": "true",
"documentsRequired": "No",
"beneficiaryName": "test1",
"expiryPlace": "abc",
"lcReferenceNo{
"searchString": "",
"pageSize": "1000",
"pageOffset": "0",
"sortByParam": "",
"sortOrder": "",
"timeParam": "",
"timeValue": "",
"filterByValue": "",
"filterByParam": "",
"fromDateFilter": "",
"toDateFilter": ""
} |
| Response: |
Parameters lcReferenceNo(Mandatory) Specifies the unique lcReferenceNo. lcAmount(Mandatory) Specifies the amount for the transaction. lcCurrency(Mandatory) Specifies the name of currency. tolerancePercentage Specifies the tolerance percentage in positive or negative value. maximumCreditAmount Specifies the maximum credit amount. additionalAmountPayable Specifies the extra amount payable. availableWith1(Mandatory) Specifies if it is available with the bank details of specific LC. availableWith2(Mandatory) Specifies if it is available with the bank details of specific LC. availableWith3(Mandatory) Specifies if it is available with the bank details of specific LC. availablewith4(Mandatory) Specifies if it is available with the bank details of specific LC. issueDate(Mandatory) Specifies the time stamp of LC created date. expiryDate(Mandatory) Specifies the time stamp of LC expiry date. expiryPlace(Mandatory) Specifies the location name of LC expiry. chargesAccount Specifies the charges deductable account. commisionAccount Specifies the account for commission.. marginAccount Specifies the account for margin money. messageToBank Specifies the message to the bank. paymentTerms(Mandatory) Specifies the payment terms. beneficiaryName(Mandatory) Specifies the name of the beneficiary. beneficiaryAddressLine1(Mandatory) Specifies the first line of beneficiary address . beneficiaryAddressLine2(Mandatory) Specifies the second line of beneficiary address . beneficiaryPostCode(Mandatory) Specifies the Zipcode of beneficiary. beneficiaryCountry(Mandatory) Specifies the country name of beneficiary. beneficiaryCity(Mandatory) Specifies the city name of beneficiary. beneficiaryState(Mandatory) Specifies the state name of beneficiary. beneficiaryBank(Mandatory) Specifies name of the beneficiary bank. beneficiaryBankAddressLine1(Mandatory) Specifies the first line of bank address . beneficiaryBankAddressLine2(Mandatory) Specifies the second line of bank address . beneficiaryBankPostCode Specifies the Zipcode of bank location. beneficiaryBankCountry Specifies the country name of the bank location. beneficiaryBankCity(Mandatory) Specifies the city name of bank location. beneficiaryBankState(Mandatory) Specifies the state name of bank location. placeOfTakingIncharge(Mandatory) Specifies the place of taking in-charge. portOfLoading Specifies the loading port name. portOfDischarge Specifies the unloading port name. placeOfFinalDelivery Specifies the final delivery location. latestShippingDate Specifies the time stamp of shipping date. transshipment Specifies the transshipment details. incoTerms(Mandatory) Specifies the inco terms. modeOfShipment Specifies the mode of shipping. descriptionOfGoods Specifies the description of goods. additionalConditionsCode Specifies if any additional conditional codes are applicable. otherAdditionalConditions Specifies the other additional conditions for LC. documentCharges Specifies the charges for documentation. supportDcouments Specifies the supporting document for LC. fileToUpload Specifies he files for LC. confirmationInstruction(Mandatory) Specifies the instructions for confirmations. transferable(Mandatory) Specifies if the LC is transferable. standByLC(Mandatory) Specifies the lenders guarantee payment to an interested third party. isDraft(Mandatory) Specifies if the LC is a draft or submitted. additionalPayableCurrency(Mandatory) Specifies the additional payable currency. status(Mandatory) Specifies the status of LC. srmsReqOrderID(Mandatory) Specifies the unique srmsReqOrderID lcCreatedOn(Mandatory) Specifies the time stamp of LC created date. draftCount(Mandatory) Specifies the total count of drafts with user. draftAmount(Mandatory) Specifies the sum of draft amount. deletedCount(Mandatory) Specifies the total count of deleted LC with user. deletedAmount(Mandatory) Specifies the sum of deleted LC. selfApprovedCount(Mandatory) Specifies the count of submitted LC for user. selfApprovedAmount(Mandatory) Specifies the sum of self approved LC. totalCount(Mandatory) Specifies the total LC created by user. totalAmount(Mandatory) Specifies the total amount for all LC. {
"lcReferenceNo": "123456",
"lcAmount": "2000",
"lcCurrency": "EURO",
"tolerancePercentage": "200",
"maximumCreditAmount": "505",
"additionalAmountPayable": "55",
"availableWith1": "vol",
"availableWith2": "Ut ",
"availableWith3": "et ",
"availableWith4": "et",
"issueDate": "2021-10-11T09:52:22Z",
"expiryDate": "2021-12-01T00:00:00Z",
"expiryPlace": "2021-10-29",
"chargesAccount": "5",
"commisionAccount": "4",
"marginAccount": "ad",
"messageToBank": "done",
"paymentTerms": "tttt",
"beneficiaryName": "san1",
"beneficiaryAddressLine1": "abccdef",
"beneficiaryAddressLine2": "quis",
"beneficiaryPostCode": "10025",
"beneficiaryCountry": "India",
"beneficiaryCity": "Bangalore",
"beneficiaryState": "KT",
"beneficiaryBank": "XYZ1ABC Bank",
"beneficiaryBankAdressLine1": "abc",
"beneficiaryBankAdressLine2": "occaecat",
"beneficiaryBankPostCode": "111",
"beneficiaryBankCountry": "India",
"beneficiaryBankCity": "Bangalore",
"beneficiaryBankState": "KT",
"placeOfTakingIncharge": "bbb",
"portOfLoading": "bbb",
"portOfDischarge": "eee",
"placeOfFinalDelivery": "xxxx",
"latestShippingDate": "2021-11-11",
"presentationPeriod": "aaa",
"transshipment": "nono",
"partialShipments": "cc",
"incoTerms": "88",
"modeOfShipment": "done2",
"descriptionOfGoods": "all",
"documentsRequired": "yes",
"additionalConditionsCode": "111",
"otherAdditionalConditions": "111",
"documentCharges": "12",
"supportDocuments": "test",
"fileToUpload": "ccx",
"confirmationInstruction": "test",
"transferable": "Yes",
"standByLC": "No",
"isDraft": "true",
"additionalPayableCurrency": "USD",
"status": "In Progress",
"srmsReqOrderID": "LOCI21274OSZGI",
"lcCreatedOn": "2021-10-01T00:00:00Z",
"draftCount": "0",
"draftAmount": "0",
"deletedCount": "0",
"deletedAmount": "0",
"selfApprovedCount": "0",
"selfApprovedAmount": "0",
"totalCount": "0",
"totalAmount": "0"
}
|
| Error Code(s): |
|
| Enterprise Provider: | |
| Enterprise API: |
Field Mapping
| UI Field | Experience API Field | Transact API Field |
|---|---|---|
| NA | searchString | NA |
| NA | pageSize | NA |
| NA | pageOffset | NA |
| NA | sortByParam | NA |
| NA | sortOrder | NA |
| NA | timeParam | NA |
| NA | timeValue | NA |
| NA | filterByValue | NA |
| NA | filterByParam | NA |
| NA | fromDateFilter | NA |
| NA | toDateFilter | NA |
| LC Reference Number | lcReferenceNo | NA |
| Amount | lcAmount | NA |
| Currency | lcCurrency | NA |
| Tolerance Percentage | tolerancePercentage | NA |
| Maximum Credit Amount | maximumCreditAmount | NA |
| Additional Payable Amount | additionalAmountPayable | NA |
| Available With | availableWith1 | NA |
| Available With | availableWith2 | NA |
| Available With | availableWith3 | NA |
| Available With | availableWith4 | NA |
| Issue Date | issueDate | NA |
| Expiry Date | expiryDate | NA |
| Expiry Place | expiryPlace | NA |
| Charges Account | chargesAccount | NA |
| Commision Account | commisionAccount | NA |
| Margin Account | marginAccount | NA |
| Message To Bank | messageToBank | NA |
| Payment Terms | paymentTerms | NA |
| Beneficiary | beneficiaryName | NA |
| Beneficiary Address | beneficiaryAddressLine1 | NA |
| Beneficiary Address | beneficiaryAddressLine2 | NA |
| Beneficiary Address | beneficiaryPostCode | NA |
| Beneficiary Address | beneficiaryCountry | NA |
| Beneficiary Address | beneficiaryCity | NA |
| Beneficiary Address | beneficiaryState | NA |
| Beneficiary Bank | beneficiaryBank | NA |
| Beneficiary Bank Address | beneficiaryBankAdressLine1 | NA |
| Beneficiary Bank Address | beneficiaryBankAdressLine2 | NA |
| Beneficiary Bank Address | beneficiaryBankPostCode | NA |
| Beneficiary Bank Address | beneficiaryBankCountry | NA |
| Beneficiary Bank Address | beneficiaryBankCity | NA |
| Beneficiary Bank Address | beneficiaryBankState | NA |
| Place Of Taking Incharge | placeOfTakingIncharge | NA |
| Port Of Loading | portOfLoading | NA |
| Port Of Discharge | portOfDischarge | NA |
| Place Of Final Delivery | placeOfFinalDelivery | NA |
| Latest Shipping Date | latestShippingDate | NA |
| Transshipment | transshipment | NA |
| Partial Shipments | partialShipments | NA |
| IncoTerms | incoTerms | NA |
| Mode Of Shipment | modeOfShipment | NA |
| Goods of description | descriptionOfGoods | NA |
| Documents Required | documentsRequired | NA |
| Additional Conditions Code | additionalConditionsCode | NA |
| Other Additional Conditions | otherAdditionalConditions | NA |
| Charges | documentCharges | NA |
| Confirmation Instruction | confirmationInstruction | NA |
| Transferable | transferable | NA |
| Stand By LC | standByLC | NA |
| NA | isDraft | NA |
| NA | presentationPeriod | NA |
| Additional Payable Amount | additionalPayableCurrency | NA |
| Status | status | NA |
| NA | srmsReqOrderID | NA |
| NA | lcCreatedOn | NA |
| NA | draftCount | NA |
| NA | draftAmount | NA |
| NA | deletedCount | NA |
| NA | deletedAmount | NA |
| NA | selfApprovedCount | NA |
| NA | selfApprovedAmount | NA |
| NA | totalCount | NA |
| NA | totalAmount | NA |
| Description: | This API retrieves the letter of credit imports by ID. |
| Method: | POST |
| URL: | {base_url}/ services/data/v1/TradeFinance/operations/LetterOfCredit/getLetterOfCreditsById |
| Security Level: | Authenticated App User |
| Header Request: | X-Kony-Authorization |
| Body Request: |
Parameters srmsReqOrderID(Mandatory) Specifies the unique srmsReqOrderID. {
"srmsReqOrderID": "LOCI21280OXHQP"
}
|
| Response: |
Parameters lcReferenceNo(Mandatory) Specifies the unique lcReferenceNo. lcAmount(Mandatory) Specifies the amount for the transaction. lcCurrency(Mandatory) Specifies the name of currency. tolerancePercentage Specifies the tolerance percentage in positive or negative value maximumCreditAmount Specifies the maximum credit amount. additionalAmountPayable Specifies the extra amount payable. availableWith1(Mandatory) Specifies if it is available with the bank details of specific LC. availableWith2(Mandatory) Specifies if it is available with the bank details of specific LC. availableWith3(Mandatory) Specifies if it is available with the bank details of specific LC. availablewith4(Mandatory) Specifies if it is available with the bank details of specific LC. issueDate(Mandatory) Specifies the time stamp of LC created date. expiryDate(Mandatory) Specifies the time stamp of LC expiry date. expiryPlace(Mandatory) Specifies the location name of LC expiry. chargesAccount Specifies the charges deductable account. commisionAccount Specifies the account for commission. marginAccount Specifies the account for margin money. messageToBank Specifies the message to the bank. paymentTerms(Mandatory) Specifies the payment terms. beneficiaryName(Mandatory) Specifies the name of the beneficiary. beneficiaryAddressLine1(Mandatory) Specifies the first line of beneficiary address . beneficiaryAddressLine2(Mandatory) Specifies the second line of beneficiary address . beneficiaryPostCode(Mandatory) Specifies the Zipcode of beneficiary. beneficiaryCountry(Mandatory) Specifies the country name of beneficiary. beneficiaryCity(Mandatory) Specifies the city name of beneficiary. beneficiaryState(Mandatory) Specifies the state name of beneficiary. beneficiaryBank(Mandatory) Specifies name of the beneficiary bank. beneficiaryBankAddressLine1(Mandatory) Specifies the first line of bank address . beneficiaryBankAddressLine2(Mandatory) Specifies the second line of bank address . beneficiaryBankPostCode Specifies the Zipcode of bank location. beneficiaryBankCountry Specifies the country name of the bank location. beneficiaryBankCity(Mandatory) Specifies the city name of bank location. beneficiaryBankState(Mandatory) Specifies the state name of bank location. placeOfTakingIncharge(Mandatory) Specifies the place of taking incharge. portOfLoading Specifies the loading port name. portOfDischarge Specifies the unloading port name. placeOfFinalDelivery Specifies the final delivery location. latestShippingDate Specifies the time stamp of shipping date. transshipment Specifies the transshipment details. incoTerms(Mandatory) Specifies the inco terms. modeOfShipment Specifies the mode of shipping. descriptionOfGoods Specifies the description of goods. additionalConditionsCode Specifies if any additional conditional codes are applicable. otherAdditionalConditions Specifies the other additional conditions for LC. documentCharges Specifies the charges for documentation. supportDcouments Specifies the supporting document for LC. fileToUpload Specifies he files for LC. confirmationInstruction(Mandatory) Specifies the instructions for confirmations. transferable(Mandatory) Specifies if the LC is transferable. standByLC(Mandatory) Specifies the lenders guarantee payment to an interested third party. isDraft(Mandatory) Specifies if the LC is a draft or submitted. additionalPayableCurrency(Mandatory) Specifies the additional payable currency. status(Mandatory) Specifies the status of LC srmsReqOrderID(Mandatory) Specifies the unique srmsReqOrderID {
"LetterOfCredits": [{
"lcReferenceNo": "LC125471234",
"lcAmount": "18",
"lcCurrency": "USD",
"tolerancePercentage": "1",
"maximumCreditAmount": "22",
"additionalAmountPayable": "1",
"availableWith1": "123",
"availableWith2": "Q",
"availableWith3": "V",
"availableWith4": "B",
"issueDate": "0021-12-01T00:00:00Z",
"expiryDate": "0021-12-02T00:00:00Z",
"expiryPlace": "abc",
"chargesAccount": "1",
"commisionAccount": "NIL",
"marginAccount": "20",
"messageToBank": "NIL",
"paymentTerms": "bc",
"beneficiaryName": "test1",
"beneficiaryAddressLine1": "abc",
"beneficiaryAddressLine2": "B",
"beneficiaryPostCode": "122",
"beneficiaryCountry": "India",
"beneficiaryCity": "Chennai",
"beneficiaryState": "TN",
"beneficiaryBank": "ABC Bank",
"beneficiaryBankAdressLine1": "abc",
"beneficiaryBankPostCode": "222",
"beneficiaryBankCountry": "India",
"beneficiaryBankCity": "Chennai",
"beneficiaryBankState": "TN",
"placeOfTakingIncharge": "India",
"portOfLoading": "India",
"portOfDischarge": "India",
"placeOfFinalDelivery": "India",
"latestShippingDate": "27/09/2100",
"transshipment": "Nil",
"partialShipments": "Nil",
"incoTerms": "qwe",
"modeOfShipment": "Air",
"descriptionOfGoods": "NIL",
"documentsRequired": "No",
"additionalConditionsCode": "20123",
"otherAdditionalConditions": "NIL",
"documentCharges": "12",
"supportDocuments": "No",
"fileToUpload": "No",
"confirmationInstruction": "test",
"transferable": "test",
"standByLC": "test",
"isDraft": "true",
"additionalPayableCurrency": "EURO",
"srmsReqOrderID": "LOCI21280OXHQP"
}],
"opstatus": 0,
"httpStatusCode": 0
}
|
| Error Code(s): |
|
| Enterprise Provider: | |
| Enterprise API: |
Field Mapping
| UI Field | Experience API Field | Transact API Field |
|---|---|---|
| NA | srmsReqOrderID | NA |
| NA | LetterOfCredits | NA |
| LC Reference Number | lcReferenceNo | NA |
| Amount | lcAmount | NA |
| Tolerance Percentage | tolerancePercentage | NA |
| Maximum Credit Amount | maximumCreditAmount | NA |
| Additional Amount Payable | additionalAmountPayable | NA |
| Available With | availableWith1 | NA |
| Available With | availableWith2 | NA |
| Available With | availableWith3 | NA |
| Available With | availableWith4 | NA |
| Issue Date | issueDate | NA |
| Expiry Date | expiryDate | NA |
| Charges Account | chargesAccount | NA |
| Commision Account | commisionAccount | NA |
| Margin Account | marginAccount | NA |
| Message To Bank | messageToBank | NA |
| Payment Terms | paymentTerms | NA |
| Beneficiary | beneficiaryName | NA |
| Beneficiary Address | beneficiaryAddressLine1 | NA |
| Beneficiary Address | beneficiaryAddressLine2 | NA |
| Beneficiary Address | beneficiaryPostCode | NA |
| Beneficiary Address | benficiaryCountry | NA |
| Beneficiary Address | benficiaryCity | NA |
| Beneficiary Address | beneficiaryState | NA |
| Beneficiary Bank | beneficiaryBank | NA |
| Beneficiary Bank Address | beneficiaryBankAddressLine1 | NA |
| Beneficiary Bank Address | beneficiaryBankPostCode | NA |
| Beneficiary Bank Address | beneficiaryBankCountry | NA |
| Beneficiary Bank Address | beneficiaryBankCountry | NA |
| Beneficiary Bank Address | beneficiaryBankCity | NA |
| Beneficiary Bank Address | beneficiaryBankState | NA |
| Place Of Taking Incharge | placeOfTakingincharge | NA |
| Port Of Loading | portOfLoading | NA |
| Port Of Discharge | portOfDischarge | NA |
| Place Of Final Delivery | placeOfFinalDelivery | NA |
| Latest Shipping Date | latestShippingDate | NA |
| Transshipment | transshipment | NA |
| Partial Shipments | partialShipments | NA |
| IncoTerms | incoTerms | NA |
| Mode Of Shipment | modeOfShipment | NA |
| Goods of description | descriptionOfGoods | NA |
| Document Required | documentRequired | NA |
| Additional Conditions Code | additionalConditionsCode | NA |
| Other Additional Conditions | otherAdditionalConditions | NA |
| Charges | documentCharges | NA |
| Confirmation Instruction | confirmationInstruction | NA |
| Transferable | transferable | NA |
| NA | isDraft | NA |
| Additional Amount Payable | additionalPayableCurrency | NA |
| NA | srmsReqOrderID | NA |
| Stand by LC | strandByLC | NA |
| Credit Amount | lcCurrency | NA |
| Expiry Place | expiryPlace | NA |
| Description: | This API deletes the letter of credits imports. |
| Method: | POST |
| URL: | {base_url}/services/data/v1/TradeFinance/operations/LetterOfCredit/deleteImportLC |
| Security Level: | Authenticated App User |
| Header Request: | X-Kony-Authorization |
| Body Request: |
Parameters status(Mandatory) Specifies the status of LC. srmsReqOrderId(Mandatory) Specifies the unique srmsReqOrderId. lcReferenceNo(Mandatory) Specifies the unique lcReferenceNo. {
"status":"Delete",
"srmsReqOrderID": "LOCI21293BZVI3",
"lcReferenceNo": "LC125471234"
}
|
| Response: |
Parameters srmsReqOrderID(Mandatory) Specifies the unique ID for srmsReqOrderID. status(Mandatory) Specifies the status of LC. {
"srmsReqOrderID": "LOCI21285DHJM7",
"status": "Deleted",
"opstatus": 0,
"httpStatusCode": 0
}
|
| Error Code(s): |
|
| Enterprise Provider: | |
| Enterprise API: |
Field Mapping
| UI Field | Experience API Field | Transact API Field |
|---|---|---|
| Status | status | NA |
| NA | srmsReqOrderID | NA |
| Description: | This API downloads the letter of credit imports. |
| Method: | POST |
| URL: | {base_url}/services/data/v1/TradeFinance/operations/LCSummary/generate |
| Security Level: | Authenticated App User |
| Header Request: | X-Kony-Authorization |
| Body Request: |
Parameters srmsReqOrderID(Mandatory) Specifies the unique srmsReqOrderID. {
"srmsReqOrderID": "LOCI21280VUJ0Z"
}
|
| Response: |
Parameters fileid(Mandatory) Specifies the unique fileid. {
"fileId": "Ebw519Du-B1jb5K7e-PBSAzYsa-hPj1cY4z",
"opstatus": 0,
"httpStatusCode": 0
}
|
| Error Code(s): |
|
| Enterprise Provider: | |
| Enterprise API: |
Field Mapping
| UI Field | Experience API Field | Transact API Field |
|---|---|---|
| NA | srmsReqOrderID | NA |
| NA | fileId | NA |
| Description: | This is a mock service to update Import LC by Bank. |
| Method: | POST |
| URL: | {base_url}/services/data/v1/TradeFinance/operations/LetterOfCredit/updateImportLCByBank |
| Security Level: | Authenticated App User |
| Header Request: | X-Kony-Authorization |
| Body Request: | {
"srmsReqOrderID": "LOCI22362GMV31",
"status": "Approved"
}
|
| Response: | {
"srmsReqOrderID": "LOCI22362GMV31",
"lcAmount": "0",
"maximumCreditAmount": "0",
"message": "Record updated Successfully",
"opstatus": 0,
"httpStatusCode": 0
}
|
| Error Code(s): |
|
| Enterprise Provider: | |
| Enterprise API: |
Field Mapping
| UI Field | Experience API field | Transact API field |
|---|---|---|
| Status | status | NA |
| NA | srmsReqOrderId | NA |
| Tolerance Percentage | tolerancePercentage | NA |
| Amount | lcAmount | NA |
| Charges Account | chargesAccount | NA |
| NA | isDraft | NA |
| Document Required | documentsRequired | NA |
| Expiry Place | expiryPlace | NA |
| LC Reference Number | lcReferenceNo | NA |
| Payment Terms | paymentTerms | NA |
| Beneficiary | BeneficiaryName | NA |
| IncoTerms | incoTerms | NA |
| Confirmation Instruction | confirmationInstruction | NA |
| Goods of description | goodsOfDescription | NA |
| Currency | currency | NA |
| Place Of Taking Incharge | placeOfTakingIncharge | NA |
| Beneficiary Address | beneficiaryAddress | NA |
| Place Of Final Delivery | placeOfFinalDelivery | NA |
| Latest Shipping Date | latestShippingDate | NA |
| Message To Bank | messageToBank | NA |
| Beneficiary Address | beneficiaryAddress | NA |
| Additional Payment Amount | additionalPaymentAmount | NA |
| Maximum Credit Amount | maximumCreditAmount | NA |
| Beneficiary Bank | beneficiaryBank | NA |
| NA | srmsReqOderId | NA |
| Margin Account | marginAccount | NA |
| Additional Payable Currency | additionalPayableCurrency | NA |
| Other Additional Conditions | otherAdditionalConditions | NA |
| Port Of Discharge | portOfDischarge | NA |
| Mode Of Shipment | modeOfShipment | NA |
| Commision Account | comissionAccount | NA |
| Beneficiary Address | beneficiaryAddress | NA |
| Expiry Date | expiryDate | NA |
| Issue Date | issueDate | NA |
| Stand By LC | standBylc | NA |
| Partial Shipments | partialShipments | NA |
| Transshipment | transhipment | NA |
| Charges | charges | NA |
| Beneficiary Bank Address | beneficiaryBankAddress | NA |
| Port Of Loading | portOffLoading | NA |
| Parameter Name | DataType | Optional/Mandatory | Description |
|---|---|---|---|
| lcReferenceNo | String | Mandatory | lcReferenceNo |
| lcAmount | String | Mandatory | lcAmount |
| lcCurrency | String | Mandatory | lcCurrency |
| tolerancePercentage | String | Optional | tolerancePercentage |
| maximumCreditAmount | String | Optional | maximumCreditAmount |
| additionalAmountPayable | String | Optional | additionalAmountPayable |
| paymentTerms | String | Mandatory | paymentTerms |
| availableWith1 | String | Mandatory | availableWith1 |
| availableWith2 | String | Mandatory | availableWith2 |
| availableWith3 | String | Mandatory | availableWith3 |
| availableWith4 | String | Mandatory | availableWith4 |
| issueDate | String | Mandatory | issueDate |
| expiryDate | String | Mandatory | expiryDate |
| expiryPlace | String | Mandatory | expiryPlace |
| chargesAccount | String | Optional | chargesAccount |
| commisionAccount | String | Optional | commisionAccount |
| marginAccount | String | Optional | marginAccount |
| messageToBank | String | Optional | messageToBank |
| beneficiaryName | String | Mandatory | beneficiaryName |
| beneficiaryAddressLine1 | String | Mandatory | beneficiaryAddressLine1 |
| beneficiaryAddressLine2 | String | Mandatory | beneficiaryAddressLine2 |
| beneficiaryPostCode | String | Optional | beneficiaryPostCode |
| beneficiaryCountry | String | Optional | beneficiaryCountry |
| beneficiaryCity | String | Mandatory | beneficiaryCity |
| beneficiaryState | String | Mandatory | beneficiarytate |
| beneficiaryBank | String | Mandatory | beneficiaryBank |
| beneficiaryBankAdressLine1 | String | Mandatory | beneficiaryBankAddressLine1 |
| beneficiaryBankAdressLine2 | String | Mandatory | beneficiaryBankAdressLine2 |
| beneficiaryBankPostCode | String | Mandatory | beneficiaryBankPostCode |
| beneficiaryBankCountry | String | Mandatory | beneficiaryBankCountry |
| beneficiaryBankCity | String | Mandatory | beneficiaryBankCity |
| beneficiaryBankState | String | Mandatory | beneficiaryBankState |
| placeOfTakingIncharge | String | Optional | placeOfTakingIncharge |
| portOfLoading | String | Optional | portOfLoading |
| portOfDischarge | String | Optional | portOfDischarge |
| placeOfFinalDelivery | String | Optional | placeOfFinalDelivery |
| latestShippingDate | String | Optional | latestShippingDate |
| presentationPeriod | String | Optional | presentationPeriod |
| transshipment | String | Optional | transshipment |
| partialShipments | String | Optional | partialShipments |
| incoTerms | String | Mandatory | incoTerms |
| modeOfShipment | String | Optional | modeOfShipment |
| descriptionOfGoods | String | Optional | descriptionOfGoods |
| documentsRequired | String | Mandatory | documentsRequired |
| additionalConditionsCode | String | Optional | additionalConditionsCode |
| otherAdditionalConditions | String | Optional | otherAdditionalConditions |
| documentCharges | String | Optional | documentCharges |
| supportDocuments | String | Optional | supportDocuments |
| fileToUpload | String | Optional | fileToUpload |
| confirmationInstruction | String | Mandatory | confirmationInstruction |
| transferable | String | Mandatory | transferable |
| standByLC | String | Mandatory | standByLC |
| isDraft | String | Mandatory | isDraft |
| additionalPayableCurrency | String | Mandatory | additionalPayableCurrency |
| code | String | Mandatory | code |
| msg | String | Mandatory | msg |
| flowType | String | Mandatory | flowType |
| id | String | Mandatory | id |
| status | String | Mandatory | status |
| ErrorCode | String | Mandatory | ErrorCode |
| ErrorMessage | String | Mandatory | ErrorMessage |
| srmsReqOrderID | String | Mandatory | srmsReqOrderID |
| lcCreatedOn | String | Mandatory | lcCreatedOn |
| draftCount | String | Mandatory | draftCount |
| draftAmount | String | Mandatory | draftAmount |
| deletedCount | String | Mandatory | deletedCount |
| deletedAmount | String | Mandatory | deletedAmount |
| selfApprovedCount | String | Mandatory | selfApprovedCount |
| selfApprovedAmount | String | Mandatory | selfApprovedAmount |
| totalCount | String | Mandatory | totalCount |
| totalAmount | String | Mandatory | totalAmount |
In this topic