Received Guarantees and Standby LC APIs

Name Description Introduced In
createGuarantee This API is a mock service to create received guarantees. 2022.10
getGuarantees This API retrieves the list of received guarantees. 2022.10
getGuaranteeById This API retrieves guarantee with SRMS ID. 2022.10
updateGuarantee This API updates received guarantees with self acceptance. 2022.10
generateGuaranteeReport This API downloads report for received guarantees record. 2022.10
generateGuaranteesList This API exports the list of received guarantees. 2022.10
updateGuaranteeByBank This API is a mock service to update the received guarantee from bank. 2022.10
Object Data Model This Object Data Model describes the parameter name and other attribute details for Trade Finance.  
ClosedcreateGuarantee
 
Description: This API is a mock service to create received guarantees.
Method: POST
URL: {base_url}/services/data/v1/TradeFinance/operations/ReceivedGuarantees/createGuarantee
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request: 
{
    "productType": "Guarantee",
    "lcType": "BID",
    "relatedTransactionReference": "RGUA22228D21NR",
    "modeOfTransaction": "Swift",
    "applicantParty": "BUS COMPANY12 - 190939",
    "beneficiaryDetails": [{
        "beneficiaryName": "BUS",
        "address1": "",
        "address2": "",
        "city": "",
        "state": "",
        "country": "",
        "zipcode": "",
        "isCorporate": "false",
        "payeeId": "71014689",
        "payeeType": "sameBank",
        "isChanged": false
    }],
    "amount": "1234.00",
    "currency": "USD",
    "expiryType": "Open Ended",
    "expiryDate": "2025-12-12",
    "expiryConditions": "qwerty",
    "expectedIssueDate": "2025-12-12",
    "autoExtensionExpiry": "Yes",
    "extensionPeriod": "12",
    "extensionCapPeriod": "2025-12-12",
    "notificationPeriod": "12",
    "extensionDetails": "Some ectensible details",
    "applicableRules": "Rule One",
    "governingLaw": "United Arab Emirates",
    "deliveryInstructions": "Some delivery instructions",
    "otherInstructions": "Some other insructions",
    "applicantName": "Meiyaz",
    "applicantAddress": "Temenos, KG360, Chennai, Tamil Nadu, India",
    "issuingBankName": "BNP Paribas Fortis SA/NV",
    "issuingBankSwiftBicCode": "BNP Paribas Fortis SA/NV",
    "issuingBankIban": "1234567",
    "issuingBankLocalCode": "1234",
    "issuingBankAddress": "Temenos, KG360, Chennai, Tamil Nadu, India",
    "messageFromBank": "Message from bank",
    "uploadedDocuments": [{
        "documentName": "Export Letter Of Credit Acknowledgement.pdf",
        "documentReferences": "TFD-c05H9v6E-T1fdRSeb-6Id2RQ3u-ztrtQBhU"
    }],
    "clausesAndConditions": [{
        "clauseId": "1002",
        "clauseType": "Rules Conditions",
        "clauseDescription": "THIS STANDBY LETTER OF CREDIT IS SUBJECT TO THE UNIFORM CUSTOMS AND PRACTICE FOR DOCUMENTARY CREDITS (1993 VERSION) OF THE INTERNATIONAL CHAMBER OF COMMERCE, PUBLICATION NO. 600 OR ITS LATEST REVISION.",
        "clauseTitle": "Rules Conditions"
    }]
}
Response: 
{
    "messageFromBank": "Message from bank",
    "issuingBankName": "BNP Paribas Fortis SA/NV",
    "extensionDetails": "Some ectensible details",
    "extensionPeriod": "12",
    "issuingBankIban": "1234567",
    "guaranteeSrmsId": "RGUA22228MXYD7",
    "expiryDate": "2025-12-12",
    "expiryType": "Open Ended",
    "autoExtensionExpiry": "Yes",
    "receivedOn": "2022-08-16T07:45:46Z",
    "beneficiaryDetails": [{
        "beneficiaryName": "BUS",
        "address1": "",
        "address2": "",
        "city": "",
        "state": "",
        "country": "",
        "zipcode": "",
        "isCorporate": "false",
        "payeeId": "71014689",
        "payeeType": "sameBank",
        "isChanged": false
    }],
    "notificationPeriod": "12",
    "currency": "USD",
    "selfAcceptance": "Pending",
    "productType": "Guarantee",
    "relatedTransactionReference": "RGUA22228D21NR",
    "amount": "1234.00",
    "applicableRules": "Rule One",
    "transactionReference": "RGUA22228MXYD7",
    "extensionCapPeriod": "2025-12-12",
    "applicantAddress": "Temenos, KG360, Chennai, Tamil Nadu, India",
    "governingLaw": "United Arab Emirates",
    "expectedIssueDate": "2025-12-12",
    "applicantParty": "BUS COMPANY12 - 190939",
    "uploadedDocuments": [{
        "documentName": "Export Letter Of Credit Acknowledgement.pdf",
        "documentReferences": "TFD-c05H9v6E-T1fdRSeb-6Id2RQ3u-ztrtQBhU"
    }],
    "applicantName": "Meiyaz",
    "modeOfTransaction": "Swift",
    "deliveryInstructions": "Some delivery instructions",
    "issuingBankAddress": "Temenos, KG360, Chennai, Tamil Nadu, India",
    "clausesAndConditions": [{
        "clauseId": "1002",
        "clauseType": "Rules Conditions",
        "clauseDescription": "THIS STANDBY LETTER OF CREDIT IS SUBJECT TO THE UNIFORM CUSTOMS AND PRACTICE FOR DOCUMENTARY CREDITS (1993 VERSION) OF THE INTERNATIONAL CHAMBER OF COMMERCE, PUBLICATION NO. 600 OR ITS LATEST REVISION.",
        "clauseTitle": "Rules Conditions"
    }],
    "issuingBankLocalCode": "1234",
    "issuingBankSwiftBicCode": "BNP Paribas Fortis SA/NV",
    "lcType": "BID",
    "otherInstructions": "Some other insructions",
    "expiryConditions": "qwerty",
    "status": "New",
    "opstatus": 0,
    "httpStatusCode": 0
}
Error Code(s):
  • Error Code: 26014
    Error Message: "Failed to fetch Customer ID"
  • Error Code: 29091
    Error Message: "Failed to Create 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/party/$partyId/type/$type/subtype/$subtype/serviceRequest

