Guarantees and Standby LC - Claims Initiated APIs

Name Description Introduced In
CreateGuaranteeClaims This API creates Issued Guarantee Claims. 2022.10
SaveGuaranteeClaims To API saves the Issued Guarantee Claims as draft. 2022.10
GetGuaranteeClaims This API retrieves Issued Guarantee Claims for particular customer. 2022.10
getGuaranteeAmendmentById This API retrieves issued guarantee claims by Id. 2022.10
UpdateReceivedGuaranteeClaim This API updates issued guarantee claims. 2022.10
generateReceivedGuaranteeClaim To API downloads report for issued guarantee claims record. 2022.10
generateClaimsList This API exports list of Issued guarantee claims. 2022.10
UpdateReceivedGuaranteeClaimByBank This API is a mock service to update the Issued Guarantee Claims from bank. 2022.10
Object Data Model This Object Data Model describes the parameter name and other attribute details for Trade Finance.  
ClosedCreateGuaranteeClaims
 
Description: This API creates Issued Guarantee Claims.
Method: POST
URL: {base_url}/services/data/v1/TradeFinance/operations/ReceivedGuarantees/CreateGuaranteeClaims
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request: 
{
    "productType": "Guarantee",
    "beneficiaryName": "Naveen Yerra",
    "guaranteesSRMSId": "RGUA4823023",
    "claimCurrency": "USD",
    "claimAmount": "123",
    "claimCreditAccount": "127434",
    "chargesDebitAccount": "127434",
    "demandType": "Pay / Extend",
    "newExtensionDate": "12/1/2023",
    "documentInformation": "[{"
    documentReference ":"
    wewe - 121 - 121 - 343 ", "
    documentName ":"
    dummy.pdf "}, {"
    documentReference ":"
    wewe - 121 - 121 - 343 ", "
    documentName ":"
    dummy.pdf "}]",
    "physicalDocuments": "[{"
    documentTitle ":"
    wewe - 121 - 121 - 343 ", "
    originalsCount ":"
    1 ", "
    copiesCount ":"
    1 "}]",
    "forwardDocuments": "Selected",
    "otherDemandDetails": "sother demand details",
    "messageToBank": "accept the claim",
    "guaranteeAndSBLCType": "Performance",
    "guaranteesReferenceNo": "GE1233412",
    "amount": "2000",
    "expiryType": "Date",
    "expiryDate": "12/31/2022",
    "issuingBank": "Bank of America",
    "issueDate": "12/31/2022"
}
Response: 
{
    "claimsSRMSId": "GUCL22223FPPK1",
    "amount": "2000",
    "beneficiaryName": "Naveen Yerra",
    "claimAmount": "123",
    "claimCurrency": "USD",
    "createdOn": "08/11/2022",
    "demandType": "Pay / Extend",
    "documentInformation": "[{"
    documentReference ":"
    wewe - 121 - 121 - 343 ", "
    documentName ":"
    dummy.pdf "}, {"
    documentReference ":"
    wewe - 121 - 121 - 343 ", "
    documentName ":"
    dummy.pdf "}]",
    "expiryDate": "12/31/2022",
    "expiryType": "Date",
    "forwardDocuments": "Selected",
    "guaranteeAndSBLCType": "Performance",
    "guaranteesReferenceNo": "GE1233412",
    "issueDate": "12/31/2022",
    "issuingBank": "Bank of America",
    "messageToBank": "accept the claim",
    "newExtensionDate": "12/1/2023",
    "otherDemandDetails": "sother demand details",
    "physicalDocuments": "[{"
    documentTitle ":"
    wewe - 121 - 121 - 343 ", "
    originalsCount ":"
    1 ", "
    copiesCount ":"
    1 "}]",
    "productType": "Guarantee",
    "status": "Submitted to Bank",
    "opstatus": 0,
    "httpStatusCode": 0
}]
}
Error Code(s):
  • Error Code: 26014
    Error Message: "Failed to fetch Customer ID"
  • Error Code: 10118
    Error Message: "Input Validation Failed"
  • Error Code: 12007
    Error Message: "Logged in User is not authorized to perform this action"
