Inward Collections - Listings APIs
| Name | Description | Introduced In |
|---|---|---|
| createCollection | This API is a mock service to create Inward Collections. | 2022.10 |
| getCollections | This API retrieves Inward Collections for particular customer. | 2022.10 |
| getCollectionById | This API retrieves Inward Collections by ID. | 2022.10 |
| UpdateInwardCollection | This API updates Inward Collections. | 2022.10 |
| Object Data Model | This Object Data Model describes the parameter name and other attribute details for Trade Finance. |
createCollection
| Description: | This API is a mock service to create Inward Collections. |
| Method: | POST |
| URL: | {base_url}/services/data/v1/TradeFinance/operations/InwardCollections/createCollection |
| Security Level: | Authenticated App User |
| Header Request: | X-Kony-Authorization |
| Body Request: | {
"amount": "233",
"billExchangeStatus": "Pending",
"charges": "23",
"currency": "USD",
"documentNo": "2",
"documentsUploaded": "[{\"documentName\":\"Export Letter Of Credit Acknowledgement.pdf\",\"documentReferences\":\"TFD-c05H9v6E-T1fdRSeb-6Id2RQ3u-ztrtQBhU\"}]",
"drawerName": "Meiyaz",
"incoTerms": "CIF",
"maturityDate": "2022-02-02",
"messageFromBank": "Message from bank",
"receivedOn": "2022-02-02",
"remittingBank": "ABC Bank",
"tenorType": "Usance",
"transactionReference": "TF",
"usanceAcceptanceEligibility": "Yes",
"usanceDetails": "Some info on usance"
}
|
| Response: | {
"collectionSrmsId": "INCL22262VZR8N",
"amount": "233",
"billExchangeStatus": "Pending",
"charges": "23",
"createdDate": "2022-09-19T12:24:39Z",
"currency": "USD",
"documentNo": "2",
"documentsUploaded": "[{\"documentName\":\"Export Letter Of Credit Acknowledgement.pdf\",\"documentReferences\":\"TFD-c05H9v6E-T1fdRSeb-6Id2RQ3u-ztrtQBhU\"}]",
"draweeAcknowledgement": "Pending",
"drawerName": "Meiyaz",
"incoTerms": "CIF",
"maturityDate": "2022-02-02",
"messageFromBank": "Message from bank",
"receivedOn": "2022-02-02",
"remittingBank": "ABC Bank",
"status": "New",
"tenorType": "Usance",
"transactionReference": "INCL22262VZR8N",
"usanceAcceptanceEligibility": "Yes",
"usanceDetails": "Some info on usance",
"opstatus": 0,
"httpStatusCode": 0
}
|
| Error Code(s): |
|
| 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 |
|---|---|---|---|
| Amendment Details | amendmentDetails | NA | NA |
| Amount | amount | NA | NA |
| Status | billExchangeStatus | NA | NA |
| Charges | charges | NA | NA |
| Charges Debit Fro | chargesDebitFrom | NA | NA |
| NA | collectionSrmsId | NA | NA |
| Created Date | createdDate | NA | NA |
| Currency | currency | NA | NA |
| Amount Debit From | debitAmountFrom | NA | NA |
| Document Number | documentNo | NA | NA |
| Documents | documentsUploaded | NA | NA |
| Drawee Acknowledgement | draweeAcknowledgement | NA | NA |
| Drawee Acknowledgement Date | draweeAcknowledgementDate | NA | NA |
| Drawee Details | drawerName | NA | NA |
| INCO Terms | incoTerms | NA | NA |
| Last Updated Date | lastUpdatedDate | NA | NA |
| Maturity Date | maturityDate | NA | NA |
| Message from Bank | messageFromBank | NA | NA |
| Message to Bank | messageToBank | NA | NA |
| Payment Status | paymentStatus | NA | NA |
| Reason for Rejection | reasonForRejection | NA | NA |
| Reason for Return | reasonForReturn | NA | NA |
| Received On | receivedOn | NA | NA |
| Remitting Bank | remittingBank | NA | NA |
| Settled Date | settledDate | NA | NA |
| Status | status | NA | NA |
| Tenor Type | tenorType | NA | NA |
| Transaction Ref | transactionReference | NA | NA |
| Usance Acceptance | usanceAcceptance | NA | NA |
| Usance Acceptance Date | usanceAcceptanceDate | NA | NA |
| Usance Acceptance Eligibility | usanceAcceptanceEligibility | NA | NA |
| Usance Details | usanceDetails | NA | NA |
getCollections
| Description: | This API retrieves Inward Collections for particular customer. |
| Method: | POST |
| URL: | {base_url}/services/data/v1/TradeFinance/operations/InwardCollections/getCollections |
| Security Level: | Authenticated App User |
| Header Request: | X-Kony-Authorization |
| Body Request: | {
"searchString": "",
"pageSize": "",
"pageOffset": "",
"sortByParam": "",
"sortOrder": "",
"timeParam": "",
"timeValue": "",
"filterByValue": "",
"filterByParam": "",
"fromDateFilter": "",
"toDateFilter": ""
}
|
| Response: | {
"InwardCollections": [
{
"amount": "233",
"billExchangeStatus": "Pending",
"charges": "23",
"collectionSrmsId": "INCL222597AHJD",
"createdDate": "2022-09-16T12:59:06Z",
"currency": "USD",
"documentNo": "2",
"documentsUploaded": "[{'documentName':'Export Letter Of Credit Acknowledgement.pdf','documentReferences':'TFD-c05H9v6E-T1fdRSeb-6Id2RQ3u-ztrtQBhU'}]",
"draweeAcknowledgement": "Pending",
"drawerName": "Meiyaz",
"incoTerms": "CIF",
"maturityDate": "2022-02-02",
"messageFromBank": "Message from bank",
"receivedOn": "2022-02-02",
"remittingBank": "ABC Bank",
"status": "New",
"tenorType": "Usance",
"transactionReference": "TF",
"usanceAcceptanceEligibility": "Yes",
"usanceDetails": "Some info on usance"
}
],
"opstatus": 0,
"httpStatusCode": 0
}
|
| Error Code(s): |
|
| 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 |
| Amendment Details | amendmentDetails | NA | NA |
| Amount | amount | NA | NA |
| Status | billExchangeStatus | NA | NA |
| Charges | charges | NA | NA |
| Charges Debit Fro | chargesDebitFrom | NA | NA |
| NA | collectionSrmsId | NA | NA |
| Created Date | createdDate | NA | NA |
| Currency | currency | NA | NA |
| Amount Debit From | debitAmountFrom | NA | NA |
| Document Number | documentNo | NA | NA |
| Documents | documentsUploaded | NA | NA |
| Drawee Acknowledgement | draweeAcknowledgement | NA | NA |
| Drawee Acknowledgement Date | draweeAcknowledgementDate | NA | NA |
| Drawee Details | drawerName | NA | NA |
| INCO Terms | incoTerms | NA | NA |
| Last Updated Date | lastUpdatedDate | NA | NA |
| Maturity Date | maturityDate | NA | NA |
| Message from Bank | messageFromBank | NA | NA |
| Message to Bank | messageToBank | NA | NA |
| Payment Status | paymentStatus | NA | NA |
| Reason for Rejection | reasonForRejection | NA | NA |
| Reason for Return | reasonForReturn | NA | NA |
| Received On | receivedOn | NA | NA |
| Remitting Bank | remittingBank | NA | NA |
| Settled Date | settledDate | NA | NA |
| Status | status | NA | NA |
| Tenor Type | tenorType | NA | NA |
| Transaction Ref | transactionReference | NA | NA |
| Usance Acceptance | usanceAcceptance | NA | NA |
| Usance Acceptance Date | usanceAcceptanceDate | NA | NA |
| Usance Acceptance Eligibility | usanceAcceptanceEligibility | NA | NA |
| Usance Details | usanceDetails | NA | NA |
getCollectionById
| Description: | This API retrieves Inward Collections by ID. |
| Method: | POST |
| URL: | {base_url}/services/data/v1/TradeFinance/operations/InwardCollections/getCollectionById |
| Security Level: | Authenticated App User |
| Header Request: | X-Kony-Authorization |
| Body Request: | {
"collectionSrmsId": "INCL222597AHJD"
}
|
| Response: | {
"amount": "233",
"billExchangeStatus": "Pending",
"charges": "23",
"collectionSrmsId": "INCL222597AHJD",
"createdDate": "2022-09-16T12:59:06Z",
"currency": "USD",
"documentNo": "2",
"documentsUploaded": "[{'documentName':'Export Letter Of Credit Acknowledgement.pdf','documentReferences':'TFD-c05H9v6E-T1fdRSeb-6Id2RQ3u-ztrtQBhU'}]",
"draweeAcknowledgement": "Pending",
"drawerName": "Meiyaz",
"incoTerms": "CIF",
"maturityDate": "2022-02-02",
"messageFromBank": "Message from bank",
"receivedOn": "2022-02-02",
"remittingBank": "ABC Bank",
"status": "New",
"tenorType": "Usance",
"transactionReference": "TF",
"usanceAcceptanceEligibility": "Yes",
"usanceDetails": "Some info on usance",
"PaymentAdvices": [],
"SwiftMessages": [],
"opstatus": 0,
"httpStatusCode": 0
}
|
| Error Code(s): |
|
| 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 |
|---|---|---|---|
| Amendment Details | amendmentDetails | NA | NA |
| Amount | amount | NA | NA |
| Status | billExchangeStatus | NA | NA |
| Charges | charges | NA | NA |
| Charges Debit Fro | chargesDebitFrom | NA | NA |
| NA | collectionSrmsId | NA | NA |
| Created Date | createdDate | NA | NA |
| Currency | currency | NA | NA |
| Amount Debit From | debitAmountFrom | NA | NA |
| Document Number | documentNo | NA | NA |
| Documents | documentsUploaded | NA | NA |
| Drawee Acknowledgement | draweeAcknowledgement | NA | NA |
| Drawee Acknowledgement Date | draweeAcknowledgementDate | NA | NA |
| Drawee Details | drawerName | NA | NA |
| INCO Terms | incoTerms | NA | NA |
| Last Updated Date | lastUpdatedDate | NA | NA |
| Maturity Date | maturityDate | NA | NA |
| Message from Bank | messageFromBank | NA | NA |
| Message to Bank | messageToBank | NA | NA |
| Payment Status | paymentStatus | NA | NA |
| Reason for Rejection | reasonForRejection | NA | NA |
| Reason for Return | reasonForReturn | NA | NA |
| Received On | receivedOn | NA | NA |
| Remitting Bank | remittingBank | NA | NA |
| Settled Date | settledDate | NA | NA |
| Status | status | NA | NA |
| Tenor Type | tenorType | NA | NA |
| Transaction Ref | transactionReference | NA | NA |
| Usance Acceptance | usanceAcceptance | NA | NA |
| Usance Acceptance Date | usanceAcceptanceDate | NA | NA |
| Usance Acceptance Eligibility | usanceAcceptanceEligibility | NA | NA |
| Usance Details | usanceDetails | NA | NA |
UpdateInwardCollection
| Description: | This API updates Inward Collections. |
|---|---|
| Method: | POST |
| URL: | {base_url}/services/data/v1/TradeFinance/operations/InwardCollections/UpdateInwardCollection |
| Security Level: | Authenticated App User |
| Header Request: | X-Kony-Authorization |
| Body Request: | {
"amount": "233",
"billExchangeStatus": "Pending",
"charges": "23",
"currency": "USD",
"documentNo": "2",
"documentsUploaded": "[{\"documentName\":\"Export Letter Of Credit Acknowledgement.pdf\",\"documentReferences\":\"TFD-c05H9v6E-T1fdRSeb-6Id2RQ3u-ztrtQBhU\"}]",
"drawerName": "Meiyaz",
"incoTerms": "CIF",
"maturityDate": "2022-02-02",
"messageFromBank": "Message from bank",
"receivedOn": "2022-02-02",
"remittingBank": "ABC Bank",
"tenorType": "Usance",
"transactionReference": "TF",
"usanceAcceptanceEligibility": "Yes",
"usanceDetails": "Some info on usance"
}
|
| Response: | {
"collectionSrmsId": "INCL22262VZR8N",
"amount": "233",
"billExchangeStatus": "Pending",
"charges": "23",
"createdDate": "2022-09-19T12:24:39Z",
"currency": "USD",
"documentNo": "2",
"documentsUploaded": "[{\"documentName\":\"Export Letter Of Credit Acknowledgement.pdf\",\"documentReferences\":\"TFD-c05H9v6E-T1fdRSeb-6Id2RQ3u-ztrtQBhU\"}]",
"draweeAcknowledgement": "Pending",
"drawerName": "Meiyaz",
"incoTerms": "CIF",
"maturityDate": "2022-02-02",
"messageFromBank": "Message from bank",
"receivedOn": "2022-02-02",
"remittingBank": "ABC Bank",
"status": "New",
"tenorType": "Usance",
"transactionReference": "INCL22262VZR8N",
"usanceAcceptanceEligibility": "Yes",
"usanceDetails": "Some info on usance",
"opstatus": 0,
"httpStatusCode": 0
}
|
| Error Code(s): |
|
| 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 |
|---|---|---|---|
| Amount | amount | NA | NA |
| Bill Exchange Status | billExchangeStatus | NA | NA |
| Charges | charges | NA | NA |
| Currency | currency | NA | NA |
| Document Number | documentNo | NA | NA |
| Documents Uploaded | documentsUploaded | NA | NA |
| Drawee Name | drawerName | NA | NA |
| INCO Terms | incoTerms | NA | NA |
| Maturity Date | maturityDate | NA | NA |
| Message from Bank | messageFromBank | NA | NA |
| Received On | receivedOn | NA | NA |
| Remitting Bank | remittingBank | NA | NA |
| Tenor Type | tenorType | NA | NA |
| Transaction Ref | transactionReference | NA | NA |
| Usance Acceptance Eligibility | usanceAcceptanceEligibility | NA | NA |
| Usance Details | usanceDetails | NA | NA |
| NA | collectionSrmsId | NA | NA |
Field Name
|
Application/Table name
In this topic