Field Mapping

UI Field Experience API Field MS API Field Transact API Field
Product Type productType NA NA
LC Type lcType NA NA
Related Transaction Reference relatedTransactionReference NA NA
Mode of Transaction modeOfTransaction NA NA
Applicant Party applicantParty NA NA
Beneficiary Details beneficiaryDetails NA NA
Amount amount NA NA
Currency currency NA NA
Expiry Date expiryDate NA NA
Expiry Type expiryType NA NA
Expiry Conditions expiryConditions NA NA
Expected Issue Date expectedIssueDate NA NA
Auto Extension of Expiry autoExtensionExpiry NA NA
Extension Period extensionPeriod NA NA
Extension Cap Period extensionCapPeriod NA NA
Notification Period notificationPeriod NA NA
Extension Details extensionDetails NA NA
Applicable Rules applicableRules NA NA
Governing Law governingLaw NA NA
Delivery Instructions deliveryInstructions NA NA
Other Instructions otherInstructions NA NA
Applicant Name applicantName NA NA
Applicant Address applicantAddress NA NA
Bank Name issuingBankName NA NA
Swift/BIC Code issuingBankSwiftBicCode NA NA
IBAN issuingBankIban NA NA
Local Code issuingBankLocalCode NA NA
Bank Address issuingBankAddress NA NA
Message from Bank messageFromBank NA NA
Uploaded Files uploadedDocuments NA NA
Clauses & Condtions clausesAndConditions NA NA
Status status NA NA
NA guaranteeSrmsId NA NA
Received On receivedOn NA NA
Self Acceptance selfAcceptance NA NA
Transaction Reference transactionReference NA NA
ClosedgetGuarantees
 
