Guarantees Amendments APIs
The following APIs are end to end integrated with Transact.
| Name | Description | Introduced In |
|---|---|---|
| createGuaranteeAmendment | This API creates Guarantees Amendments. | 2022.07 |
The following are the Experience APIs for Guarantee Amendments.
| Name | Description | Introduced In |
|---|---|---|
| getImportLetterOfCreditAmendments | This API retrieves the list of Import LC Amendments. | 2022.07 |
| getGuaranteeAmendmentById | This API retrieves the Guarantee Amendments by ID. | 2022.07 |
| updateGuaranteeAmendment | This API updates the Guarantee Amendments. | 2022.07 |
| Description: | This API creates Guarantees Amendments. |
| Method: | POST |
| URL: | {base_url}/services/data/v1/TradeFinance/operations/Guarantees/createGuaranteeAmendment |
| Security Level: | Authenticated App User |
| Header Request: | X-Kony-Authorization |
| Body Request: | {
"benificiaryName": "test",
"guaranteesReference": "123",
"currency": "USD",
"amount": "123",
"expiryDate": "2022-03-24",
"productType": "test",
"issueDate": "2022-03-24",
"instructingParty": "partytest",
"billType": "billtest",
"expiryType": "testExp",
"applicantParty": "partytest",
"amendmentNo": "02",
"amendmentEffectiveDate": "2022-03-24",
"amendAmount": "123",
"amendCurrency": "USD",
"amendExpiryType": "test",
"amendExpiryDate": "2022-03-24",
"amendExpiryCondition": "test",
"amendDetails": "test",
"messageToBank": "test",
"amendStatus": "test",
"cancellationStatus": "test",
"corporateUserName": "test",
"supportingDocument": "test",
"guaranteesSRMSId": "GUA221514XEW3"
}
|
| Response: | {
"benificiaryName": "test",
"guaranteesReference": "123",
"currency": "USD",
"amount": "123",
"expiryDate": "2022-03-24",
"productType": "test",
"issueDate": "2022-03-24",
"instructingParty": "partytest",
"billType": "billtest",
"expiryType": "testExp",
"applicantParty": "partytest",
"amendmentNo": "02",
"amendmentEffectiveDate": "2022-03-24",
"amendAmount": "123",
"amendCurrency": "USD",
"amendExpiryType": "test",
"amendExpiryDate": "2022-03-24",
"amendExpiryCondition": "test",
"amendDetails": "test",
"messageToBank": "test",
"amendStatus": "test",
"amendRequestedDate": "2022-06-06 12:47:28.045",
"amendmentReference": "GUAM2215709FFV",
"amendmentSRMSRequestId": "GUAM2215709FFV",
"cancellationStatus": "test",
"corporateUserName": "test",
"supportingDocument": "test",
"guaranteesSRMSId": "GUA221514XEW3",
"opstatus": 0,
"httpStatusCode": 0
}
|
| Error Code(s): |
|
| Enterprise Provider: |
Transact |
| Enterprise API: |
{base_url}/api/v3.0.0/holdings/guarantees/issuances/requests/$relatedTransactionReference/amendments |
Field Mapping
| UI Field | Experience API Field | Transact API Field |
|---|---|---|
| Benificiary Name | benificiaryName | NA |
| GuaranteesCReference | guaranteesReference | NA |
| Currency | currency | NA |
| Amount | amount | NA |
| Expiry Date | expiryDate | NA |
| Product Type | productType | NA |
| Issue Date | issueDate | NA |
| Instructing Party | instructingParty | NA |
| Bill Type | billType | NA |
| Expiry Type | expiryType | NA |
| Applicant Party | applicantParty | NA |
| Amendment No | amendmentNo | NA |
| Amendment Effective Date | amendmentEffectiveDate | NA |
| Amend Amount | amendAmount | NA |
| Amend Currency | amendCurrency | NA |
| Amend Expiry Type | amendExpiryType | NA |
| Amend Expiry Condition | amendExpiryCondition | NA |
| Amend Details | amendDetails | NA |
| Message To Bank | messageToBank | NA |
| Amend Status | amendStatus | NA |
| Amend Requested Date | amendRequestedDate | NA |
| Amendment Reference | amendmentReference | NA |
| Amendment SRMS RequestId | amendmentSRMSRequestId | NA |
| Cancellation Status | cancellationStatus | NA |
| Corporate UserName | corporateUserName | NA |
| Supporting Document | supportingDocument | NA |
| Description: | This API retrieves the list of Import LC Amendments. |
| Method: | POST |
| URL: | {base_url}/services/data/v1/TradeFinance/operations/LetterOfCredit/getImportLetterOfCreditAmendments |
| Security Level: | Authenticated App User |
| Header Request: | X-Kony-Authorization |
| Body Request: | {
"searchString": "",
"pageSize": "",
"pageOffset": "",
"sortByParam": "",
"sortOrder": "",
"timeParam": "",
"timeValue": "",
"filterByValue": "",
"filterByParam": "",
"fromDateFilter": "",
"toDateFilter": ""
}
|
| Response: | {
"GuaranteeLCAmendments": [
{
"benificiaryName": "test",
"guaranteesReference": "123",
"currency": "USD",
"amount": "123",
"expiryDate": "2022-03-24",
"productType": "test",
"issueDate": "2022-03-24",
"instructingParty": "partytest",
"billType": "billtest",
"expiryType": "testExp",
"applicantParty": "partytest",
"amendmentNo": "02",
"amendmentEffectiveDate": "2022-03-24",
"amendAmount": "123",
"amendCurrency": "USD",
"amendExpiryType": "test",
"amendExpiryDate": "2022-03-24",
"amendExpiryCondition": "test",
"amendDetails": "test",
"messageToBank": "test",
"amendStatus": "test",
"amendmentReference": "GUAM22157LQY15",
"amendmentSRMSRequestId": "GUAM22157LQY15",
"cancellationStatus": "test",
"corporateUserName": "test",
"supportingDocument": "test",
"guaranteesSRMSId": "GUA221514XEW3"
}
],
"opstatus": 0,
"httpStatusCode": 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 |
| Description: | This API retrieves the Guarantee Amendments 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: | {
"amendmentSRMSRequestId": "GUAM221572RWDM"
}
|
| Response: | {
"benificiaryName": "test",
"guaranteesReference": "123",
"currency": "USD",
"amount": "123",
"expiryDate": "2022-03-24",
"productType": "test",
"issueDate": "2022-03-24",
"instructingParty": "partytest",
"billType": "billtest",
"expiryType": "testExp",
"applicantParty": "partytest",
"amendmentNo": "02",
"amendmentEffectiveDate": "2022-03-24",
"amendAmount": "123",
"amendCurrency": "USD",
"amendExpiryType": "test",
"amendExpiryDate": "2022-03-24",
"amendExpiryCondition": "test",
"amendDetails": "test",
"messageToBank": "test",
"amendStatus": "test",
"cancellationStatus": "test",
"corporateUserName": "test",
"supportingDocument": "test",
"guaranteesSRMSId": "GUAM221572RWDM",
"opstatus": 0,
"httpStatusCode": 0
}
|
| Error Code(s): |
|
| Enterprise Provider: | |
| Enterprise API: |
Field Mapping
| UI Field | Experience API Field | Transact API Field |
|---|---|---|
| Amendment Reference | amendmentReference | NA |
| Description: | This API updates the Guarantee Amendments. |
| Method: | POST |
| URL: | {base_url}/services/data/v1/TradeFinance/operations/Guarantees/updateGuaranteeAmendment |
| Security Level: | Authenticated App User |
| Header Request: | X-Kony-Authorization |
| Body Request: | {
"benificiaryName": "test",
"guaranteesReference": "123",
"currency": "USD",
"amount": "123",
"expiryDate": "2022-03-24",
"productType": "test",
"issueDate": "2022-03-24",
"instructingParty": "partytest",
"billType": "billtest",
"expiryType": "testExp",
"applicantParty": "partytest",
"amendmentNo": "02",
"amendmentEffectiveDate": "2022-03-24",
"amendAmount": "123",
"amendCurrency": "USD",
"amendExpiryType": "test",
"amendExpiryDate": "2022-03-24",
"amendExpiryCondition": "test",
"amendDetails": "test",
"messageToBank": "test",
"amendStatus": "test",
"cancellationStatus": "test",
"corporateUserName": "test",
"supportingDocument": "test",
"guaranteesSRMSId": "GUA221514XEW3"
}
|
| 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): |
|
| Enterprise Provider: | |
| Enterprise API: |
|
Field Mapping
| UI Field | Experience API Field | Transact API Field |
|---|---|---|
| Benificiary Name | benificiaryName | NA |
| GuaranteesCReference | guaranteesReference | NA |
| Currency | currency | NA |
| Amount | amount | NA |
| Expiry Date | expiryDate | NA |
| Product Type | productType | NA |
| Issue Date | issueDate | NA |
| Instructing Party | instructingParty | NA |
| Bill Type | billType | NA |
| Expiry Type | expiryType | NA |
| Applicant Party | applicantParty | NA |
| Amendment No | amendmentNo | NA |
| Amendment Effective Date | amendmentEffectiveDate | NA |
| Amend Amount | amendAmount | NA |
| Amend Currency | amendCurrency | NA |
| Amend Expiry Type | amendExpiryType | NA |
| Amend Expiry Condition | amendExpiryCondition | NA |
| Amend Details | amendDetails | NA |
| Message To Bank | messageToBank | NA |
| Amend Status | amendStatus | NA |
| Amend Requested Date | amendRequestedDate | NA |
| Amendment Reference | amendmentReference | NA |
| Amendment SRMS RequestId | amendmentSRMSRequestId | NA |
| Cancellation Status | cancellationStatus | NA |
| Corporate UserName | corporateUserName | NA |
| Supporting Document | supportingDocument | NA |
In this topic