Trade Finance Dashboard APIs
| Name | Description | Introduced In |
|---|---|---|
| FetchAllTradeDetails | This API retrieves all trade details. | 2023.01 |
| FetchPayables | This API retrieves all Payables details. | 2023.01 |
| FetchReceivables | This API retrieves all Receivables details. | 2023.01 |
| FetchTradeFinanceConfiguration | This API retrieves trade finance configurations. | 2023.01 |
| UpdateTradeFinanceConfiguration | This API updates trade finance configurations. | 2023.01 |
| CreateTradeFinanceConfiguration | This API creates trade finance configurations. | 2023.01 |
| Object Data Model | This Object Data Model describes the parameter name and other attribute details for Trade Finance. |
FetchAllTradeDetails
| Description: | This API retrieves all trade details. |
| Method: | POST |
| URL: | {base_url} /services/data/v1/TradeFinance/operations/DashboardOverview/FetchAllTradeDetails |
| Security Level: | Authenticated App User |
| Header Request: | X-Kony-Authorization |
| Body Request: | {
"searchString": "",
"pageSize": "11",
"pageOffset": 0,
"sortByParam": "date",
"sortOrder": "DESC",
"timeParam": "",
"timeValue": "",
"filterByValue": "Returned by Bank,USD",
"filterByParam": "tradeStatus,tradeCurrency"
}
|
| Response: | {
"AllTradeDetails": [{
"product": "Claim Received",
"transactionReference": "IGC23004AP8WW",
"amount": "123",
"tradeStatus": "Recently Completed",
"status": "Claim Honoured",
"date": "2023-01-04T07:08:29Z",
"expiryDate": "2022-10-20T00:00:00Z",
"paymentStatus": "Settled",
"tradeCurrency": "USD",
"guaranteesSRMSId": "RGUA23004PL8VH",
"claimsSRMSId": "IGC23004AP8WW"
}, {
"product": "Received GT & SBLC Amendment",
"transactionReference": "RGAM23004LY77A",
"amount": "1234.00",
"tradeStatus": "Pending Closures",
"status": "Approved",
"date": "2023-01-04T09:39:59Z",
"tradeCurrency": "USD",
"guaranteeSrmsId": "RGUA23004YS03U"
}, {
"product": "Import LC",
"amount": "10",
"tradeStatus": "Pending Closures",
"status": "Approved",
"date": "2023-01-04T12:14:08Z",
"expiryDate": "2023-12-12T00:00:00Z",
"tradeCurrency": "USD"
}, {
"product": "Import LC",
"amount": "10",
"tradeStatus": "Submitted to Bank",
"status": "Submitted to Bank",
"date": "2023-01-04T05:34:37Z",
"expiryDate": "2023-12-12T00:00:00Z",
"tradeCurrency": "USD"
}],
"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 |
|---|---|---|---|
| Product | product | NA | NA |
| NA | transactionReference | NA | NA |
| Amount | amount | NA | NA |
| Trade Status | tradeStatus | NA | NA |
| Status | status | NA | NA |
| Credit Account | creditAccount | NA | NA |
| Account Currency | accountCurrency | NA | NA |
| Available Balance | availableBalance | NA | NA |
| Date | date | NA | NA |
| Expiry Date | expiryDate | NA | NA |
| Payment Status | paymentStatus | NA | NA |
| Debit Account | debitAccount | NA | NA |
| Trade Currency | tradeCurrency | NA | NA |
| NA | exportLCId | NA | NA |
| NA | exportlcSRMSRequestId | NA | NA |
| NA | guaranteeSrmsId | NA | NA |
| NA | collectionSrmsId | NA | NA |
| NA | lcSrmsReqOrderID | NA | NA |
| NA | collectionReference | NA | NA |
| NA | srmsReqOrderID | NA | NA |
FetchPayables
| Description: | This API retrieves all Payables details. |
| Method: | POST |
| URL: | {base_url} /services/data/v1/TradeFinance/operations/DashboardOverview/FetchPayables |
| Security Level: | Authenticated App User |
| Header Request: | X-Kony-Authorization |
| Body Request: | {
"searchString": "",
"pageSize": "11",
"pageOffset": 0,
"sortByParam": "product",
"sortOrder": "ASC",
"timeParam": "expiryDate",
"timeValue": "2023-01-03",
"filterByValue": "USD",
"filterByParam": "tradeCurrency"
}
|
| Response: | {
"Payables": [{
"product": "Claim Received",
"transactionReference": "IGC23004AP8WW",
"amount": "123",
"status": "Claim Honoured",
"paymentStatus": "Paid",
"accountCurrency": "",
"availableBalance": "",
"balanceWithCurrency": "",
"date": "2023-01-04T07:08:29Z",
"expiryDate": "2022-10-20T00:00:00Z",
"tradeCurrency": "USD",
"guaranteesSRMSId": "RGUA23004PL8VH",
"claimsSRMSId": "IGC23004AP8WW"
}, {
"product": "Inward Collection",
"transactionReference": "INC23004N971D",
"amount": "233",
"status": "Approved",
"paymentStatus": "Overdue",
"accountCurrency": "",
"availableBalance": "",
"balanceWithCurrency": "",
"date": "2022-02-02",
"expiryDate": "2022-02-02T00:00:00Z",
"tradeCurrency": "USD",
"collectionSrmsId": "INC23004N971D"
}, {
"product": "Inward Collection",
"transactionReference": "INC23004IHTGT",
"amount": "233",
"status": "Pay Due",
"paymentStatus": "Overdue",
"accountCurrency": "",
"availableBalance": "",
"balanceWithCurrency": "",
"date": "2022-02-02",
"expiryDate": "2022-02-02T00:00:00Z",
"tradeCurrency": "USD",
"collectionSrmsId": "INC23004IHTGT"
}],
"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 |
|---|---|---|---|
| Product | product | NA | NA |
| NA | transactionReference | NA | NA |
| Amount | amount | NA | NA |
| Trade Status | tradeStatus | NA | NA |
| Status | status | NA | NA |
| Credit Account | creditAccount | NA | NA |
| Account Currency | accountCurrency | NA | NA |
| Available Balance | availableBalance | NA | NA |
| Date | date | NA | NA |
| Expiry Date | expiryDate | NA | NA |
| Payment Status | paymentStatus | NA | NA |
| Debit Account | debitAccount | NA | NA |
| Trade Currency | tradeCurrency | NA | NA |
| NA | exportLCId | NA | NA |
| NA | exportlcSRMSRequestId | NA | NA |
| NA | guaranteeSrmsId | NA | NA |
| NA | collectionSrmsId | NA | NA |
| NA | lcSrmsReqOrderID | NA | NA |
| NA | collectionReference | NA | NA |
| NA | srmsReqOrderID | NA | NA |
FetchReceivables
| Description: | This API retrieves all Receivables details. |
| Method: | POST |
| URL: | {base_url} /services/data/v1/TradeFinance/operations/DashboardOverview/FetchReceivables |
| Security Level: | Authenticated App User |
| Header Request: | X-Kony-Authorization |
| Body Request: | {
"searchString": "",
"pageSize": "11",
"pageOffset": 0,
"sortByParam": "product",
"sortOrder": "ASC",
"timeParam": "expiryDate",
"timeValue": "2023-01-03",
"filterByValue": "USD",
"filterByParam": "tradeCurrency"
}
|
| Response: | {
"Receivables": [
{
"product": "Outward Collection",
"transactionReference": "OCL230047ONYJ",
"amount": "1234565.12",
"status": "Approved",
"accountCurrency": "",
"availableBalance": "",
"balanceWithCurrency": "",
"date": "2023-01-04T10:55:33Z",
"tradeCurrency": "USD",
"collectionReference": "OCL230047ONYJ"
},
{
"product": "Outward Collection",
"transactionReference": "OCL23004GQXU9",
"amount": "1234565.12",
"status": "Approved",
"creditAccount": "130125",
"availableBalance": "0",
"date": "2023-01-05T06:26:00Z",
"expiryDate": "0008-06-14T00:00:00Z",
"paymentStatus": "Overdue",
"debitAccount": "130125",
"tradeCurrency": "ISD",
"collectionReference": "OCL23004GQXU9"
},
{
"product": "Outward Collection",
"transactionReference": "OCL23004PVFWR",
"amount": "2345.00",
"status": "Approved",
"creditAccount": "130117",
"availableBalance": "0",
"date": "2023-01-04T05:29:41.238Z",
"debitAccount": "130125",
"tradeCurrency": "USD",
"collectionReference": "OCL23004PVFWR"
}
],
"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 |
|---|---|---|---|
| Product | product | NA | NA |
| NA | transactionReference | NA | NA |
| Amount | amount | NA | NA |
| Trade Status | tradeStatus | NA | NA |
| Status | status | NA | NA |
| Credit Account | creditAccount | NA | NA |
| Account Currency | accountCurrency | NA | NA |
| Available Balance | availableBalance | NA | NA |
| Date | date | NA | NA |
| Expiry Date | expiryDate | NA | NA |
| Payment Status | paymentStatus | NA | NA |
| Debit Account | debitAccount | NA | NA |
| Trade Currency | tradeCurrency | NA | NA |
| NA | exportLCId | NA | NA |
| NA | exportlcSRMSRequestId | NA | NA |
| NA | guaranteeSrmsId | NA | NA |
| NA | collectionSrmsId | NA | NA |
| NA | lcSrmsReqOrderID | NA | NA |
| NA | collectionReference | NA | NA |
| NA | srmsReqOrderID | NA | NA |
FetchTradeFinanceConfiguration
| Description: | This API retrieves trade finance configurations. |
| Method: | POST |
| URL: | {base_url} /services/data/v1/TradeFinance/operations/DashboardOverview/FetchTradeFinanceConfiguration |
| Security Level: | Authenticated App User |
| Header Request: | X-Kony-Authorization |
| Body Request: | {
}
|
| Response: | {
"currencies": "[\"EUR\", \"INR\", \"CHF\", \"IND\"]",
"quickLink": "[\"Export Drawing\", \"Outward Collections\", \"Claims Intiated\", \"Import Drawing\", \"Claims Recived\", \"Inward Collections\"]",
"customConfig": "true",
"needAttention": "[\"Returned By Bank\", \"Utilized Limits\",\"Pending Consent\", \"Pending Closures\"]",
"opstatus": 0,
"httpStatusCode": 0
}
|
| Error Code(s): |
NA |
| 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 |
|---|---|---|---|
| Currencies | currencies | NA | NA |
| Need Attention | needAttention | NA | NA |
| Quick Link | quickLink | NA | NA |
| Custom Config | customConfig | NA | NA |
UpdateTradeFinanceConfiguration
| Description: | This API updates trade finance configurations. |
| Method: | POST |
| URL: | {base_url} /services/data/v1/TradeFinance/operations/DashboardOverview/UpdateTradeFinanceConfiguration |
| Security Level: | Authenticated App User |
| Header Request: | X-Kony-Authorization |
| Body Request: | {
"quickLink": "[\"Export Drawing\", \"Outward Collections\", \"Claims Intiated\", \"Import Drawing\", \"Claims Recived\", \"Inward Collections\"]",
"needAttention": "[\"Returned By Bank\", \"Utilized Limits\",\"Pending Consent\", \"Pending Closures\"]",
"currencies": "[\"EUR\", \"INR\", \"CHF\", \"IND\"]"
}
|
| Response: | {
"message": "Success",
"opstatus": 0,
"httpStatusCode": 0
}
|
| Error Code(s): |
NA |
| 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 |
|---|---|---|---|
| Currencies | currencies | NA | NA |
| Need Attention | needAttention | NA | NA |
| Quick Link | quickLink | NA | NA |
| NA | message | NA | NA |
CreateTradeFinanceConfiguration
| Description: | This API creates trade finance configurations. |
| Method: | POST |
| URL: | {base_url}/services/data/v1/TradeFinance/operations/DashboardOverview/CreateTradeFinanceConfiguration |
| Security Level: | Authenticated App User |
| Header Request: | X-Kony-Authorization |
| Body Request: | {
"quickLink": "[\"Export Drawing\", \"Outward Collections\", \"Claims Intiated\", \"Import Drawing\", \"Claims Recived\", \"Inward Collections\"]",
"needAttention": "[\"Returned By Bank\", \"Utilized Limits\",\"Pending Consent\", \"Pending Closures\"]",
"currencies": "[\"EUR\", \"INR\", \"CHF\", \"IND\"]"
}
|
| Response: | {
"message": "Success",
"opstatus": 0,
"httpStatusCode": 0
}
|
| Error Code(s): |
NA |
| 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 |
|---|---|---|---|
| Currencies | currencies | NA | NA |
| Need Attention | needAttention | NA | NA |
| Quick Link | quickLink | NA | NA |
| NA | message | NA | NA |
FetchLimits
| Description: | This API creates trade finance configurations. |
| Method: | POST |
| URL: | {base_url} /services/data/v1/TradeFinance/operations/DashboardOverview/FetchLimits |
| Security Level: | Authenticated App User |
| Header Request: | X-Kony-Authorization |
| Body Request: | {
"quickLink": "[\"Export Drawing\", \"Outward Collections\", \"Claims Intiated\", \"Import Drawing\", \"Claims Recived\", \"Inward Collections\"]",
"needAttention": "[\"Returned By Bank\", \"Utilized Limits\",\"Pending Consent\", \"Pending Closures\"]",
"currencies": "[\"EUR\", \"INR\", \"CHF\", \"IND\"]"
}
|
| Response: | {
"message": "Success",
"opstatus": 0,
"httpStatusCode": 0
}
|
| Error Code(s): |
NA |
| 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 |
|---|---|---|---|
| Currencies | currencies | NA | NA |
| Need Attention | needAttention | NA | NA |
| Quick Link | quickLink | NA | NA |
| NA | message | NA | NA |
Field Name
|
Application/Table name
In this topic