Description: This API retrieves the list of received guarantees.
Method: POST
URL: {base_url}/services/data/v1/TradeFinance/operations/ReceivedGuarantees/getGuarantees
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request: 
{
    "searchString": "",
    "pageSize": "",
    "pageOffset": "",
    "sortByParam": "receivedOn",
    "sortOrder": "DESC",
    "timeParam": "receivedOn",
    "timeValue": "6,MONTH",
    "filterByValue": "",
    "filterByParam": ""
}
Response: 
{
    "ReceivedGuarantees": [{
        "messageFromBank": "Message from bank",
        "issuingBankName": "BNP Paribas Fortis SA/NV",
        "extensionDetails": "Some ectensible details",
        "extensionPeriod": "12",
        "issuingBankIban": "1234567",
        "guaranteeSrmsId": "RGUA22228MXYD7",
        "expiryDate": "2025-12-12",
        "expiryType": "Open Ended",
        "autoExtensionExpiry": "Yes",
        "receivedOn": "2022-08-16T07:45:46Z",
        "beneficiaryDetails": "[{'beneficiaryName':'BUS','address1':'','address2':'','city':'','state':'','country':'','zipcode':'','isCorporate':'false','payeeId':'71014689','payeeType':'sameBank','isChanged':false}]",
        "notificationPeriod": "12",
        "currency": "USD",
        "selfAcceptance": "Pending",
        "productType": "Guarantee",
        "relatedTransactionReference": "RGUA22228D21NR",
        "amount": "1234.00",
        "applicableRules": "Rule One",
        "extensionCapPeriod": "2025-12-12",
        "applicantAddress": "Temenos, KG360, Chennai, Tamil Nadu, India",
        "governingLaw": "United Arab Emirates",
        "expectedIssueDate": "2025-12-12",
        "applicantParty": "BUS COMPANY12 - 190939",
        "uploadedDocuments": "[{'documentName':'Export Letter Of Credit Acknowledgement.pdf','documentReferences':'TFD-c05H9v6E-T1fdRSeb-6Id2RQ3u-ztrtQBhU'}]",
        "applicantName": "Meiyaz",
        "modeOfTransaction": "Swift",
        "deliveryInstructions": "Some delivery instructions",
        "issuingBankAddress": "Temenos, KG360, Chennai, Tamil Nadu, India",
        "clausesAndConditions": "[{'clauseId':'1002','clauseType':'Rules Conditions','clauseDescription':'THIS STANDBY LETTER OF CREDIT IS SUBJECT TO THE UNIFORM CUSTOMS AND PRACTICE FOR DOCUMENTARY CREDITS (1993 VERSION) OF THE INTERNATIONAL CHAMBER OF COMMERCE, PUBLICATION NO. 600 OR ITS LATEST REVISION.','clauseTitle':'Rules Conditions'}]",
        "issuingBankLocalCode": "1234",
        "issuingBankSwiftBicCode": "BNP Paribas Fortis SA/NV",
        "lcType": "BID",
        "otherInstructions": "Some other insructions",
        "expiryConditions": "qwerty",
        "status": "New"
    }],
    "opstatus": 0,
    "httpStatusCode": 0
}
Error Code(s):
  • Error Code: 29093
    Error Message: "Get Request failed"
  • Error Code: 26014
    Error Message: "Failed to fetch the 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
Message from Bank messageFromBank NA NA
Bank Name issuingBankName NA NA
Extension Details extensionDetails NA NA
Extension Period extensionPeriod NA NA
IBAN issuingBankIban NA NA
NA guaranteeSrmsId NA NA
Expiry Date expiryDate NA NA
Expiry Type expiryType NA NA
Received On receivedOn NA NA
Beneficiary Details beneficiaryDetails NA NA
Notification Period notificationPeriod NA NA
Currency currency NA NA
Self Acceptance selfAcceptance NA NA
Product Type productType NA NA
Related Transaction Reference relatedTransactionReference NA NA
Amount amount NA NA
Applicable Rules applicableRules NA NA
Extension Cap Period extensionCapPeriod NA NA
Applicant Address applicantAddress NA NA
Governing Law governingLaw NA NA
Expected Issue Date expectedIssueDate NA NA
Applicant Party applicantParty NA NA
Uploaded Files uploadedDocuments NA NA
Applicant Name applicantName NA NA
Mode of Transaction modeOfTransaction NA NA
Delivery Instructions deliveryInstructions NA NA
Bank Address issuingBankAddress NA NA
Clauses & Conditions clausesAndConditions NA NA
Local Code issuingBankLocalCode NA NA
Swift/BIC Code issuingBankSwiftBicCode NA NA
LC Type lcType NA NA
Other Instructions otherInstructions NA NA
Expiry Conditions expiryConditions NA NA
Status status NA NA
ClosedgetGuaranteeById
 
