Outward Collections - Listings APIs

Name Description Introduced In
createCollection This API is a service to create Outward Collections. 2023.01
deleteCollection This API deletes the Outward Collections. 2023.01
saveCollection This API save the Outward Collections. 2023.01
getCollections This API retrieves the Outward Collections for particular user. 2023.01
getCollectionById This API retrieves the Outward Collections by ID. 2023.01
updateCollection This API updates the Outward Collections. 2023.01
updateCollectionByBank This API updates the Outward Collections by bank. 2023.01
requestCollectionStatus This API updates the request collection status of Outward Collections. 2023.01
generateCollectionReport This API downloads the report for Outward Collections. 2023.01
generateCollectionsList This API exports list of Outward Collections records. 2023.01
Object Data Model This Object Data Model describes the parameter name and other attribute details for Trade Finance.  
ClosedcreateCollection
 
Description: This API is a mock service to create Outward Collections.
Method: POST
URL: {base_url}/services/data/v1/TradeFinance/operations/OutwardCollections/createCollection
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request: 
{
    "allowUsanceAcceptance": "Yes",
    "amount": "1234565.12",
    "collectingBank": "Bank of America",
    "collectingBankAddress": "{\"address1\":\"Test\",\"address2\":\"Test\",\"city\":\"Test\",\"zipcode\":\"12345\",\"country\":\"Select here\",\"state\":\"Test\"}",
    "creditAccount": "130125",
    "currency": "USD",
    "debitAccount": "130125",
    "deliveryInstructions": "Deliver to Mark Zuck, Facebook Team",
    "documentNo": "123456789",
    "draweeAddress": "{\"address1\":\"Test\",\"address2\":\"Test\",\"city\":\"Test\",\"zipcode\":\"12345\",\"country\":\"Select here\",\"state\":\"Test\"}",
    "draweeName": "James Bond",
    "incoTerms": "CIF",
    "instructionsForBills": "[\"ACCEPTANCE/ PAYMENT may await arrival of carrier\",\"Deduct charges from proceeds\",\"Deduct charges from proceeds\"]",
    "messageToBank": "Please proceed for the payment",
    "otherCollectionDetails": "First batch goods shipped, BOE send us a copy",
    "physicalDocuments": "[{\"documentTitle\":\"Invoices\",\"originalsCount\":\"2\",\"copiesCount\":\"3\"},{\"documentTitle\":\"Bill of Landing\",\"originalsCount\":\"Will not submit\",\"copiesCount\":\"Will not Submit\"}]",
    "swiftOrBicCode": "BARCGB22",
    "tenorType": "Usance",
    "uploadDocuments": "[{\"documentName\":\"Clearance Statement.pdf\", \"documentReference\":\"TFD-c05H9v6E-T1fdRSeb-6Id2RQ3u-ztrtQBhU\"}]",
    "usanceDays": "100",
    "usanceDetails": "From the Acceptance"
}
Response: 
{
    "collectionReference": "OCL23005VGVUL",
    "createdOn": "2023-01-05T07:14:15Z",
    "updatedOn": "2023-01-05T07:14:15Z",
    "status": "Submitted to Bank",
    "allowUsanceAcceptance": "Yes",
    "amount": "1234565.12",
    "collectingBank": "Bank of America",
    "collectingBankAddress": "{\"zipcode\":\"12345\",\"country\":\"Select here\",\"address2\":\"Test\",\"city\":\"Test\",\"address1\":\"Test\",\"state\":\"Test\"}",
    "creditAccount": "130125",
    "currency": "USD",
    "debitAccount": "130125",
    "deliveryInstructions": "Deliver to Mark Zuck, Facebook Team",
    "documentNo": "123456789",
    "draweeAddress": "{\"zipcode\":\"12345\",\"country\":\"Select here\",\"address2\":\"Test\",\"city\":\"Test\",\"address1\":\"Test\",\"state\":\"Test\"}",
    "draweeName": "James Bond",
    "incoTerms": "CIF",
    "instructionsForBills": "[\"ACCEPTANCE/ PAYMENT may await arrival of carrier\",\"Deduct charges from proceeds\",\"Deduct charges from proceeds\"]",
    "messageToBank": "Please proceed for the payment",
    "otherCollectionDetails": "First batch goods shipped, BOE send us a copy",
    "physicalDocuments": "[{\"copiesCount\":\"3\",\"originalsCount\":\"2\",\"documentTitle\":\"Invoices\"},{\"copiesCount\":\"Will not Submit\",\"originalsCount\":\"Will not submit\",\"documentTitle\":\"Bill of Landing\"}]",
    "swiftOrBicCode": "BARCGB22",
    "tenorType": "Usance",
    "uploadDocuments": "[{\"documentReference\":\"TFD-c05H9v6E-T1fdRSeb-6Id2RQ3u-ztrtQBhU\",\"documentName\":\"Clearance Statement.pdf\"}]",
    "usanceDays": "100",
    "usanceDetails": "From the Acceptance",
    "opstatus": 0,
    "httpStatusCode": 0
}
Error Code(s):
  • Error Code: 29049
    Error Message: "Mandatory fields are Missing"
  • Error Code: 10118
    Error Message: "Input Validation Failed"
  • Error Code: 12001
    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
