Trade Finance

Name Description Introduced In
createImportLetterOfCreditAmendment This API creates the LC Amendment for Imports. 2022.04
getImportLetterOfCreditAmendments This API retrieves the list of Import LC Amendments. 2022.04
getImportLetterOfCreditAmendmentsById This API retrieves the list of Import LC Amendments by ID. 2022.04
generateImportLCAmendment This API downloads the Import LC Amendment. 2022.04
Object Data Model This Object Data Model describes the parameter name and other attribute details for Trade Finance.  
ClosedcreateImportLetterOfCreditAmendment
 
Description: This API creates the LC Amendment for Imports.
Method: POST
URL: {base_url}/services/data/v1/TradeFinance/operations/LetterOfCredit/createImportLetterOfCreditAmendment
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request:

Parameters

lcReferenceNo (Mandatory)

Specifies the lcReferenceNo.

expiryDate(Mandatory)

Specifies the expiry date of import LC.

latestShipmentDate

Specifies the latest shipment date of import LC.

lcAmount (Mandatory)

Specifies the total amount in import LC.

lcCurrency (Mandatory)

Specifies the currency of transaction for LC.

status (Mandatory)

Specifies the current status of amendment LC.

amountType (Mandatory)

Specifies the type of amount changes for current amendment.

otherAmendments (Mandatory)

Describes the other amendments if applicable.

charges (Mandatory)

Specifies the charges for current amendment.

chargeAccount (Mandatory)

Specifies to which account these charges to be deducted.

beneficiary (Mandatory)

Specifies the name of the beneficiary.

creditAmount (Mandatory)

Specifies the total amount took for credit.

issueDateExpiryDate

Specifies the issue date and expiry date for current LC.

paymentTerms (Mandatory)

Specifies the type of payment terms.

{
    "lcReferenceNo": "LC125471234",
    "lcAmount": "1234",
    "lcCurrency": "USD",
    "paymentTerms": "deferred",
    "issueDate": "12/12/2020",
    "expiryDate": "12/12/2020",
    "amendmentExpiryDate": "02/02/2023",
    "chargesAccount": "125717",
    "creditAmount": "445",
    "beneficiaryName": "DTest",
    "latestShippingDate": "10/12/2022",
    "presentationPeriod": "ege",
    "amountType": "Increase",
    "otherAmendments": "llkllkl",
    "amendCharges": "Beneficiary",
    "amendStatus": "New",
    "lcSRMSId": "LOCI220805DEWC"
}
Response:

Parameters

amendmentReference (Mandatory)

Specifies the amendmentReference.

amendmentDate (Mandatory)

Specifies the date of amendment.

status (Mandatory)

Specifies the current status of amendment.

amendmentApprovedDate (Mandatory)

Specifies the approved date of current amendment.

expiryDate(Mandatory)

Specifies the expiry date of import LC.

latestShipmentDate

Specifies the latest shipment date of import LC.

lcAmount (Mandatory)

Specifies the total amount in import LC.

lcCurrency (Mandatory)

Specifies the currency of transaction for LC.

amountType (Mandatory)

Specifies the type of amount changes(increase/Decrease) for current amendment.

otherAmendments (Mandatory)

Describes the other amendments if applicable.

charges (Mandatory)

Specifies the charges for current amendment.

chargeAccount (Mandatory)

Specifies to which account these charges to be deducted.

lcReferenceNo (Mandatory)

Specifies the lcReferenceNo.

beneficiary (Mandatory)

Specifies the name of the beneficiary.

creditAmount (Mandatory)

Specifies the total amount took for credit.

issueDateExpiryDate

Specifies the issue date and expiry date for current LC.

paymentTerms (Mandatory)