Description: This API retrieves guarantee with SRMS ID.
Method: POST
URL: {base_url}/services/data/v1/TradeFinance/operations/ReceivedGuarantees/getGuaranteeById
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request: 
{
    "guaranteeSrmsId": "RGUA22228MXYD7"
}
Response: 
{
    "messageFromBank": "Message from bank",
    "issuingBankName": "BNP Paribas Fortis SA/NV",
    "extensionDetails": "Some ectensible details",
    "extensionPeriod": "12",
    "issuingBankIban": "1234567",
    "guaranteeSrmsId": "RGUA22228MXYD7",
    "expiryDate": "2025-12-12",
    "expiryType": "Open Ended",
    "autoExtensionExpiry": "Yes",
    "receivedOn": "2022-08-16T07:45:46Z",
    "beneficiaryDetails": "[{'beneficiaryName':'BUS','address1':'','address2':'','city':'','state':'','country':'','zipcode':'','isCorporate':'false','payeeId':'71014689','payeeType':'sameBank','isChanged':false}]",
    "notificationPeriod": "12",
    "currency": "USD",
    "selfAcceptance": "Pending",
    "productType": "Guarantee",
    "relatedTransactionReference": "RGUA22228D21NR",
    "amount": "1234.00",
    "applicableRules": "Rule One",
    "extensionCapPeriod": "2025-12-12",
    "applicantAddress": "Temenos, KG360, Chennai, Tamil Nadu, India",
    "governingLaw": "United Arab Emirates",
    "expectedIssueDate": "2025-12-12",
    "applicantParty": "BUS COMPANY12 - 190939",
    "uploadedDocuments": "[{'documentName':'Export Letter Of Credit Acknowledgement.pdf','documentReferences':'TFD-c05H9v6E-T1fdRSeb-6Id2RQ3u-ztrtQBhU'}]",
    "applicantName": "Meiyaz",
    "modeOfTransaction": "Swift",
    "deliveryInstructions": "Some delivery instructions",
    "issuingBankAddress": "Temenos, KG360, Chennai, Tamil Nadu, India",
    "clausesAndConditions": "[{'clauseId':'1002','clauseType':'Rules Conditions','clauseDescription':'THIS STANDBY LETTER OF CREDIT IS SUBJECT TO THE UNIFORM CUSTOMS AND PRACTICE FOR DOCUMENTARY CREDITS (1993 VERSION) OF THE INTERNATIONAL CHAMBER OF COMMERCE, PUBLICATION NO. 600 OR ITS LATEST REVISION.','clauseTitle':'Rules Conditions'}]",
    "issuingBankLocalCode": "1234",
    "issuingBankSwiftBicCode": "BNP Paribas Fortis SA/NV",
    "lcType": "BID",
    "otherInstructions": "Some other insructions",
    "expiryConditions": "qwerty",
    "status": "New",
    "opstatus": 0,
    "httpStatusCode": 0
}
Error Code(s):
  • Error Code: 29049
    Error Message: "Mandatory fields are Missing"
  • Error Code: 26014
    Error Message: "Failed to fetch the 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: 29071
    Error Message: "Record for the specified SRMSID not found"
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
Message from Bank messageFromBank NA NA
Bank Name issuingBankName NA NA
Extension Details extensionDetails NA NA
Extension Period extensionPeriod NA NA
IBAN issuingBankIban NA NA
NA guaranteeSrmsId NA NA
Expiry Date expiryDate NA NA
Expiry Type expiryType NA NA
Auto Extension of Expiry autoExtensionExpiry NA NA
Received On receivedOn NA NA
Beneficiary Details beneficiaryDetails NA NA
Notification Period notificationPeriod NA NA
Currency currency NA NA
Self Acceptance selfAcceptance NA NA
Product Type productType NA NA
Related Transaction Reference relatedTransactionReference NA NA
Amount amount NA NA
Applicable Rules applicableRules NA NA
Extension Cap Period extensionCapPeriod NA NA
Applicant Address applicantAddress NA NA
Governing Law governingLaw NA NA
Expected Issue Date expectedIssueDate NA NA
Applicant Party applicantParty NA NA
Uploaded Files uploadedDocuments NA NA
Applicant Name applicantName NA NA
Mode of Transaction modeOfTransaction NA NA
Delivery Instructions deliveryInstructions NA NA
Bank Address issuingBankAddress NA NA
Clauses & Conditions clausesAndConditions NA NA
Local Code issuingBankLocalCode NA NA
Swift/BIC Code issuingBankSwiftBicCode NA NA
LC Type lcType NA NA
Other Instructions otherInstructions NA NA
Expiry Conditions expiryConditions NA NA
Status status NA NA
Message to Bank messageToBank NA NA
Reason for Self Rejection reasonForSelfRejection NA NA
Self Acceptance Date selfAcceptanceDate NA NA
Self Rejection History selfRejectionHistory NA NA
ClosedupdateGuarantee
 