NA alertData NA NA
Allow Usance Acceptance allowUsanceAcceptance NA NA
Amount amount NA NA
Request Bill of Exchange billOfExchangeStatus NA NA
Bank Name collectingBank NA NA
Bank Address collectingBankAddress NA NA
NA collectionReference NA NA
Created On createdOn NA NA
Amount Credit Account creditAccount NA NA
Currency currency NA NA
Charges Debit Account debitAccount NA NA
Delivery Instructions deliveryInstructions NA NA
Document Number documentNo NA NA
Drawee Address draweeAddress NA NA
Drawee Name draweeName NA NA
Inco Terms incoTerms NA NA
Instructions for Bills instructionsForBills NA NA
Message to Bank messageToBank NA NA
Other Collection Details otherCollectionDetails NA NA
Request Payment Status paymentStatus NA NA
Physical Documents physicalDocuments NA NA
Status status NA NA
Swift/BIC Code swiftOrBicCode NA NA
Tenor Type tenorType NA NA
Updated On updatedOn NA NA
Uploaded Documents uploadDocuments NA NA
Usance Days usanceDays NA NA
Usance Details usanceDetails NA NA
CloseddeleteCollection
 
Description: This API deletes the Outward Collections.
Method: POST
URL: {base_url}/services/data/v1/TradeFinance/operations/OutwardCollections/deleteCollection
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request: 
{
    "collectionReference": "OCL23005VGVUL"
}
Response: 
{

    "collectionReference": "OCL23005VGVUL",
    "updatedOn": "2022-12-15T11:42:26.213Z",
    "status": "Deleted",
    "allowUsanceAcceptance": "Yes",
    "amount": "11",
    "collectingBank": "Bank of America",
    "collectingBankAddress": "{\"zipcode\":\"12345\",\"country\":\"Select here\",\"address2\":\"Test\",\"city\":\"Test\",\"address1\":\"Test\",\"state\":\"Test\"}",
    "creditAccount": "123161",
    "currency": "USD",
    "debitAccount": "123153",
    "deliveryInstructions": "Deliver to Mark Zuck, Facebook Team",
    "documentNo": "10011002",
    "draweeAddress": "{\"zipcode\":\"12345\",\"country\":\"Select here\",\"address2\":\"Test\",\"city\":\"Test\",\"address1\":\"Test\",\"state\":\"Test\"}",
    "draweeName": "James Bond",
    "incoTerms": "CIF",
    "instructionsForBills": "[\"ACCEPTANCE/ PAYMENT may await arrival of carrier\",\"Deduct charges from proceeds\"]",
    "messageToBank": "Please proceed for the payment",
    "otherCollectionDetails": "First batch goods shipped, BOE send us a copy",
    "physicalDocuments": "[{\"copiesCount\":\"3\",\"originalsCount\":\"2\",\"documentTitle\":\"Invoices\"},{\"copiesCount\":\"Will not Submit\",\"originalsCount\":\"Will not submit\",\"documentTitle\":\"Bill of Landing\"}]",
    "swiftOrBicCode": "BARCGB22",
    "tenorType": "Usance",
    "uploadDocuments": "[{\"documentName\":\"Clearance Statement.pdf\"},{\"documentName\":\"Docuement1.zip\"}]",
    "usanceDays": "100",
    "usanceDetails": "From the Acceptance",
    "opstatus": 0,
    "httpStatusCode": 0

}
Error Code(s):
  • Error Code: 29077
    Error Message: "Unknown Status"
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
Allow Usance Acceptance allowUsanceAcceptance NA NA
Amount amount NA NA
Request Bill of Exchange billOfExchangeStatus NA NA
Bank Name collectingBank NA NA
Bank Address collectingBankAddress NA NA
NA collectionReference NA NA
Created On createdOn NA NA
Amount Credit Account creditAccount NA NA
Currency currency NA NA
Charges Debit Account debitAccount NA NA
Delivery Instructions deliveryInstructions NA NA
Document Number documentNo NA NA
Drawee Address draweeAddress NA NA
Drawee Name draweeName NA NA
Inco Terms incoTerms NA NA
Instructions for Bills instructionsForBills NA NA
Message to Bank messageToBank NA NA
Other Collection Details otherCollectionDetails NA NA
Request Payment Status paymentStatus NA NA
Physical Documents physicalDocuments NA NA
Status status NA NA
Swift/BIC Code swiftOrBicCode NA NA
Tenor Type tenorType NA NA
Updated On updatedOn NA NA
Uploaded Documents uploadDocuments NA NA
Usance Days usanceDays NA NA
Usance Details usanceDetails NA NA
ClosedsaveCollection
 