Specifies the type of payment terms.
{
    "lcReferenceNo": "LC125471234",
    "lcAmount": "1234",
    "lcCurrency": "USD",
    "paymentTerms": "deferred",
    "issueDate": "2020-12-12T00:00:00Z",
    "expiryDate": "2020-12-12T00:00:00Z",
    "beneficiaryName": "DTest",
    "latestShippingDate": "2022-10-12T00:00:00Z",
    "presentationPeriod": "ege",
    "amendStatus": "Pending With Bank",
    "amendmentReference": "LOCA22080HM2YN",
    "amendmentDate": "2022-03-21T00:00:00Z",
    "amendmentApprovedDate": "2022-03-21T00:00:00Z",
    "amountType": "Increase",
    "otherAmendments": "llkllkl",
    "amendCharges": "Beneficiary",
    "creditAmount": "445",
    "chargesAccount": "125717",
    "amendmentExpiryDate": "2023-02-02T00:00:00Z",
    "lcSRMSId": "LOCI220805DEWC",
    "opstatus": 0,
    "httpStatusCode": 0
}
Error Code(s):
  • Error Code: 29045
    Error Message: "Unable to create letter of credits request."
  • Error Code: 26014
    Error Message: "Failed to fetch Customer ID."
  • Error Code: 10117
    Error Message: "Logged in User is not authorized to perform this action."
  • Error Code: 10118
    Error Message: "Input Validation Failed."
  • Error Code: 29070
    Error Message: "SECURITY EXCEPTION - UNAUTHORIZED ACCESS."
  • Error Code: 29048
    Error Message: "Failed to Update letter of credits."
  • Error Code: 29052
    Error Message: "Unable to create order. Failed to find service request id in Response."
  • Error Code: 29065
    Error Message: "Error while Get LOC Call by ID."
  • Error Code: 12007
    Error Message: "Logged in User is not authorized to perform this action."
Enterprise Provider: SRMS
Enterprise API:

{base_url}/v2.0.0/orders/serviceRequest/$serviceRequestIds

Field Mapping

UI field Experience API field MS API field Transact API Field
LC Ref No lcReferenceNo NA NA
 AmendmentReference amendmentReference NA NA
NA lcSRMSId NA NA
Amendment Date amendmentDate NA NA
Amendment Status amendStatus NA NA
Approved On amendmentApprovedDate NA NA
Expiry Date expiryDate NA NA
Latest Shipment Date latestShippingDate NA NA
Period Of Presentation periodOfPresentation NA NA
LC Amount lcAmount NA NA
Currency lcCurrency NA NA
Other Amendments otherAmendments NA NA
Charges Account chargesAccount NA NA
Beneficiary beneficiary NA NA
Payment Terms paymentTerms NA NA
ClosedgetImportLetterOfCreditAmendments
 
Description: This API retrieves the list of import LC Amendments.
Method: POST
URL: {base_url}/services/data/v1/TradeFinance/operations/LetterOfCredit/getImportLetterOfCreditAmendmentst
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.

{
    "searchString": "",
    "pageSize": "",
    "pageOffset": "",
    "sortByParam": "",
    "sortOrder": "",
    "timeParam": "",
    "timeValue": "",
    "filterByValue": "",
    "filterByParam": "",
    "fromDateFilter": "",
    "toDateFilter": ""
}
Response:

Parameters

amendmentReference (Mandatory)

Specifies the amendmentReference.

amendmentDate (Mandatory)

Specifies the date of amendment.

status (Mandatory)

Specifies the current status of amendment.

amendmentApprovedDate (Mandatory)

Specifies the approved date of current amendment.

expiryDate(Mandatory)

Specifies the expiry date of import LC.

latestShipmentDate

Specifies the latest shipment date of import LC.

lcAmount (Mandatory)

Specifies the total amount in import LC.

lcCurrency (Mandatory)

Specifies the currency of transaction for LC.

amountType (Mandatory)

Specifies the type of amount changes(increase/Decrease) for current amendment.

otherAmendments (Mandatory)

Describes the other amendments if applicable.

charges (Mandatory)

Specifies the charges for current amendment.

chargeAccount (Mandatory)

Specifies to which account these charges to be deducted.

lcReferenceNo (Mandatory)

Specifies the lcReferenceNo.

beneficiary (Mandatory)

Specifies the name of the beneficiary.

creditAmount (Mandatory)

Specifies the total amount took for credit.

issueDateExpiryDate

Specifies the issue date and expiry date for current LC.

paymentTerms (Mandatory)