Description: This API updates Received Guarantees with self acceptance.
Method: POST
URL: {base_url}/services/data/v1/TradeFinance/operations/ReceivedGuarantees/updateGuarantee
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request: 
{
    "guaranteeSrmsId": "RGUA22228MXYD7",
    "selfAcceptance": "Rejected",
    "reasonForSelfRejection": "Hello",
    "messageToBank": "Hello"
}
Response: 
{
    "messageFromBank": "Message from bank",
    "issuingBankName": "BNP Paribas Fortis SA/NV",
    "extensionDetails": "Some ectensible details",
    "extensionPeriod": "12",
    "issuingBankIban": "1234567",
    "guaranteeSrmsId": "RGUA22228MXYD7",
    "expiryDate": "2025-12-12",
    "expiryType": "Open Ended",
    "autoExtensionExpiry": "Yes",
    "receivedOn": "2022-08-16T07:45:46Z",
    "beneficiaryDetails": "[{'beneficiaryName':'BUS','address1':'','address2':'','city':'','state':'','country':'','zipcode':'','isCorporate':'false','payeeId':'71014689','payeeType':'sameBank','isChanged':false}]",
    "notificationPeriod": "12",
    "currency": "USD",
    "selfAcceptance": "Rejected",
    "productType": "Guarantee",
    "relatedTransactionReference": "RGUA22228D21NR",
    "amount": "1234.00",
    "applicableRules": "Rule One",
    "extensionCapPeriod": "2025-12-12",
    "applicantAddress": "Temenos, KG360, Chennai, Tamil Nadu, India",
    "governingLaw": "United Arab Emirates",
    "expectedIssueDate": "2025-12-12",
    "applicantParty": "BUS COMPANY12 - 190939",
    "uploadedDocuments": "[{'documentName':'Export Letter Of Credit Acknowledgement.pdf','documentReferences':'TFD-c05H9v6E-T1fdRSeb-6Id2RQ3u-ztrtQBhU'}]",
    "applicantName": "Meiyaz",
    "modeOfTransaction": "Swift",
    "deliveryInstructions": "Some delivery instructions",
    "issuingBankAddress": "Temenos, KG360, Chennai, Tamil Nadu, India",
    "clausesAndConditions": "[{'clauseId':'1002','clauseType':'Rules Conditions','clauseDescription':'THIS STANDBY LETTER OF CREDIT IS SUBJECT TO THE UNIFORM CUSTOMS AND PRACTICE FOR DOCUMENTARY CREDITS (1993 VERSION) OF THE INTERNATIONAL CHAMBER OF COMMERCE, PUBLICATION NO. 600 OR ITS LATEST REVISION.','clauseTitle':'Rules Conditions'}]",
    "issuingBankLocalCode": "1234",
    "issuingBankSwiftBicCode": "BNP Paribas Fortis SA/NV",
    "lcType": "BID",
    "otherInstructions": "Some other insructions",
    "expiryConditions": "qwerty",
    "status": "Submitted to Bank",
    "messageToBank": "Hello",
    "reasonForSelfRejection": "Hello",
    "selfAcceptanceDate": "2022-08-16T07:48:17Z",
    "selfRejectionHistory": "[{'rejectionDate':'2022-08-16T07:48:17Z','messageToBank':'Hello','rejectionCount':1,'reasonForSelfRejection':'Hello'}]",
    "opstatus": 0,
    "httpStatusCode": 0
}
Error Code(s):
  • Error Code: 26014
    Error Message: "Failed to fetch the Customer ID"
  • Error Code: 29049
    Error Message: "Mandatory fields are Missing"
  • Error Code: 12007
    Error Message: "Logged in User is not authorized to perform this action"
  • Error Code: 29072
    Error Message: "Unable to update guarantee request order"
  • Error Code: 12002
    Error Message: "Invalid Input"
  • Error Code: 29073
    Error Message: "Record cannot be edited further"
  • Error Code: 12003
    Error Message: "Invalid status found in request payload"
  • Error Code: 29093
    Error Message: "Get Request failed"
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 guaranteeSrmsId NA NA
Self Acceptance selfAcceptance NA NA
Reason For Self Rejection reasonForSelfRejection NA NA
Message to Bank messageToBank NA NA
Message from Bank messageFromBank NA NA
Bank Name issuingBankName NA NA
Extension Details extensionDetails NA NA
Extension Period extensionPeriod NA NA
IBAN issuingBankIban NA NA
Expiry Date expiryDate NA NA
Expiry Type expiryType NA NA
Auto Extension of Expiry autoExtensionExpiry NA NA
Received On receivedOn NA NA
Beneficiary Details beneficiaryDetails NA NA
Notification Period notificationPeriod NA NA
Currency currency NA NA
Product Type productType NA NA
Related Transaction Reference relatedTransactionReference NA NA
Amount amount NA NA
Applicable Rules applicableRules NA NA
Extension Cap Period extensionCapPeriod NA NA
Applicant Address applicantAddress NA NA
Governing Law governingLaw NA NA
Expected Issue Date expectedIssueDate NA NA
Applicant Party applicantParty NA NA
Uploaded Files uploadedDocuments NA NA
Applicant Name applicantName NA NA
Mode of Transaction modeOfTransaction NA NA
Delivery Instructions deliveryInstructions NA NA
Bank Address issuingBankAddress NA NA
Clauses & Conditions clausesAndConditions NA NA
Local Code issuingBankLocalCode NA NA
Swift/BIC Code issuingBankSwiftBicCode NA NA
LC Type lcType NA NA
Other Instructions otherInstructions NA NA
Expiry Conditions expiryConditions NA NA
Status status NA NA
Self Acceptance Date selfAcceptanceDate NA NA
Self Rejection History selfRejectionHistory NA NA
ClosedgenerateGuaranteeReport
 