Description: This API save the Outward Collections.
Method: POST
URL: {base_url}/services/data/v1/TradeFinance/operations/OutwardCollections/saveCollection
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request: 
{

    "allowUsanceAcceptance": "Yes",
    "amount": "11",
    "collectingBank": "Bank of America",
    "collectingBankAddress": "{\"address1\":\"Test\",\"address2\":\"Test\",\"city\":\"Test\",\"zipcode\":\"12345\",\"country\":\"Select here\",\"state\":\"Test\"}",
    "creditAccount": "123161",
    "currency": "USD",
    "debitAccount": "123153",
    "deliveryInstructions": "Deliver to Mark Zuck, Facebook Team",
    "documentNo": "10011002",
    "draweeAddress": "{\"address1\":\"Test\",\"address2\":\"Test\",\"city\":\"Test\",\"zipcode\":\"12345\",\"country\":\"Select here\",\"state\":\"Test\"}",
    "draweeName": "James Bond",
    "incoTerms": "CIF",
    "instructionsForBills": "[\"ACCEPTANCE/ PAYMENT may await arrival of carrier\",\"Deduct charges from proceeds\"]",
    "messageToBank": "Please proceed for the payment",
    "otherCollectionDetails": "First batch goods shipped, BOE send us a copy",
    "physicalDocuments": "[{\"documentTitle\":\"Invoices\",\"originalsCount\":\"2\",\"copiesCount\":\"3\"},{\"documentTitle\":\"Bill of Landing\",\"originalsCount\":\"Will not submit\",\"copiesCount\":\"Will not Submit\"}]",
    "swiftOrBicCode": "BARCGB22",
    "tenorType": "Usance",
    "uploadDocuments": "[{\"documentName\":\"Clearance Statement.pdf\"},{\"documentName\":\"Docuement1.zip\"}]",
    "usanceDays": "100",
    "usanceDetails": "From the Acceptance"
}
Response: 
{

    "collectionReference": "OCL23005VGVUL",
    "status": "Draft",
    "allowUsanceAcceptance": "Yes",
    "amount": "11",
    "collectingBank": "Bank of America",
    "collectingBankAddress": "{\"zipcode\":\"12345\",\"country\":\"Select here\",\"address2\":\"Test\",\"city\":\"Test\",\"address1\":\"Test\",\"state\":\"Test\"}",
    "creditAccount": "123161",
    "currency": "USD",
    "debitAccount": "123153",
    "deliveryInstructions": "Deliver to Mark Zuck, Facebook Team",
    "documentNo": "10011002",
    "draweeAddress": "{\"zipcode\":\"12345\",\"country\":\"Select here\",\"address2\":\"Test\",\"city\":\"Test\",\"address1\":\"Test\",\"state\":\"Test\"}",
    "draweeName": "James Bond",
    "incoTerms": "CIF",
    "instructionsForBills": "[\"ACCEPTANCE/ PAYMENT may await arrival of carrier\",\"Deduct charges from proceeds\"]",
    "messageToBank": "Please proceed for the payment",
    "otherCollectionDetails": "First batch goods shipped, BOE send us a copy",
    "physicalDocuments": "[{\"copiesCount\":\"3\",\"originalsCount\":\"2\",\"documentTitle\":\"Invoices\"},{\"copiesCount\":\"Will not Submit\",\"originalsCount\":\"Will not submit\",\"documentTitle\":\"Bill of Landing\"}]",
    "swiftOrBicCode": "BARCGB22",
    "tenorType": "Usance",
    "uploadDocuments": "[{\"documentName\":\"Clearance Statement.pdf\"},{\"documentName\":\"Docuement1.zip\"}]",
    "usanceDays": "100",
    "usanceDetails": "From the Acceptance",
    "opstatus": 0,
    "httpStatusCode": 0

}
Error Code(s):
  • Error Code: 10118
    Error Message: "Input Validation Failed"
  • Error Code: 12001
    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