Specifies the type of payment terms.
{
    "Amendments": [{
        "amendmentDate": "2022-03-21T07:45:14Z",
        "amendmentApprovedDate": "2022-03-21T07:45:14Z",
        "amendStatus": "Pending With Bank",
        "expiryDate": "2020-12-12T00:00:00Z",
        "latestShippingDate": "2022-10-12T00:00:00Z",
        "lcAmount": "1234",
        "lcCurrency": "USD",
        "amountType": "Increase",
        "otherAmendments": "llkllkl",
        "amendCharges": "Beneficiary",
        "chargesAccount": "125717",
        "lcReferenceNo": "LC125471234",
        "chargesPaid": "60",
        "beneficiaryName": "DTest",
        "maximumCreditAmount": "0",
        "paymentTerms": "deferred",
        "amendmentExpiryDate": "2023-02-02T00:00:00Z",
        "importLCId": "LOCA22080HM2YN",
        "lcSRMSId": "LOCI220805DEWC"
    }],
    "opstatus": 0,
    "httpStatusCode": 0
}
Error Code(s):
  • Error Code: 29046
    Error Message: "Unable to Fetch letter of credits requests."
  • Error Code: 29054
    Error Message: "No letter of credits available between entered range."
  • Error Code: 29053
    Error Message: "Failed to fetch letter of credits."
  • Error Code: 12007
    Error Message: "Logged in User is not authorized to perform this action."
Enterprise Provider: SRMS
Enterprise API:

{base_url}/v2.0.0/orders/serviceRequest/$serviceRequestIds

Field Mapping

UI field Experience API field MS API field Transact API Field
NA searchString NA NA
NA pageSize NA NA
NA pageOffset NA NA
NA sortByParam NA NA
NA sortOrder NA NA
NA timeParam NA NA
NA timeValue NA NA
NA filterByValue NA NA
ClosedgetImportLetterOfCreditAmendmentsById
 
Description: This API retrieves the list of import LC Amendments by ID.
Method: POST
URL: {base_url}/services/data/v1/TradeFinance/operations/LetterOfCredit/getImportLetterOfCreditAmendmentsById
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request:

Parameters

amendmentReference (Mandatory)

Specifies the free text that can be entered to search for a set of records that matches the text that is entered.

{ 
	"amendmentReference": "LOCA22080HM2YN"
}
Response:

Parameters

amendmentReference (Mandatory)

Specifies the amendmentReference.

amendmentDate (Mandatory)

Specifies the date of amendment.

status (Mandatory)

Specifies the current status of amendment.

amendmentApprovedDate (Mandatory)

Specifies the approved date of current amendment.

expiryDate(Mandatory)

Specifies the expiry date of import LC.

latestShipmentDate

Specifies the latest shipment date of import LC.

lcAmount (Mandatory)

Specifies the total amount in import LC.

lcCurrency (Mandatory)

Specifies the currency of transaction for LC.

amountType (Mandatory)

Specifies the type of amount changes(increase/Decrease) for current amendment.

otherAmendments (Mandatory)

Describes the other amendments if applicable.

charges (Mandatory)

Specifies the charges for current amendment.

chargeAccount (Mandatory)

Specifies to which account these charges to be deducted.

lcReferenceNo (Mandatory)

Specifies the lcReferenceNo.

beneficiary (Mandatory)

Specifies the name of the beneficiary.

creditAmount (Mandatory)

Specifies the total amount took for credit.

issueDateExpiryDate

Specifies the issue date and expiry date for current LC.

paymentTerms (Mandatory)

Specifies the type of payment terms.
{
    "amendmentReference": "LOCA22080HM2YN",
    "amendmentDate": "2022-03-21T07:45:14Z",
    "expiryDate": "2020-12-12T00:00:00Z",
    "latestShippingDate": "2022-10-12T00:00:00Z",
    "presentationPeriod": "ege",
    "lcAmount": "1234",
    "lcCurrency": "USD",
    "otherAmendments": "llkllkl",
    "chargesAccount": "125717",
    "lcReferenceNo": "LC125471234",
    "beneficiaryName": "DTest",
    "maximumCreditAmount": "0",
    "paymentTerms": "deferred",
    "amendmentExpiryDate": "2023-02-02T00:00:00Z",
    "amendCharges": "Beneficiary",
    "issueDate": "2020-12-12T00:00:00Z",
    "creditAmount": "445",
    "referenceNomatch": "false",
    "amendStatus": "Pending With Bank",
    "chargesPaid": "60",
    "lcSRMSId": "LOCI220805DEWC",
    "opstatus": 0,
    "httpStatusCode": 0
}
Error Code(s):
  • Error Code: 29046
    Error Message: "Unable to Fetch letter of credits requests."
  • Error Code: 29049
    Error Message: "Mandatory fields are missing."
  • Error Code: 29057
    Error Message: "Record for the specified SRMSID not found."
  • Error Code: 29053
    Error Message: "Failed to fetch letter of credits."
  • Error Code: 12007
    Error Message: "Logged in User is not authorized to perform this action."