Description: This API downloads report for received guarantees record.
Method: POST
URL: {base_url}/services/data/v1/TradeFinance/operations/ReceivedGuarantees/generateGuaranteeReport
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request: 
{   
     "guaranteeSrmsId": "RGUA22228MXYD7"
}
Response: 
{
    "fileId": "RGUA-Jgvukl3R-xDwmid6f-ag2hOke5-c1QZD8OG",
    "opstatus": 0,
    "httpStatusCode": 0
}
Error Code(s):
  • Error Code: 26014
    Error Message: "Failed to fetch the Customer ID"
  • Error Code: 29049
    Error Message: "Mandatory fields are Missing"
  • Error Code: 12007
    Error Message: "Logged in User is not authorized to perform this action"
  • Error Code: 29056
    Error Message: "Error occurred while generating the trade finance file"
  • Error Code: 29070
    Error Message: "SECURITY EXCEPTION - UNAUTHORIZED ACCESS"
  • Error Code: 29071
    Error Message: "Record for the specified SRMSID not found"
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 guaranteeSrmsId NA NA
NA fileId NA NA
ClosedgenerateGuaranteesList
 
Description: This API exports the list of received guarantees.
Method: POST
URL: {base_url}/services/data/v1/TradeFinance/operations/ReceivedGuarantees/generateGuaranteesList
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request: 
{
    "searchString": "",
    "pageSize": "",
    "pageOffset": "",
    "sortByParam": "",
    "sortOrder": "",
    "timeParam": "",
    "timeValue": "",
    "filterByValue": "",
    "filterByParam": "",
    "exportLCId": ""
}
Response: 
{
    "fileId": "RGUA-Jgvukl3R-xDwmid6f-ag2hOke5-c1QZD8OG",
    "opstatus": 0,
    "httpStatusCode": 0
}
Error Code(s):
  • Error Code: 26054
    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 Experience 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 exportLCId NA NA
NA fileId NA NA
ClosedupdateGuaranteeByBank
 