Enterprise Provider: Service Request Microservice
Enterprise API:

{base_url}/v2.0.0/orders/party/$partyId/type/$type/subtype/$subtype/serviceRequest

Field Mapping

UI Field Experience API Field MS API Field Transact API Field
Currency claimCurrency NA NA
Amount claimAmount NA NA
Claim Credit Account claimCreditAccount NA NA
Charges Debit Account chargesDebitAccount NA NA
Demand Type demandType NA NA
New Extension Date newExtensionDate NA NA
Document Information documentInformation NA NA
Physical Document Details physicalDocuments NA NA
Forward Documents forwardDocuments NA NA
Other Demand Details otherDemandDetails NA NA
Payment Status paymentStatus NA NA
Settled Date paymentSettledDate NA NA
Document Status documentStatus NA NA
Total Documents totalDocuments NA NA
Returned Documents returnedDocuments NA NA
Message from Bank messageFromBank NA NA
Message to Bank messageToBank NA NA
Product Type productType NA NA
GT & SBLC Type guaranteeAndSBLCType NA NA
Transaction Reference guaranteesReferenceNo NA NA
NA guaranteesSRMSId NA NA
Amount amount NA NA
Expiry Type expiryType NA NA
Expiry Date expiryDate NA NA
Issuing Bank issuingBank NA NA
Status status NA NA
Created On createdOn NA NA
Issue Date issueDate NA NA
Beneficiary Name beneficiaryName NA NA
ClosedSaveGuaranteeClaims
 
Description: To API saves the Issued Guarantee Claims as draft.
Method: POST
URL: {base_url}/services/data/v1/TradeFinance/operations/ReceivedGuarantees/SaveGuaranteeClaims
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request: 
{
    "productType": "Guarantee",
    "beneficiaryName": "Naveen Yerra",
    "guaranteesSRMSId": "RGUA4823023",
    "claimCurrency": "USD",
    "claimAmount": "123",
    "claimCreditAccount": "127434",
    "chargesDebitAccount": "127434",
    "demandType": "Pay / Extend",
    "newExtensionDate": "12/1/2023",
    "documentInformation": "[{"
    documentReference ":"
    wewe - 121 - 121 - 343 ", "
    documentName ":"
    dummy.pdf "}, {"
    documentReference ":"
    wewe - 121 - 121 - 343 ", "
    documentName ":"
    dummy.pdf "}]",
    "physicalDocuments": "[{"
    documentTitle ":"
    wewe - 121 - 121 - 343 ", "
    originalsCount ":"
    1 ", "
    copiesCount ":"
    1 "}]",
    "forwardDocuments": "Selected",
    "otherDemandDetails": "sother demand details",
    "messageToBank": "accept the claim",
    "guaranteeAndSBLCType": "Performance",
    "guaranteesReferenceNo": "GE1233412",
    "amount": "2000",
    "expiryType": "Date",
    "expiryDate": "12/31/2022",
    "issuingBank": "Bank of America",
    "issueDate": "12/31/2022"
}
Response: 
{
    "claimsSRMSId": "GUCL22223FPPK1",
    "amount": "2000",
    "beneficiaryName": "Naveen Yerra",
    "claimAmount": "123",
    "claimCurrency": "USD",
    "createdOn": "08/11/2022",
    "demandType": "Pay / Extend",
    "documentInformation": "[{"
    documentReference ":"
    wewe - 121 - 121 - 343 ", "
    documentName ":"
    dummy.pdf "}, {"
    documentReference ":"
    wewe - 121 - 121 - 343 ", "
    documentName ":"
    dummy.pdf "}]",
    "expiryDate": "12/31/2022",
    "expiryType": "Date",
    "forwardDocuments": "Selected",
    "guaranteeAndSBLCType": "Performance",
    "guaranteesReferenceNo": "GE1233412",
    "issueDate": "12/31/2022",
    "issuingBank": "Bank of America",
    "messageToBank": "accept the claim",
    "newExtensionDate": "12/1/2023",
    "otherDemandDetails": "sother demand details",
    "physicalDocuments": "[{"
    documentTitle ":"
    wewe - 121 - 121 - 343 ", "
    originalsCount ":"
    1 ", "
    copiesCount ":"
    1 "}]",
    "productType": "Guarantee",
    "status": "Submitted to Bank",
    "opstatus": 0,
    "httpStatusCode": 0
}
Error Code(s):
  • Error Code: 26014
    Error Message: "Failed to fetch Customer ID"
  • Error Code: 12007
    Error Message: "Logged in User is not authorized to perform this action"