Enterprise Provider: SRMS
Enterprise API:

{base_url}/v2.0.0/orders/serviceRequest/$serviceRequestIds

Field Mapping

UI field Experience API field MS API field Transact API Field
Amendment Reference amendmentReference NA NA
LC Ref No lcReferenceNo NA NA
Amendment Date amendmentDate NA NA
Amendment Status amendStatus NA NA
Approved On amendmentApprovedDate NA NA
Expiry Date expiryDate NA NA
Latest Shipment Date latestShippingDate NA NA
Period Of Presentation periodOfPresentation NA NA
LC Amount lcAmount NA NA
Currency lcCurrency NA NA
Other Amendments otherAmendments NA NA
Charges Account chargesAccount NA NA
Charges Paid chargesPaid NA NA
Beneficiary beneficiary NA NA
Payment Terms paymentTerms NA NA
ClosedgenerateImportLCAmendment
 
Description: This API downloads the Import LC Amendment.
Method: POST
URL: {base_url}/services/data/v1/TradeFinance/operations/LCSummary/generateImportLCAmendment
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request:

Parameters

amendmentReference (Mandatory)

Specifies the free text that can be entered to search for a set of records that matches the text that is entered.

{ 
	"amendmentReference": "LOCA22080HM2YN"
}
Response:

Parameters

fileId (Mandatory)

Specifies the unique fileId.

{
    "fileId": "VSHqjP70-XrgoZNF3-h2YmoojD-3ZO8fppH",
    "opstatus": 0,
    "httpStatusCode": 0
}
Error Code(s):
  • Error Code: 29056
    Error Message: "Error occurred while generating the trade finance file."
  • Error Code: 29055
    Error Message: "Something went wrong while generating report."
  • Error Code: 29046
    Error Message: "Unable to Fetch letter of credits requests."
  • Error Code: 12007
    Error Message: "Logged in User is not authorized to perform this action."
Enterprise Provider: SRMS
Enterprise API:

{base_url}/v2.0.0/orders/serviceRequest/$serviceRequestIds

Field Mapping

UI field Experience API field MS API field Transact API Field
Amendment Reference amendmentReference NA NA
NA lcReferenceNo NA NA
ClosedObject Data Model
ClosedData Model: LetterOfCredit
 
Parameter Name DataType Optional/Mandatory Description

lcReferenceNo

String

 Mandatory

LC reference number

expiryDate

String

Mandatory

LC expiry date

latestShipmentDate

String

Optional

Latest shipment date of goods

periodOfPresentation

String

Optional

Presentation period

lcAmount

String

Mandatory

LC amount

lcCurrency

String

Mandatory

LC currency

status

String

Mandatory

Status of record

amountType

String

Mandatory

Increase or Decrease of

otherAmendments

String

Mandatory

Other amendments

chargesAccount

String

Mandatory

Charges Account Number

beneficiary

String

Mandatory

Beneficiary Name

creditAmount

String

Mandatory

Credit Amount

issueDate

String

Mandatory

LC Issue Date

paymentTerms

String

Mandatory

Payment Term

amendmentReference

String

Mandatory

Amendment Reference

amendmentDate

String

Mandatory

Amendment Created Date

searchString

String

Optional

Search Keyword

pageSize

String

Optional

The count of records in response

pageOffset

String

Optional

Defines fetching records from the count mentioned

sortByParam

String

Optional

Sorting parameter in comma separated

sortOrder

String

Optional

Sorting values in comma separated

timeParam

String

Optional

Time parameter

timeValue

String

Optional

Time value separated with count and time period

filterByValue

String

Optional

Filter value in comma separated

filterByParam

String

Optional

Filter parameter in comma separated

expiryDate

String

Mandatory

LC expiry date

amendCharges

String

Mandatory

Amend Charges
ClosedData Model: LCSummary
 
Parameter Name DataType Optional/Mandatory Description

exportLCId

String

Mandatory

SRMS request id of the export LC

fileId

String

Mandatory

Generated file id from server

amendmentReference

String

Mandatory

SRMS request id of amendment

 

Expand/Collapse
Share
Print

In this topic

Copyright © 2020- Temenos Headquarters SA

Published on :
Monday, May 2, 2022 5:20:03 PM IST

Feedback
x