Description: This API is a mock service to update the received guarantee from bank.
Method: POST
URL: {base_url}/services/data/v1/TradeFinance/operations/ReceivedGuarantees/updateGuaranteeByBank
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request: 
{
    "guaranteeSrmsId": "RGUA22228MXYD7",
    "status": "Approved",
    "messageFromBank": "Hello"
}
Response: 
{
    "applicant": "Demo4",
    "creditAccount": "120758",
    "chargesDebitAccount": "120758",
    "physicalDocuments": "[{\"count1\":\"1\",\"count2\":\"2\",\"title\":\"Invoice\"},{\"count1\":\"1\",\"count2\":\"2\",\"title\":\"Invoice\"}]",
    "drawingCreatedDate": "2022-03-24T00:00:00Z",
    "financeBill": "Yes",
    "drawingAmount": "200",
    "currency": "USD",
    "documentReference": "some docs",
    "messageToBank": "message",
    "uploadedDocuments": "[\"doc1\",\"doc2\",\"doc3\"]",
    "forwardDocuments": "Yes",
    "status": "Returned By Bank",
    "advisingBankReference": "Cotton goods",
    "exportLCId": "LOCE22082D3QXL",
    "drawingSRMSRequestId": "EXDR22083QQE6P",
    "drawingReferenceNo": "EXDR22083QQE6P",
    "lcReferenceNo": "1212",
    "lcType": "Sight",
    "lcAmount": "2",
    "expiryDate": "2022-03-24",
    "totalDocuments": "2",
    "discrepencies": "[{\"Packing List not signed\":{\"userComment\":\"\",\"userResponse\":\"\"}},{\"Shipping advice stamp is missing\":{\"userComment\":\"\",\"userResponse\":\"\"}}]",
    "paymentStatus": "Settled",
    "totalAmount": "200",
    "messageFromBank": "Test Message",
    "documentStatus": "Discrepant",
    "returnedDate": "2022-03-24",
    "reasonForReturn": "return message",
    "returnedDocuments": "[\"doc1.pdf\"]",
    "opstatus": 0,
    "httpStatusCode": 0
}
Error Code(s):
  • Error Code: 26014
    Error Message: "Failed to fetch the Customer ID"
  • Error Code: 29049
    Error Message: "Mandatory fields are Missing"
  • Error Code: 12003
    Error Message: "Invalid status found in request payload"
  • Error Code: 12002
    Error Message: "Invalid Input"
  • Error Code: 29070
    Error Message: "SECURITY EXCEPTION - UNAUTHORIZED ACCESS"
  • Error Code: 29071
    Error Message: "Record for the specified SRMSID not found"
  • Error Code: 12007
    Error Message: "Logged in User is not authorized to perform this action"
  • 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
Message from Bank messageFromBank NA NA
Bank Name issuingBankName NA NA
Extension Details extensionDetails NA NA
Extension Period extensionPeriod NA NA
IBAN issuingBankIban NA NA
NA guaranteeSrmsId NA NA
Expiry Date expiryDate NA NA
Expiry Type expiryType NA NA
Auto Extension of Expiry autoExtensionExpiry NA NA
Received On receivedOn NA NA
Beneficiary Details beneficiaryDetails NA NA
Notification Period notificationPeriod NA NA
Currency currency NA NA
Self Acceptance selfAcceptance NA NA
Product Type productType NA NA
Related Transaction Reference relatedTransactionReference NA NA
Amount amount NA NA
Applicable Rules applicableRules NA NA
Extension Cap Period extensionCapPeriod NA NA
Applicant Address applicantAddress NA NA
Governing Law governingLaw NA NA
Expected Issue Date expectedIssueDate NA NA
Applicant Party applicantParty NA NA
Uploaded Files uploadedDocuments NA NA
Applicant Name applicantName NA NA
Mode of Transaction modeOfTransaction NA NA
Delivery Instructions deliveryInstructions NA NA
Bank Address issuingBankAddress NA NA
Clauses & Conditions clausesAndConditions NA NA
Local Code issuingBankLocalCode NA NA
Swift/BIC Code issuingBankSwiftBicCode NA NA
LC Type lcType NA NA
Other Instructions otherInstructions NA NA
Expiry Conditions expiryConditions NA NA
Status status NA NA
Message to Bank messageToBank NA NA
Reason for Self Rejection reasonForSelfRejection NA NA
Self Acceptance Date selfAcceptanceDate NA NA
Self Rejection History selfRejectionHistory NA NA
ClosedObject Data Model
ClosedReceived Guarantees
 