Enterprise Provider: Service Request Microservice
Enterprise API:

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

Field Mapping

UI Field Experience API Field MS API Field Transact API Field
Currency claimCurrency NA NA
Amount claimAmount NA NA
Claim Credit Account claimCreditAccount NA NA
Charges Debit Account chargesDebitAccount NA NA
Demand Type demandType NA NA
New Extension Date newExtensionDate NA NA
Document Information documentInformation NA NA
Physical Document Details physicalDocuments NA NA
Forward Documents forwardDocuments NA NA
Other Demand Details otherDemandDetails NA NA
Payment Status paymentStatus NA NA
Settled Date paymentSettledDate NA NA
Document Status documentStatus NA NA
Total Documents totalDocuments NA NA
Returned Documents returnedDocuments NA NA
Message from Bank messageFromBank NA NA
Message to Bank messageToBank NA NA
Product Type productType NA NA
GT & SBLC Type guaranteeAndSBLCType NA NA
Transaction Ref guaranteesReferenceNo NA NA
NA guaranteesSRMSId NA NA
Amount amount NA NA
Expiry Type expiryType NA NA
Expiry Date expiryDate NA NA
Issuing Bank issuingBank NA NA
Status status NA NA
Created On createdOn NA NA
Issue Date issueDate NA NA
Beneficiary Name beneficiaryName NA NA
ClosedGetGuaranteeClaims
 