Allow Usance Acceptance allowUsanceAcceptance NA NA
Amount amount NA NA
Request Bill of Exchange billOfExchangeStatus NA NA
Bank Name collectingBank NA NA
Bank Address collectingBankAddress NA NA
NA collectionReference NA NA
Created On createdOn NA NA
Amount Credit Account creditAccount NA NA
Currency currency NA NA
Charges Debit Account debitAccount NA NA
Delivery Instructions deliveryInstructions NA NA
Document Number documentNo NA NA
Drawee Address draweeAddress NA NA
Drawee Name draweeName NA NA
Inco Terms incoTerms NA NA
Instructions for Bills instructionsForBills NA NA
Message to Bank messageToBank NA NA
Other Collection Details otherCollectionDetails NA NA
Request Payment Status paymentStatus NA NA
Physical Documents physicalDocuments NA NA
Status status NA NA
Swift/BIC Code swiftOrBicCode NA NA
Tenor Type tenorType NA NA
Updated On updatedOn NA NA
Uploaded Documents uploadDocuments NA NA
Usance Days usanceDays NA NA
Usance Details usanceDetails NA NA
ClosedgetCollections
 
Description: This API retrieves the Outward Collections for particular user.
Method: POST
URL: {base_url}/services/data/v1/TradeFinance/operations/OutwardCollections/getCollections
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request: 
{
    "searchString": "",
    "pageSize": "",
    "pageOffset": "",
    "sortByParam": "",
    "sortOrder": "",
    "timeParam": "",
    "timeValue": "",
    "filterByValue": "",
    "filterByParam": "",
}
Response: 
{
    "OutwardCollections": [
        {
            "allowUsanceAcceptance": "Yes",
            "amount": "123456789012345.00",
            "collectingBank": "Bank of America",
            "collectingBankAddress": "{\"zipcode\":\"12345\",\"country\":\"Select here\",\"address2\":\"Test\",\"city\":\"Test\",\"address1\":\"Test\",\"state\":\"Test\"}",
            "collectionReference": "OCL23005VGVUL",
            "createdOn": "2022-12-15T11:46:03Z",
            "creditAccount": "123161",
            "currency": "USD",
            "debitAccount": "123153",
            "deliveryInstructions": "Deliver to Mark Zuck, Facebook Team",
            "documentNo": "10011002",
            "draweeAddress": "{\"zipcode\":\"\",\"country\":\"\",\"address2\":\"\",\"city\":\"\",\"address1\":\"\",\"state\":\"\"}",
            "draweeName": "James Bond",
            "incoTerms": "CIF",
            "instructionsForBills": "[\"ACCEPTANCE/ PAYMENT may await arrival of carrier\",\"Deduct charges from proceeds\"]",
            "messageToBank": "Please proceed for the payment",
            "otherCollectionDetails": "First batch goods shipped BOE send us a copy",
            "physicalDocuments": "[{\"copiesCount\":\"3\",\"originalsCount\":\"2\",\"documentTitle\":\"Invoices\"},{\"copiesCount\":\"Will not Submit\",\"originalsCount\":\"Will not submit\",\"documentTitle\":\"Bill of Landing\"}]",
            "status": "Submitted to Bank",
            "swiftOrBicCode": "BARCGB22",
            "tenorType": "Usance",
            "updatedOn": "2022-12-15T11:46:03Z",
            "uploadDocuments": "[{\"documentName\":\"Clearance Statement.pdf\"},{\"documentName\":\"Docuement1.zip\"}]",
            "usanceDays": "100",
            "usanceDetails": "From the Acceptance",
            "serviceRequestSrmsId": "OCL23005VGVUL",
            "product": "Outward Collection",
            "tradeCurrency": "USD"
        }
    ],
    "opstatus": 0,
    "httpStatusCode": 0
}
Error Code(s):
  • Error Code: 29093
    Error Message: "Get Request Failed"
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 collectionReference NA NA
Request Payment Status paymentStatus NA NA
Request Bill of Exchange billExchangeStatus NA NA
Created On createdOn NA NA
Updated On updatedOn NA NA
Status status NA NA
Allow Usance Acceptance allowUsanceAcceptance NA NA
Amount amount NA NA
Bank Name collectingBank NA NA
Bank Address collectingBankAddress NA NA
Amount Credit Account creditAccount NA NA
Currency currency NA NA
Charges Debit Account debitAccount NA NA
Delivery Instructions deliveryInstructions NA NA
Document Number documentNo NA NA
Drawee Address draweeAddress NA NA
Drawee Name draweeName NA NA
Inco Terms incoTerms NA NA
Instructions for Bills instructionForBills NA NA
Message to Bank messageToBank NA NA
Other Collection Details otherCollectionDetails NA NA
Physical Documents physicalDocuments NA NA
Swift/BIC Code swiftOrBicCode NA NA
Tenor Type tenorType NA NA
Uploaded Documents usanceDocuments NA NA
Usance Days usanceDays NA NA
Usance Details usanceDetails NA NA
Settled Amount settledAmount NA NA
Bill of Exchange Signed isBillExchangeSigned NA NA
Drawee Acceptance draweeAcceptance NA NA
Drawee Acknowledgement draweeAcknowledgement NA NA
Message from Bank messageFromBank NA NA
Courier Tracking Details courierTrackingDetails NA NA
Maturity Date maturityDate NA NA
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
ClosedgetCollectionById
 