Parameter Name DataType Optional/Mandatory Description
amendAmount String Mandatory Amendment Amount
amendExpiryConditions String Mandatory Amendment Expiry Conditions
amendExpiryDate String Mandatory Amendment Expiry Date
amendExpiryType String Mandatory Amendment Expiry Type
amendmentCharges String Mandatory Amendment Charges
amendmentSrmsId String Mandatory SRMS id for amendments
amendmentSRMSRequestId String Mandatory SRMS requests id for amendments
amount String Mandatory Amount
amountWithCurrency String Mandatory Amount with Currency
applicableRules String Mandatory Applicable Rules
applicant String Mandatory Applicant Name
applicantAddress String Mandatory Applicant Address
applicantName String Mandatory Applicant Name
applicantParty String Mandatory Applicant Party
autoExtensionExpiry String Mandatory Auto Extension Expiry
beneficiaryDetails String Mandatory Beneficiary Details
beneficiaryName String Mandatory Beneficiary Name
chargesDebitAccount String Mandatory Charges Debit Account
claimAmount String Mandatory Claim Amount
claimCreditAccount String Mandatory Claim Credit Account
claimCurrency String Mandatory Claim Currency
claimsSRMSId String Mandatory Claim SRMS Id
clausesAndConditions String Mandatory Clauses and Conditions
createdOn String Mandatory Created Date
currency String Mandatory Currency
dateOfAmountChange String Mandatory Date of Amount Change
deliveryInstructions String Mandatory Delivery Instructions
demandType String Mandatory Demand Type
discrepancy1 String Mandatory First Discrepancy
discrepancy1UserComment String Mandatory First Discrepancy User Comment
discrepancy1UserResponse String Optional First Discrepancy User Response
discrepancy2 String Mandatory Second Discrepancy
discrepancy2UserComment String Mandatory Second Discrepancy User Comment
discrepancy2UserResponse String Optional Second Discrepancy User Response
documentInformation String Mandatory Reference for uploaded documents
documentStatus String Mandatory Document Status
expectedIssueDate String Mandatory Expected Isse Date
expiryConditions String Mandatory Expiry Conditions
expiryDate String Mandatory Expiry Date
expiryType String Mandatory Expiry Type
exportLCId String Mandatory SRMS request id of the export LC
extensionCapPeriod String Mandatory Extension Cap Period
extensionDetails String Mandatory Extension Details
extensionPeriod String Mandatory Extension Period
fileId String Mandatory Generated file id from server
filterByParam String Optional Filter parameter in comma separated
filterByValue String Optional Filter value in comma separated
forwardDocuments String Mandatory Forward Documents Status
governingLaw String Mandatory Governing Law
guaranteeAndSBLCType String Mandatory Guarantee and SBLC Type
GuaranteeClaims String Mandatory Guarantee Claims
guaranteesReferenceNo String Mandatory Guarantee Reference Number
guaranteesSRMSId String Mandatory Guarantees SRMS Id
issueDate String Mandatory Issuing Date
issuingBank String Mandatory Issuing Bank Name
issuingBankAddress String Mandatory Issuing Bank Address
issuingBankIban String Mandatory Issuing Bank IBAN
issuingBankLocalCode String Mandatory Issuing Bank Local Code
issuingBankName String Mandatory Issuing Bank Name
issuingBankSwiftBicCode String Mandatory Issuing Bank Swift or BIC Code
lcType String Mandatory Letter of Credit Type
messageFromBank String Optional Message from Bank
messageToBank String Optional Message to Bank
modeOfTransaction String Mandatory Mode of Transaction
newExtensionDate String Mandatory New Extension Date
notificationPeriod String Mandatory Notification Period
otherDemandDetails String Mandatory Other Demand Details
otherInstructions String Mandatory Other Instructions
pageOffset String Optional Defines fetching records from the count mentioned
pageSize String Optional The count of records in response
paymentSettledDate String  Mandatory Payment Settled Date
paymentStatus String Mandatory Payment Status
physicalDocuments String Mandatory Physical Document Status
productType String Mandatory Product Type
reasonForReturn String Mandatory Reason for Return
reasonForSelfRejection String Optional Reason for Self Rejection
receivedOn String Mandatory Received Date
relatedTransactionReference String Optional Related Transaction Reference
returnedCount String Mandatory Returned Count from Bank
returnedDocuments String Optional Returned Documents from Bank
returnedHistory String Optional Returned History from Bank
returnedTime String Mandatory Returned Time
returnMessageToBank String Optional Return Message To Bank
searchString String Optional Search Keyword
selfAcceptance String Mandatory Self Acceptance
selfAcceptanceDate String Mandatory Self Acceptance Date
selfRejectionHistory String Mandatory Self Rejection History
sortByParam String Optional Sorting paramenters in comma seperated
sortOrder String Optional Sorting values in comma separated
srmsClaimRequestId String Mandatory SRMS requests id for claims record
status String Mandatory Status of record
supportingDocuments String Mandatory Supporting Documents
timeParam String Optional Time Parameter
timeValue String Optional Time value separated with count and time period
totalDocuments String Mandatory Total Count of Documents
transactionReference String Mandatory Transaction Reference
uploadedDocuments String Mandatory Uploaded Documents
utilizedAmount String Mandatory Utilized Amount
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:07 PM IST