Description: This API retrieves Issued Guarantee Claims for particular customer.
Method: POST
URL: {base_url}/services/data/v1/TradeFinance/operations/ReceivedGuarantees/GetGuaranteeClaims
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request: 
{
    "searchString": "",
    "pageSize": "",
    "pageOffset": "",
    "sortByParam": "",
    "sortOrder": "",
    "timeParam": "",
    "timeValue": "",
    "filterByValue": "",
    "filterByParam": "",
    "fromDateFilter": "",
    "toDateFilter": ""
}
Response: 
{
    "GuaranteeClaims": [{
            "claimsSRMSId": "GUCL22223FPPK1",
            "amount": "2000",
            "beneficiaryName": "Naveen Yerra",
            "claimAmount": "123",
            "claimCurrency": "USD",
            "createdOn": "08/11/2022",
            "demandType": "Pay / Extend",
            "discrepancy1": "stamp not authorized2",
            "discrepancy1UserComment": "no comments2",
            "discrepancy1UserResponse": "will submit with new stamp2",
            "discrepancy2": "not legal document2",
            "discrepancy2UserComment": "no comments2",
            "discrepancy2UserResponse": "will submit new doc2",
            "documentInformation": "[{'documentReference':'wewe-121-121-343','documentName':'dummy.pdf'},{'documentReference':'wewe-121-121-343','documentName':'dummy.pdf'}]",
            "documentStatus": "discrepant1",
            "expiryDate": "12/31/2022",
            "expiryType": "Date",
            "forwardDocuments": "Selected",
            "guaranteeAndSBLCType": "Performance",
            "guaranteesReferenceNo": "GE1233412",
            "issueDate": "12/31/2022",
            "issuingBank": "Bank of America",
            "messageToBank": "accept the claim",
            "newExtensionDate": "12/1/2023",
            "otherDemandDetails": "sother demand details",
            "physicalDocuments": "[{'copiesCount':'1','originalsCount':'1','documentTitle':'wewe-121-121-343'}]",
            "productType": "Guarantee",
            "reasonForReturn": "No signed stamp1",
            "returnedDocuments": "document1.pdf",
            "returnedHistory": "{'discrepancyHistory1':{'discrepancy2UserResponse':'will submit new doc2','discrepancy2UserComment':'no comments2','discrepancy1UserResponse':'will submit with new stamp2','returnedTime':'2022-08-11T19:41:02Z','discrepancy1UserComment':'no comments2','discrepancy2':'not legal document2','discrepancy1':'stamp not authorized2'}}",
            "returnMessageToBank": "Please accept the claim2",
            "status": "Returned By Bank"
        }
Error Code(s):
  • Error Code: 26014
    Error Message: "Failed to fetch Customer ID"
  • Error Code: 12007
    Error Message: "Logged in User is not authorized to perform this action"
Enterprise Provider: Service Request Microservice
Enterprise API:

{base_url}/v2.0.0/orders/party/$partyId?$queryParams

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
NA GuaranteeClaims NA NA
ClosedgetGuaranteeAmendmentById
 
Description: This API retrieves issued guarantee claims by Id.
Method: POST
URL: {base_url}/services/data/v1/TradeFinance/operations/Guarantees/getGuaranteeAmendmentById
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request: 
{
    "claimsSRMSId": "GUCL22223FPPK1"
}
Response: 
{
    "claimsSRMSId": "GUCL22223FPPK1",
    "amount": "2000",
    "beneficiaryName": "Naveen Yerra",
    "claimAmount": "123",
    "claimCurrency": "USD",
    "createdOn": "08/11/2022",
    "demandType": "Pay / Extend",
    "discrepancy1": "stamp not authorized2",
    "discrepancy1UserComment": "no comments2",
    "discrepancy1UserResponse": "will submit with new stamp2",
    "discrepancy2": "not legal document2",
    "discrepancy2UserComment": "no comments2",
    "discrepancy2UserResponse": "will submit new doc2",
    "documentInformation": "[{'documentReference':'wewe-121-121-343','documentName':'dummy.pdf'},{'documentReference':'wewe-121-121-343','documentName':'dummy.pdf'}]",
    "documentStatus": "discrepant1",
    "expiryDate": "12/31/2022",
    "expiryType": "Date",
    "forwardDocuments": "Selected",
    "guaranteeAndSBLCType": "Performance",
    "guaranteesReferenceNo": "GE1233412",
    "issueDate": "12/31/2022",
    "issuingBank": "Bank of America",
    "messageToBank": "accept the claim",
    "newExtensionDate": "12/1/2023",
    "otherDemandDetails": "sother demand details",
    "physicalDocuments": "[{'copiesCount':'1','originalsCount':'1','documentTitle':'wewe-121-121-343'}]",
    "productType": "Guarantee",
    "reasonForReturn": "No signed stamp1",
    "returnedDocuments": "document1.pdf",
    "returnedHistory": [{
        "discrepancyHistory1": [{
            "discrepancy1": "stamp not authorized2",
            "discrepancy1UserResponse": "will submit with new stamp2",
            "discrepancy1UserComment": "no comments2",
            "discrepancy2": "not legal document2",
            "discrepancy2UserResponse": "will submit new doc2",
            "discrepancy2UserComment": "no comments2",
            "returnedTime": "2022-08-11T19:41:02Z"
        }]
    }],
    "returnMessageToBank": "Please accept the claim2",
    "status": "Returned By Bank",
    "opstatus": 0,
    "httpStatusCode": 0
}
Error Code(s):
  • Error Code: 26014
    Error Message: "Failed to fetch Customer ID"
  • Error Code: 12007
    Error Message: "Logged in User is not authorized to perform this action"
  • Error Code: 29070
    Error Message: "SECURITY EXCEPTION - UNAUTHORIZED ACCESS"
  • Error Code: 10118
    Error Message: "Input Validation Failed"
Enterprise Provider: Service Request Microservice
Enterprise API:

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

Field Mapping

UI Field Experience API Field MS API Field Transact API Field
NA claimsSRMSId NA NA
Currency claimCurrency NA NA
Amount claimAmount NA NA
Claim Credit Account claimCreditAccount NA NA
charges Debit Account chargesDebitAccount NA NA
Demand Type demandType NA NA
New Extension Date newExtensionDate NA NA
Document Information documentInformation NA NA
Physical Document Details physicalDocuments NA NA
Forward Documents forwardDocuments NA NA
Other Demand Details otherDemandDetails NA NA
Utilized Amount utilizedAmount NA NA
Returned Count returnedCount NA NA
Payment Status paymentStatus NA NA
Settled Date paymentSettledDate NA NA
Document Status documentStatus NA NA
Total Documents totalDocuments NA NA
Returned Documents returnedDocuments NA NA
Message from Bank messageFromBank NA NA
Reason For Return reasonForReturn NA NA
Discrepancy 1 discrepancy1 NA NA
Discrepancy 2 discrepancy2 NA NA
D1 User Response discrepancy1UserResponse NA NA
D1 User Comment discrepancy1UserComment NA NA
D2 User Response discrepancy2UserResponse NA NA
D2 User Comment discrepancy2UserComment NA NA
Return Message To Bank returnMessageToBank NA NA
Message to Bank messageToBank NA NA
Product Type productType NA NA
GT & SBLC Type guaranteeAndSBLCType NA NA
Transaction Ref guaranteesReferenceNo NA NA
NA guaranteesSRMSId NA NA
Amount amount NA NA
Expiry Type expiryType NA NA
Expiry Date expiryDate NA NA
Issuing Bank issuingBank NA NA
Status status NA NA
Created On createdOn NA NA
Issue Date issueDate NA NA
Beneficiary Name beneficiaryName NA NA
Applicant applicant NA NA
ClosedUpdateReceivedGuaranteeClaim
 
Description: This API updates issued guarantee claims.
Method: POST
URL: {base_url}/services/data/v1/TradeFinance/operations/ReceivedGuarantees/UpdateReceivedGuaranteeClaim
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request: 
{
    "claimsSRMSId": "GUCL22223WRPII",
    "discrepancy1": "stamp not authorized2",
    "discrepancy1UserResponse": "will submit with new stamp2",
    "discrepancy1UserComment": "no comments2",
    "discrepancy2": "not legal document2",
    "discrepancy2UserResponse": "will submit new doc2",
    "discrepancy2UserComment": "no comments2",
    "returnMessageToBank": "Please accept the claim2"
}
Response: 
{
    "benificiaryName": "DevUA",
    "guaranteesReference": "GUA221514XEW3",
    "currency": "USD",
    "amount": "123",
    "expiryDate": "2022-03-24",
    "productType": "Standby LC",
    "issueDate": "2022-03-24",
    "instructingParty": "test - instructingParty",
    "billType": "BID",
    "expiryType": "Open Ended",
    "applicantParty": "test - applicantParty",
    "amendmentNo": "02",
    "amendmentEffectiveDate": "2022-03-24",
    "amendAmount": "123",
    "amendCurrency": "USD",
    "amendExpiryType": "Open Ended",
    "amendExpiryDate": "2022-03-24",
    "amendExpiryCondition": "test - amendExpiryCondition",
    "amendDetails": "test - amendDetails",
    "messageToBank": "Accept Amendment2",
    "amendStatus": "Submitted to Bank",
    "amendRequestedDate": "2022-06-16T08:12:07Z",
    "amendmentReference": "GUAM22167C291K",
    "amendmentSRMSRequestId": "GUAM22167C291K",
    "cancellationStatus": "test - cancellationStatus",
    "reasonForReturned": "Change Amendment Details",
    "corporateUserName": "test - corporateUserName",
    "supportingDocument": "test - supportingDocument",
    "guaranteesSRMSId": "GUA221514XEW3",
    "AmendmentHistory": [{
        "amendmentHistory1": "{'ReturnMessageToBank':'Accept Amendment','ReasonforReturned':'ChangesAmendmentdetails','CorporatorName':'Naveen'}",
        "amendmentHistory2": "{'ReasonforReturned':'ChangesAmendmentdetails','CorporatorName':'Naveen','ReturnMessageToBank':'Accept Amendment2'}"
    }],
    "historyCount": "2",
    "opstatus": 0,
    "httpStatusCode": 0
}
Error Code(s):
  • Error Code: 26014
    Error Message: "Failed to fetch Customer ID"
  • Error Code: 12007
    Error Message: "Logged in User is not authorized to perform this action"
  • Error Code: 29070
    Error Message: "SECURITY EXCEPTION - UNAUTHORIZED ACCESS"
  • Error Code: 29092
    Error Message: "Unable to update guarantee request order"
Enterprise Provider: Service Request Microservice
Enterprise API:

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

Field Mapping

UI Field Experience API Field MS API Field Transact API Field
NA claimsSRMSId NA NA
Discrepancy 1 discrepancy1 NA NA
D1 User Response discrepancy1UserResponse NA NA
D1 User Comment discrepancy1UserComment NA NA
Discrepancy 2 discrepancy2 NA NA
D2 User Response discrepancy2UserResponse NA NA
D2 User Comment discrepancy2UserComment NA NA
Return Message To Bank returnMessageToBank NA NA
Currency claimCurrency NA NA
Amount claimAmount NA NA
Claim Credit Account claimCreditAccount NA NA
Claim Debit Account chargesDebitAccount NA NA
Demand Type demandType NA NA
New Extension Date newExtensionDate NA NA
Document Information documentInformation NA NA
Physical Document Details physicalDocuments NA NA
Forward Documents forwardDocuments NA NA
Other Demand Details otherDemandDetails NA NA
Utilized Amount utilizedAmount NA NA
Returned Count returnedCount NA NA
Payment Status paymentStatus NA NA
Payment Settled Date paymentSettledDate NA NA
Document Status documentStatus NA NA
Total Documents totalDocuments NA NA
Returned Documents returnedDocuments NA NA
Message From Bank messageFromBank NA NA
Reason For Return reasonForReturn NA NA
Message To Bank messageToBank NA NA
Product Type productType NA NA
GT & SBLC Type guaranteeAndSBLCType NA NA
Transaction Reference guaranteesReferenceNo NA NA
NA guaranteesSRMSId NA NA
Amount amount NA NA
Expiry Type expiryType NA NA
Expiry Date expiryDate NA NA
Issuing Bank issuingBank NA NA
Status status NA NA
Created On createdOn NA NA
Issue Date issueDate NA NA
Beneficiary Name beneficiaryName NA NA
Applicant applicant NA NA
ClosedgenerateReceivedGuaranteeClaim
 
Description: To API downloads report for issued guarantee claims record.
Method: POST
URL: {base_url}/services/data/v1/TradeFinance/operations/ReceivedGuarantees/generateReceivedGuaranteeClaim
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request: 
{

    "claimsSRMSId“: “RGCL22259DVSME"

}
Response: 
{

    "fileId": "RGCL-pJLiNT0P-rky6rh5p-Ul5W2Jkd-hkPSLyTh",
    "opstatus": 0,
    "httpStatusCode": 0

}
Error Code(s):
  • Error Code: 29054
    Error Message: "Error occurred while initiating the trade finance download"
  • Error Code: 12007
    Error Message: "Logged in User is not authorized to perform this action"
  • Error Code: 29070
    Error Message: "SECURITY EXCEPTION - UNAUTHORIZED ACCESS"
  • Error Code: 29056
    Error Message: "Failed to generate report"
  • Error Code: 10118
    Error Message: "Validation Failed"
Enterprise Provider: Service Request Microservice
Enterprise API:

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

Field Mapping

UI Field Experience API Field MS API Field Transact API Field
NA srmsClaimRequestId NA NA
NA fileId NA NA
ClosedgenerateClaimsList
 
Description: This API exports list of Issued guarantee claims.
Method: POST
URL: {base_url}/services/data/v1/TradeFinance/operations/ReceivedGuarantees/generateClaimsList
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request: 
{
    "searchString": "",
    "pageSize": "",
    "pageOffset": "",
    "sortByParam": "",
    "sortOrder": "",
    "timeParam": "",
    "timeValue": "",
    "filterByValue": "",
    "filterByParam": "",
}
Response: 
{

    "fileId": "RGCL-pJLiNT0P-rky6rh5p-Ul5W2Jkd-hkPSLyTh",
    "opstatus": 0,
    "httpStatusCode": 0

}
Error Code(s):
  • Error Code: 29054
    Error Message: "Error occurred while initiating the trade finance download"
  • Error Code: 29055
    Error Message: "Something went wrong while generating report"
  • Error Code: 29056
    Error Message: "Error occurred while generating the trade finance file"
Enterprise Provider: Service Request Microservice
Enterprise API:

{base_url}/ v2.0.0/orders/party/$partyId?$queryParams

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 timeParam NA NA
NA timeValue NA NA
NA filterByValue NA NA
NA filterByParam NA NA
NA fileId NA NA
ClosedUpdateReceivedGuaranteeClaimByBank
 
Description: This API is a mock service to update the Issued Guarantee Claims from bank.
Method: POST
URL: {base_url}/services/data/v1/TradeFinance/operations/ReceivedGuarantees/UpdateReceivedGuaranteeClaimByBank
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request: 
{
    "claimsSRMSId": "GUCL22223FPPK1",
    "status": "Returned By Bank",
    "reasonForReturn": "No signed stamp1",
    "discrepancy1": "stamp not authorized1",
    "discrepancy2": "not legal document1",
    "documentStatus": "discrepant1",
    "returnedDocuments": "document1.pdf"
}
Response: 
{
    "claimsSRMSId": "GUCL22223FPPK1",
    "discrepancy1": "stamp not authorized1",
    "discrepancy2": "not legal document1",
    "documentStatus": "discrepant1",
    "reasonForReturn": "No signed stamp1",
    "returnedDocuments": "document1.pdf",
    "status": "Returned By Bank",
    "opstatus": 0,
    "httpStatusCode": 0
}
Error Code(s):
  • Error Code: 26014
    Error Message: "Failed to fetch Customer ID"
  • Error Code: 12003
    Error Message: "Invalid Status"
  • Error Code: 29077
    Error Message: "Unknown Status"
  • Error Code: 29070
    Error Message: "SECURITY EXCEPTION - UNAUTHORIZED ACCESS"
  • Error Code: 10118
    Error Message: "Validation Failed"
  • Error Code: 29071
    Error Message: "Unable to fetch the record"
  • Error Code: 29092
    Error Message: "Unable to update guarantee request order"
  • Error Code: 12007
    Error Message: "Logged in User is not authorized to perform this action"
Enterprise Provider: Service Request Microservice
Enterprise API:

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

Field Mapping

UI Field Experience API Field MS API Field Transact API Field
NA claimsSRMSId NA NA
Status status NA NA
Reason From Return reasonForReturn NA NA
Discrepancy 1 discrepancy1 NA NA
Discrepancy 2 discrepancy2 NA NA
Document Status documentStatus NA NA
Returned Documents returnedDocuments NA NA
ClosedObject Data Model
ClosedTrade Finance Object
 
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
Field Name
|
Application/Table name
Expand/ Collapse
Share
Print

In this topic

Temenos Headquarters SA
2 Rue de l'Ecole-de-Chimie
CH - 1205 Geneva
Switzerland

Copyright © 2020- Temenos Headquarters SA

Contact Us

knowledge@temenos.com

Published on :
Tuesday, May 23, 2023 8:38:08 PM IST