Description: This API retrieves the Outward Collections by ID.
Method: POST
URL: {base_url}/services/data/v1/TradeFinance/operations/OutwardCollections/getCollectionById
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request: 
{
    "collectionReference": "OCL23005VGVUL"
}
Response: 
{

    "allowUsanceAcceptance": "Yes",
    "amount": "123456789012345.12",
    "collectingBank": "Bank of America",
    "collectingBankAddress": "{\"zipcode\":\"12345\",\"country\":\"Select here\",\"address2\":\"Test\",\"city\":\"Test\",\"address1\":\"Test\",\"state\":\"Test\"}",
    "collectionReference": "OCL23005VGVUL",
    "createdOn": "2022-12-15T16:47:43Z",
    "creditAccount": "123161",
    "currency": "ISD",
    "debitAccount": "123153",
    "deliveryInstructions": "Deliver to Mark Zuck, Facebook Team",
    "documentNo": "123456789012345678901234567890asAsD",
    "draweeAddress": "{\"zipcode\":\"12345\",\"country\":\"Select here\",\"address2\":\"Test\",\"city\":\"Test\",\"address1\":\"Test\",\"state\":\"Test\"}",
    "draweeName": "James Bond",
    "incoTerms": "CIF",
    "instructionsForBills": "[\"ACCEPTANCE/ PAYMENT may await arrival of carrier\",\"Deduct charges from proceeds\"]",
    "messageToBank": "Please proceed for the payment",
    "otherCollectionDetails": "First batch goods shipped, BOE send us a copy",
    "physicalDocuments": "[{\"copiesCount\":\"3\",\"originalsCount\":\"2\",\"documentTitle\":\"Invoices\"},{\"copiesCount\":\"Will not Submit\",\"originalsCount\":\"Will not submit\",\"documentTitle\":\"Bill of Landing\"}]",
    "status": "Overdue",
    "swiftOrBicCode": "BARCGB22",
    "tenorType": "Usance",
    "updatedOn": "2022-12-15T16:48:15Z",
    "uploadDocuments": "[{\"documentName\":\"Clearance Statement.pdf\"},{\"documentName\":\"Docuement1.zip\"}]",
    "usanceDays": "100",
    "usanceDetails": "From the Acceptance",
    "opstatus": 0,
    "httpStatusCode": 0
}
Error Code(s):
  • Error Code: 29049
    Error Message: "Mandatory fields are missing"
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 collectionReference NA NA
Request Payment Status paymentStatus NA NA
Request Bill of Exchange billOfExchangeStatus NA NA
Created On createdOn NA NA
Updated On updatedOn NA NA
Status status NA NA
Allow Usance Acceptance allowUsanceAcceptance NA NA
Amount amount NA NA
Bank Name collectingBank NA NA
Bank Address collectingBankAddress NA NA
Amount Credit Account creditAccount NA NA
Currency currency NA NA
Charges Debit Account debitAccount NA NA
Delivery Instructions deliveryInstructions NA NA
Document Number documentNo NA NA
Drawee Address draweeAddress NA NA
Drawee Name draweeName NA NA
Inco Terms incoTerms NA NA
Instructions for Bills instructionsForBills NA NA
Message to Bank messageToBank NA NA
Other Collection Details otherCollectionDetails NA NA
Physical Documents physicalDocuments NA NA
Swift/BIC Code swiftOrBicCode NA NA
Tenor Type tenorType NA NA
Uploaded Documents uploadDocuments NA NA
Usance Days usanceDays NA NA
Usance Details usanceDetails NA NA
Settled Amount settledAmount NA NA
Bill of Exchange Signed isBillExchangeSigned NA NA
Drawee Acceptance draweeAcceptance NA NA
Drawee Acknowledgement draweeAcknowledgement NA NA
Message from Bank messageFromBank NA NA
Courier Tracking Details courierTrackingDetails NA NA
Maturity Date maturityDate NA NA
ClosedupdateCollection
 
Description: This API updates the Outward Collections.
Method: POST
URL: {base_url}/services/data/v1/TradeFinance/operations/OutwardCollections/updateCollection
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request: 
{

    "collectionReference": "OCL23005VGVUL",
    "allowUsanceAcceptance": "Yes",
    "amount": "100.00",
    "collectingBank": "Bank of India",
    "collectingBankAddress": "{\"address1\":\"Test\",\"address2\":\"Test\",\"city\":\"Test\",\"zipcode\":\"12345\",\"country\":\"Select here\",\"state\":\"Test\"}",
    "creditAccount": "123161",
    "currency": "USD",
    "debitAccount": "123153",
    "deliveryInstructions": "Deliver to Mark Zuck, Google Team",
    "documentNo": "10011002",
    "draweeAddress": "{\"address1\":\"\",\"address2\":\"\",\"city\":\"\",\"state\":\"\",\"country\":\"\",\"zipcode\":\"\"}",
    "draweeName": "James Bond",
    "incoTerms": "CIF",
    "instructionsForBills": "[\"ACCEPTANCE/ PAYMENT may await arrival of carrier\",\"Deduct charges from proceeds\"]",
    "messageToBank": "Please proceed for the payment",
    "otherCollectionDetails": "First batch goods shipped BOE send us a copy",
    "physicalDocuments": "[{\"documentTitle\":\"Invoices\",\"originalsCount\":\"2\",\"copiesCount\":\"3\"},{\"documentTitle\":\"Bill of Landing\",\"originalsCount\":\"Will not submit\",\"copiesCount\":\"Will not Submit\"}]",
    "swiftOrBicCode": "BARCGB22",
    "tenorType": "Usance",
    "uploadDocuments": "[{\"documentName\":\"Clearance Statement.pdf\"},{\"documentName\":\"Docuement1.zip\"}]",
    "usanceDays": "100",
    "usanceDetails": "From the Acceptance"

}
Response: 
{

    "collectionReference": "OCL23005VGVUL",
    "updatedOn": "2022-12-15T14:03:16Z",
    "status": "Submitted to Bank",
    "allowUsanceAcceptance": "Yes",
    "amount": "100.00",
    "collectingBank": "Bank of India",
    "collectingBankAddress": "{\"zipcode\":\"12345\",\"country\":\"Select here\",\"address2\":\"Test\",\"city\":\"Test\",\"address1\":\"Test\",\"state\":\"Test\"}",
    "creditAccount": "123161",
    "currency": "USD",
    "debitAccount": "123153",
    "deliveryInstructions": "Deliver to Mark Zuck, Google Team",
    "documentNo": "10011002",
    "draweeAddress": "{\"zipcode\":\"\",\"country\":\"\",\"address2\":\"\",\"city\":\"\",\"address1\":\"\",\"state\":\"\"}",
    "draweeName": "James Bond",
    "incoTerms": "CIF",
    "instructionsForBills": "[\"ACCEPTANCE/ PAYMENT may await arrival of carrier\",\"Deduct charges from proceeds\"]",
    "messageToBank": "Please proceed for the payment",
    "otherCollectionDetails": "First batch goods shipped BOE send us a copy",
    "physicalDocuments": "[{\"copiesCount\":\"3\",\"originalsCount\":\"2\",\"documentTitle\":\"Invoices\"},{\"copiesCount\":\"Will not Submit\",\"originalsCount\":\"Will not submit\",\"documentTitle\":\"Bill of Landing\"}]",
    "swiftOrBicCode": "BARCGB22",
    "tenorType": "Usance",
    "uploadDocuments": "[{\"documentName\":\"Clearance Statement.pdf\"},{\"documentName\":\"Docuement1.zip\"}]",
    "usanceDays": "100",
    "usanceDetails": "From the Acceptance",
    "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"
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 collectionReference NA NA
Created On createdOn NA NA
Updated On updatedOn NA NA
Status status NA NA
Allow Usance Acceptance allowUsanceAcceptance NA NA
Amount amount NA NA
Bank Name collectingBank NA NA
Bank Address collectingBankAddress NA NA
Amount Credit Account creditAccount NA NA
Currency currency NA NA
Charges Debit Account debitAccount NA NA
Delivery Instructions deliveryInstructions NA NA
Document Number documentNo NA NA
Drawee Address draweeAddress NA NA
Drawee Name draweeName NA NA
Inco Terms incoTerms NA NA
Instructions for Bills instructionsForBills NA NA
Message to Bank messageToBank NA NA
Other Collection Details otherCollectionDetails NA NA
Physical Documents physicalDocuments NA NA
Swift/BIC Code swiftOrBicCode NA NA
Tenor Type tenorType NA NA
Uploaded Documents uploadDocuments NA NA
Usance Days usanceDays NA NA
Usance Details usanceDetails NA NA
NA alertData NA NA
ClosedupdateCollectionByBank
 
Description: This API updates the Outward Collections.
Method: POST
URL: {base_url}/services/data/v1/TradeFinance/operations/OutwardCollections/updateCollectionByBank
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request: 
{
    "collectionReference": "OCL23005VGVUL",
    "status": "Approved"
}
Response: 
{
    "collectionReference": "OCL23005VGVUL",
    "createdOn": "2022-12-15T16:50:59Z",
    "updatedOn": "2022-12-15T16:51:14Z",
    "status": "Approved",
    "allowUsanceAcceptance": "Yes",
    "amount": "123456789012345.12",
    "collectingBank": "Bank of America",
    "collectingBankAddress": "{\"zipcode\":\"12345\",\"country\":\"Select here\",\"address2\":\"Test\",\"city\":\"Test\",\"address1\":\"Test\",\"state\":\"Test\"}",
    "creditAccount": "123161",
    "currency": "ISD",
    "debitAccount": "123153",
    "deliveryInstructions": "Deliver to Mark Zuck, Facebook Team",
    "documentNo": "123456789012345678901234567890asAsD",
    "draweeAddress": "{\"zipcode\":\"12345\",\"country\":\"Select here\",\"address2\":\"Test\",\"city\":\"Test\",\"address1\":\"Test\",\"state\":\"Test\"}",
    "draweeName": "James Bond",
    "incoTerms": "CIF",
    "instructionsForBills": "[\"ACCEPTANCE/ PAYMENT may await arrival of carrier\",\"Deduct charges from proceeds\"]",
    "messageToBank": "Please proceed for the payment",
    "otherCollectionDetails": "First batch goods shipped, BOE send us a copy",
    "physicalDocuments": "[{\"copiesCount\":\"3\",\"originalsCount\":\"2\",\"documentTitle\":\"Invoices\"},{\"copiesCount\":\"Will not Submit\",\"originalsCount\":\"Will not submit\",\"documentTitle\":\"Bill of Landing\"}]",
    "swiftOrBicCode": "BARCGB22",
    "tenorType": "Usance",
    "uploadDocuments": "[{\"documentName\":\"Clearance Statement.pdf\"},{\"documentName\":\"Docuement1.zip\"}]",
    "usanceDays": "100",
    "usanceDetails": "From the Acceptance",
    "opstatus": 0,
    "httpStatusCode": 0

}
Error Code(s):
  • Error Code: 12005
    Error Message: "Record is not eligible to update. Reached maximum returns"
  • Error Code: 29077
    Error Message: "Unknown Status"
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 collectionReference NA NA
Request Payment Status paymentStatus NA NA
Request Bill of Exchange billOfExchangeStatus NA NA
Created On createdOn NA NA
Updated On updatedOn NA NA
Status status NA NA
Allow Usance Acceptance allowUsanceAcceptance NA NA
Amount amount NA NA
Bank Name collectingBank NA NA
Bank Address collectingBankAddress NA NA
Amount Credit Account creditAccount NA NA
Currency currency NA NA
Charges Debit Account debitAccount NA NA
Delivery Instructions deliveryInstructions NA NA
Document Number documentNo NA NA
Drawee Address draweeAddress NA NA
Drawee Name draweeName NA NA
Inco Terms incoTerms NA NA
Instructions for Bills instructionsForBills NA NA
Message to Bank messageToBank NA NA
Other Collection Details otherCollectionDetails NA NA
Physical Documents physicalDocuments NA NA
Swift/BIC Code swiftOrBicCode NA NA
Tenor Type tenorType NA NA
Uploaded Documents uploadDocuments NA NA
Usance Days usanceDays NA NA
Usance Details usanceDetails NA NA
Settled Amount settledAmount NA NA
Bill of Exchange Signed isBillExchangeSigned NA NA
Drawee Acceptance draweeAcceptance NA NA
Drawee Acknowledgement draweeAcknowledgement NA NA
Message from Bank messageFromBank NA NA
Courier Tracking Details courierTrackingDetails NA NA
Maturity Date maturityDate NA NA
ClosedrequestCollectionStatus
 
Description: This API updates the request collection status of Outward Collections.
Method: POST
URL: {base_url}/services/data/v1/TradeFinance/operations/OutwardCollections/requestCollectionStatus
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request: 
{
    "collectionReference": "OCA22349LHPNQ",
    "requestSelection": "Payment Status",
    "messageToBank": "Sample Test"
}
Response: 
{
    "collectionReference": "OCL23005VGVUL",
    "paymentStatus": "Requested",
    "createdOn": "2022-12-15T16:47:43Z",
    "updatedOn": "2022-12-15T16:48:15Z",
    "status": "Overdue",
    "allowUsanceAcceptance": "Yes",
    "amount": "123456789012345.12",
    "collectingBank": "Bank of America",
    "collectingBankAddress": "{\"zipcode\":\"12345\",\"country\":\"Select here\",\"address2\":\"Test\",\"city\":\"Test\",\"address1\":\"Test\",\"state\":\"Test\"}",
    "creditAccount": "123161",
    "currency": "ISD",
    "debitAccount": "123153",
    "deliveryInstructions": "Deliver to Mark Zuck, Facebook Team",
    "documentNo": "123456789012345678901234567890asAsD",
    "draweeAddress": "{\"zipcode\":\"12345\",\"country\":\"Select here\",\"address2\":\"Test\",\"city\":\"Test\",\"address1\":\"Test\",\"state\":\"Test\"}",
    "draweeName": "James Bond",
    "incoTerms": "CIF",
    "instructionsForBills": "[\"ACCEPTANCE/ PAYMENT may await arrival of carrier\",\"Deduct charges from proceeds\"]",
    "messageToBank": "Sample Test",
    "otherCollectionDetails": "First batch goods shipped, BOE send us a copy",
    "physicalDocuments": "[{\"copiesCount\":\"3\",\"originalsCount\":\"2\",\"documentTitle\":\"Invoices\"},{\"copiesCount\":\"Will not Submit\",\"originalsCount\":\"Will not submit\",\"documentTitle\":\"Bill of Landing\"}]",
    "swiftOrBicCode": "BARCGB22",
    "tenorType": "Usance",
    "uploadDocuments": "[{\"documentName\":\"Clearance Statement.pdf\"},{\"documentName\":\"Docuement1.zip\"}]",
    "usanceDays": "100",
    "usanceDetails": "From the Acceptance",
    "opstatus": 0,
    "httpStatusCode": 0
}
Error Code(s):
  • Error Code: 29077
    Error Message: "Unknown Status"
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 collectionReference NA NA
Request Payment Status paymentStatus NA NA
Request Bill of Exchange billOfExchangeStatus NA NA
Created On createdOn NA NA
Updated On updatedOn NA NA
Status status NA NA
Allow Usance Acceptance allowUsanceAcceptance NA NA
Amount amount NA NA
Bank Name collectingBank NA NA
Bank Address collectingBankAddress NA NA
Charges Credit Account creditAccount NA NA
Currency currency NA NA
Charges Debit Account debitAccount NA NA
Delivery Instructions deliveryInstructions NA NA
Document Number documentNo NA NA
Drawee Address draweeAddress NA NA
Drawee Name draweeName NA NA
Inco Terms incoTerms NA NA
Instruction for Bills instructionsForBills NA NA
Message to Bank messageToBank NA NA
Other Collection Details otherCollectionDetails NA NA
Physical Documents physicalDocuments NA NA
Swift/BIC Code swiftOrBicCode NA NA
Tenor Type tenorType NA NA
Upload Documents uploadDocuments NA NA
Usance Days usanceDays NA NA
Usance Details usanceDetails NA NA
ClosedgenerateCollectionReport
 
Description: This API downloads the report for Outward Collections.
Method: POST
URL: {base_url}/services/data/v1/TradeFinance/operations/OutwardCollections/generateCollectionReport
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request: 
{
    "collectionReference": "OCL23005VGVUL"
}
Response: 
{

    "fileId": "OUCL-yVioOYFd-nXResPIi-4rfBoCJk-M7nrXAeJ",
    "opstatus": 0,
    "httpStatusCode": 0

}
Error Code(s):
  • Error Code: 29054
    Error Message: "Error occurred while initiating the trade finance download"
  • Error Code: 29056
    Error Message: "Error occurred while generating the trade finance file"
  • Error Code: 29049
    Error Message: "Mandatory fields are Missing"
  • Error Code: 29070
    Error Message: "Mandatory fields are Missing"
  • Error Code: 29071
    Error Message: "Unable to fetch the record"
  • 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 collectionReference NA NA
NA fileId NA NA
ClosedgenerateCollectionsList
 
Description: This API exports list of Outward Collections records.
Method: POST
URL: {base_url}/services/data/v1/TradeFinance/operations/OutwardCollections/generateCollectionsList
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request: 
{
    "searchString": "",
    "pageSize": "",
    "pageOffset": "",
    "sortByParam": "",
    "sortOrder": "",
    "timeParam": "",
    "timeValue": "",
    "filterByValue": "",
    "filterByParam": ""
}
Response: 
{

    "fileId": "OUCL-4kHpl6Ax-B9kCrFs0-NYN8Sd0V-EctEkTds",
    "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/serviceRequest/$serviceReqId

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
ClosedObject Data Model
ClosedOutward Collections
 
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 9:47:12 PM IST