Holdings
Holdings API allows the user to fetch the account level posted transactions from the Holdings Micro Service. These APIs also allow the user to fetch the balance details for a particular account.
The user must install and integrate the microservice app with the base application before consuming the Holdings API. For more information, click here.
| Name | Description | Introduced In |
|---|---|---|
| getRecent | This API is invoked from the client to fetch the pending Transactions from T24 (customizable) and Posted Transactions from the Holdings Micro Services. (This API is used in OLB application) | 2020.04 |
| getAccountTransactionByType | This API is invoked from the client to fetch the posted Transactions from the Holdings Micro Services. (This is used in Mobile application) | 2020.04 |
| getAccountsPostedTransactionsPreview | Retrieves all the pending and posted transactions for all the accounts of the logged in user. This API is used in smartwatches, where the user can preview the transactions with ease. | 2021.01 |
| getAllTransactionsForAdmin | Retrieves the pending and posted transactions from an account of a customer. This API provides an admin based access to accounts. | 2021.01 |
| getLoanSchedule | Retrieves the overdue and future installments or schedules for a specific loan account. | 2021.01 |
| getPostedUserTransactions | Retrieves all the completed (posted) transactions of a specific user based on the User ID. The User ID gets generated for every user after a successful login. This API is used in mobile applications. | 2021.01 |
| GET | Retrieves the pending and posted transactions of a specific account. | 2021.01 |
| getList(Blocket Funds) | This API retrieves the blocked funds. | 2021.10 |
| generate(Download Transactions) | This API generates the transaction to print. | 2021.10 |
| Object Data Model | This Object Data Model describes the parameter name and other attribute details for Holdings. |
In this scenario, the GetAccountTransactionsByType API is used to fetch the pending transactions from T24 and posted transactions from Microservice for the OLB application, whereas the GetAccountPostedTransactions API is used to fetch the posted transactions for the Mobile application. The output response of the GetAccountTransactionsByType and GetAccountPostedTransactions APIs is the same as both the APIs are pointing to the same endpoint (Microservice). Therefore, when you invoke the GetAccountPostedTransactions API, the output response of this API contains same details.
getRecent
| Description: | This API is invoked from the client to fetch the Pending Transactions from T24 (customizable) and Posted Transactions from the Holdings Micro Services. (This API is used in OLB application) |
| Method: | POST |
| URL: | {base_url}/services/data/v1/Holdings/operations/TransactionsList/getRecent |
| Security Level: | Authenticated App User |
| Header Request: |
|
| Body Request: |
Parameters accountID (Mandatory) Specifies the account number for which the transactions must be fetched transactionType (Mandatory) The transaction type parameter filters the master data response when the user is switching between tabs such as Transfers, Deposits, and Withdrawals. offset Specifies the starting index of the sorted records that are used in pagination. limit Specifies the ending index of the sorted records that are used in pagination. order Specifies the sorting order for the response (Ascending/Descending). sortBy Specifies the sorting criteria for the response such as amount or transactionDate. SearchStartdate (Mandatory) Specifies the date from when all the transactions must be fetched. The date format is yyyy-mm-dd. SearchEnddate Specifies the date up to when all the transactions must be fetched. The date format is yyyy-mm-dd. {
"accountID": "127795",
"transactionType": "All",
"offset": 0,
"limit": 300,
"isScheduled": false,
"order": "desc"
}
|
| Response: |
View the Response Parameters Transactions [ ] The collection that is returned to the client. Parameters installmentAmount Specifies the installment amount that must be paid by the user. principal Specifies the principal amount for the loan taken. interest Specifies the interest amount that has to be paid for the loan taken. outstandingBalance Specifies the outstanding amount that the user has availed. charges Specifies the charges levied on the user. tax Specifies the tax amount levied on the user for availing the loan. insurance Specifies the insurance amount on the loan. cumulativeInterest Specifies the cumulative interest that has been accumulated. statusDescription Specifies the status of the loan transaction. installmentType Specifies the type of installment. paymentDate Specifies the date for payment of the interest. View the Sample Response Code for Mock Services
{
"Transactions": [{
"isScheduled": "false",
"payeeCurrency": "EUR",
"transactionId": "FT211057KR9X",
"fromAccountNumber": "GB0010001-127795",
"description": "NA",
"scheduledDate": "2021-04-15",
"transactionType": "Transfers",
"amount": "-4681.2",
"transactionDate": "2021-04-15",
"postedDate": "2021-04-15",
"statusDescription": "successful",
"fromAccountBalance": "-4000",
"transactionsNotes": "FT211057KR9X",
"transactionCurrency": "EUR"
}],
"opstatus": 0,
"httpStatusCode": 0
}
|
| Error Code(s): |
|
| Enterprise Provider: | Transact |
| Enterprise API: |
{base_url}/v2.0.0/holdings/transactions |
Field Mapping
| UI Field | Experience API field | MS API field | Transact API Field |
|---|---|---|---|
| transactionReference | transactionId | NA | Transactions.transactionId |
| transactionType | transactiontype | NA | Transactions.transactionType |
| bookingDate | transactionDate | NA | Transactions.transactionDate |
| amount | amount | NA | Transactions.amount |
| Balance | fromAccountBalance | NA | Transactions.fromAccountBalance |
| displayName | description | NA | Transactions.description |
getAccountTransactionByType
| Description: | This API is invoked from client to fetch the Posted Transactions from the Holdings Micro Services. (This is used in Mobile application) |
| Method: | POST |
| URL: | /services/data/v1/RBObjects/operations/Transactions/getAccountTransactionByType |
| Security Level: | Authenticated App User |
| Header Request: |
X-Kony-Authorization X-Kony-ReportingParams |
| Body Request: |
Parameters accountID (Mandatory) Specifies the account number for which the transactions must be fetched transactionType The transaction type parameter filters the master data response when the user is switching between tabs such as Transfers, Deposits, and Withdrawals. offset Specifies the starting index of the sorted records that are used in pagination. limit Specifies the ending index of the sorted records that are used in pagination. order Specifies the sorting order for the response (Ascending/Descending). sortBy Specifies the sorting criteria for the response such as amount or transactionDate. {
"accountID" : "GB0010001-87122",
"transactionType" : "All",
"offset": 0,
"limit" : 10,
"order" : "desc",
|
| Response: |
View the Response Parameters
Transactions [ ] The collection that is returned to the client. Parameters Transactions/payeeCurrency Specifies the currency of the amount that has been transacted. Transactions/transactionId Specifies the unique transaction identifier that gets created at the time of transaction. Transactions/fromAccountNumber Specifies the account number from where amount is debited. Transactions/description Specifies the reference generated at the time of transaction creation. Transactions/transactionType Specifies the type of transaction. Transactions/amount Specifies the transacted amount. Transactions/transactionDate Specifies the date of transaction. Transactions/postedDate Specifies the date on which the transaction was posted to the actual backend. Transactions/statusDescription Specifies the status of the transaction (Posted/Pending). Transactions/fromAccountBalance Specifies the balance snapshot of the debit account at the time of transaction. Transactions/transactionsNotes Specifies the user notes entered at the time of transaction creation. View the Response Sample Code
{
"Transactions": [
{
"payeeCurrency": "INR",
"transactionId": "20204",
"fromAccountNumber": "87122",
"description": "Transfer To My Loan Account",
"transactionType": "InternalTransfer",
"amount": "-75.91",
"transactionDate": "2020-02-11T05:33:42Z",
"postedDate": "2020-02-11T05:33:42Z",
"statusDescription": "Pending",
"fromAccountBalance": "5328.66",
"transactionsNotes": "",
},
{
"payeeCurrency": "INR",
"amountRecieved": "0",
"fromAccountNumber": "87122",
"description": "Transfer To Albert",
"transactionType": "ExternalTransfer",
"amount": "-37.19",
"transactionDate": "2020-02-11T05:33:42Z",
"postedDate": "2020-02-11T05:33:42Z",
"statusDescription": "Pending",
"fromAccountBalance": "5252.75",
"transactionsNotes": "",
}
]
}
|
| Error Code(s): | Error Code: 20041 Error Message: "Message stating backend failed while retrieving transactions" |
| Enterprise Provider: | Holdings MS, Transact |
| Enterprise API: |
|
| Transact Artifact: |
AC.API.NOF.TRANSACTIONS.2.0.0 |
getAccountsPostedTransactionsPreview
| Description: | Retrieves all the pending and posted transactions for all the accounts of the logged in user. This API is used in smartwatches, where the user can preview the transactions with ease | ||
| Method: | POST | ||
| URL: | /services/data/v1/RBObjects/operations/Transactions/getAccountPostedTransactionsPreview | ||
| Security Level: | Authenticated App User | ||
| Header Request: |
X-Kony-Authorization X-Kony-ReportingParams |
||
| Body Request: |
Parameters accountID (Mandatory) Specifies the account number for which the transactions must be fetched offset Specifies the starting index of the sorted records that are used in pagination. limit Specifies the ending index of the sorted records that are used in pagination. userName (Mandatory) Specifies the username of the customer. deviceID (Mandatory) Specifies the unique ID of the device with which the customer has logged in. {
"accountID":"GB0010001-87122",
"offset":0,
"limit":10,
"userName":"dbpOlbUser",
"deviceID":"xxx56whs462"
}
|
||
| Response: |
View the Response Parameters
Transactions [ ] The collection that is returned to the client. Parameters Transactions/payeeCurrency Specifies the currency of the amount that has been transacted. Transactions/transactionId Specifies the unique transaction identifier that gets created at the time of transaction. Transactions/fromAccountNumber Specifies the account number from where amount is debited. Transactions/description Specifies the reference generated at the time of transaction creation. Transactions/transactionType Specifies the type of transaction. Transactions/amount Specifies the transacted amount. Transactions/transactionDate Specifies the date of transaction. Transactions/postedDate Specifies the date on which the transaction was posted to the actual backend. Transactions/statusDescription Specifies the status of the transaction (Posted/Pending). Transactions/fromAccountBalance Specifies the balance snapshot of the debit account at the time of transaction. Transactions/transactionsNotes Specifies the user notes entered at the time of transaction creation. View the Response Sample Code
{
"Transactions": [
{
"payeeCurrency": "INR",
"transactionId": "20204",
"fromAccountNumber": "87122",
"description": "Transfer To My Loan Account",
"transactionType": "InternalTransfer",
"amount": "-75.91",
"transactionDate": "2020-02-11T05:33:42Z",
"postedDate": "2020-02-11T05:33:42Z",
"statusDescription": "Pending",
"fromAccountBalance": "5328.66",
"transactionsNotes": "",
},
{
"payeeCurrency": "INR",
"amountRecieved": "0",
"fromAccountNumber": "87122",
"description": "Transfer To Albert",
"transactionType": "ExternalTransfer",
"amount": "-37.19",
"transactionDate": "2020-02-11T05:33:42Z",
"postedDate": "2020-02-11T05:33:42Z",
"statusDescription": "Pending",
"fromAccountBalance": "5252.75",
"transactionsNotes": "",
}
]
}
|
||
| Error Code(s): | Error Code: 20041 Error Message: "Message stating backend failed while retrieving transactions" |
||
| Associated Services: |
|
getAllTransactionsForAdmin
| Description: | Retrieves the pending and posted transactions from an account of a customer. This API provides an admin based access to accounts. | ||
| Method: | POST | ||
| URL: | /services/data/v1/RBObjects/operations/Transactions/getAllTransactionsForAdmin | ||
| Security Level: | Authenticated App User | ||
| Header Request: |
X-Kony-Authorization X-Kony-ReportingParams |
||
| Body Request: |
Parameters accountID (Mandatory) Specifies the account number for which the transactions must be fetched transactionType (Mandatory) The transaction type parameter filters the master data response when the user is switching between tabs such as Transfers, Deposits, and Withdrawals. offset Specifies the starting index of the sorted records that are used in pagination. limit Specifies the ending index of the sorted records that are used in pagination. order Specifies the sorting order for the response (Ascending/Descending). sortBy Specifies the sorting criteria for the response such as amount or transactionDate. SearchStartdate (Mandatory) Specifies the date from when all the transactions must be fetched. The date format is yyyy-mm-dd. SearchEnddate Specifies the date up to when all the transactions must be fetched. The date format is yyyy-mm-dd.
{
"accountID":"GB0010001-87122",
"userName":"dbpOlbUser",
"offset":0,
"limit":10,
"deviceID":"xxx56whs462",
"searchStartDate":"2019-01-01",
"searchEndDate":"2019-01-02",
}
|
||
| Response: |
View the Response Parameters
Transactions [ ] The collection that is returned to the client. Parameters Transactions/payeeCurrency Specifies the currency of the amount that has been transacted. Transactions/transactionId Specifies the unique transaction identifier that gets created at the time of transaction. Transactions/fromAccountNumber Specifies the account number from where amount is debited. Transactions/description Specifies the reference generated at the time of transaction creation. Transactions/transactionType Specifies the type of transaction. Transactions/amount Specifies the transacted amount. Transactions/transactionDate Specifies the date of transaction. Transactions/postedDate Specifies the date on which the transaction was posted to the actual backend. Transactions/statusDescription Specifies the status of the transaction (Posted/Pending). Transactions/fromAccountBalance Specifies the balance snapshot of the debit account at the time of transaction. Transactions/transactionsNotes Specifies the user notes entered at the time of transaction creation. View the Response Sample Code
{
"Transactions": [
{
"payeeCurrency": "INR",
"transactionId": "20204",
"fromAccountNumber": "87122",
"description": "Transfer To My Loan Account",
"transactionType": "InternalTransfer",
"amount": "-75.91",
"transactionDate": "2020-02-11T05:33:42Z",
"postedDate": "2020-02-11T05:33:42Z",
"statusDescription": "Pending",
"fromAccountBalance": "5328.66",
"transactionsNotes": "",
},
{
"payeeCurrency": "INR",
"amountRecieved": "0",
"fromAccountNumber": "87122",
"description": "Transfer To Albert",
"transactionType": "ExternalTransfer",
"amount": "-37.19",
"transactionDate": "2020-02-11T05:33:42Z",
"postedDate": "2020-02-11T05:33:42Z",
"statusDescription": "Pending",
"fromAccountBalance": "5252.75",
"transactionsNotes": "",
}
]
}
|
||
| Error Code(s): | Error Code: 20041 Error Message: "Message stating backend failed while retrieving transactions" |
||
| Associated Services: |
|
getLoanSchedule
| Description: | Retrieves the overdue and future installments or schedules for a specific loan account. |
| Method: | POST |
| URL: | /services/data/v1/RBObjects/operations/Transactions/getLoanSchedule |
| Security Level: | Authenticated App User |
| Header Request: |
X-Kony-Authorization X-Kony-ReportingParams |
| Body Request: |
Parameters accountID (Mandatory) Specifies the account number for which the transactions must be fetched transactionType (Mandatory) The transaction type parameter filters the master data response when the user is switching between tabs such as Transfers, Deposits, and Withdrawals. isFutureRequired (Mandatory) Specifies whether futures are required. The value is Boolean. installmentType (Mandatory) Specifies the type of installment. offset Specifies the starting index of the sorted records that are used in pagination. limit Specifies the ending index of the sorted records that are used in pagination. order Specifies the sorting order for the response (Ascending/Descending). sortBy Specifies the sorting criteria for the response such as amount or transactionDate. SearchStartdate Specifies the date from when all the transactions must be fetched. The date format is yyyy-mm-dd. SearchEnddate Specifies the date up to when all the transactions must be fetched. The date format is yyyy-mm-dd.
{
"accountID":"GB0010001-87122",
"transactionType":"LoanSchedule",
"isFutureRequired":"true",
"userName":"dbpOlbUser",
"offset":0,
"limit":10,
"deviceID":"xxx56whs462",
"searchStartDate":"2019-01-01",
"searchEndDate":"2019-01-02",
}
|
| Response: |
View the Response Parameters
Transactions [ ] The collection that is returned to the client. Parameters Transactions/amount Specifies the currency of the amount that has been transacted. Transactions/fromAccountBalance Specifies the balance snapshot of the debit account at the time of transaction. Transactions/installmentAmount Specifies the installment amount that must be paid by the user. Transactions/principal Specifies the principal amount for the loan taken. Transactions/interest Specifies the interest amount that has to be paid for the loan taken. Transactions/outstandingBalance Specifies the outstanding amount that the user has availed. Transactions/charges Specifies the charges levied on the user. Transactions/tax Specifies the tax amount levied on the user for availing the loan. Transactions/installmentType Specifies the type of installment. Transactions/paymentDate Specifies the date for payment of the interest. View the Response Sample Code
{
"Transactions":[
{
"amount":"0",
"fromAccountBalance":"0",
"installmentAmount":"610.0",
"principal":"300000.0",
"interest":"0.0",
"outstandingBalance":"-300000.0",
"charges":"610",
"tax":"0.0",
"installmentType":"PAID",
"paymentDate":"2020-04-17"
},
{
"amount":"0",
"fromAccountBalance":"0",
"installmentAmount":"897.6",
"principal":"761.98",
"interest":"123.29",
"outstandingBalance":"-299102.4",
"charges":"0",
"tax":"12.33",
"installmentType":"PAID",
"paymentDate":"2020-04-20"
}
]
}
|
| Error Code(s): | Error Code: 20041 Error Message: "Message stating backend failed while retrieving transactions" |
| Enterprise Provider: | Transact |
| Enterprise API: | {Base_URL}/api/v2.0.0/holdings/loans/$arrangementID/schedulePaymentFrequencies?dateFrom=$startDate&dateTo=$endDate |
| Transact Artifact: | AA.API.NOF.LOAN.PAYMENT.SCHEDULES.2.0.0 |
getPostedUserTransactions
| Description: | Retrieves all the completed (posted) transactions of a specific user based on the User ID. The User ID gets generated for every user after a successful login. This API is used in mobile applications. | ||
| Method: | POST | ||
| URL: | /services/data/v1/Holdings/operations/TransactionsList/getPostedUserTransactions | ||
| Security Level: | Authenticated App User | ||
| Header Request: |
X-Kony-Authorization X-Kony-ReportingParams |
||
| Body Request: |
Parameters accountID (Mandatory) Specifies the account number for which the transactions must be fetched. transactionType (Mandatory) The transaction type parameter filters the master data response when the user is switching between tabs such as Transfers, Deposits, and Withdrawals. offset Specifies the starting index of the sorted records that are used in pagination. limit Specifies the ending index of the sorted records that are used in pagination. order Specifies the sorting order for the response (Ascending/Descending). sortBy Specifies the sorting criteria for the response such as amount or transactionDate. searchType The flag which specifies whether the type of request is pending, posted, or search. User_id Specifies the unique ID of the user. isScheduled Specifies whether the transfer is a scheduled transfer or a normal transfer. SearchStartdate (Mandatory) Specifies the date from when all the transactions must be fetched. The date format is yyyy-mm-dd. SearchEnddate Specifies the date up to when all the transactions must be fetched. The date format is yyyy-mm-dd. searchMinAmount Specifies the minimum amount that must act as the lower limit for the search operation. searchMaxAmount Specifies the maximum amount that must act as the upper limit for the search operation.
{
"accountID":"GB0010001-87122",
"transactionType":"LoanSchedule",
"offset":0,
"limit":10,
"order" : "desc",
|
||
| Response: |
View the Response Parameters
Transactions [ ] The collection that is returned to the client. Parameters Transactions/payeeCurrency Specifies the currency of the amount that has been transacted. Transactions/transactionId Specifies the unique transaction identifier that gets created at the time of transaction. Transactions/fromAccountNumber Specifies the account number from where amount is debited. Transactions/description Specifies the reference generated at the time of transaction creation. Transactions/transactionType Specifies the type of transaction. Transactions/amount Specifies the transacted amount. Transactions/transactionDate Specifies the date of transaction. Transactions/postedDate Specifies the date on which the transaction was posted to the actual backend. Transactions/statusDescription Specifies the status of the transaction (Posted/Pending). Transactions/fromAccountBalance Specifies the balance snapshot of the debit account at the time of transaction. Transactions/transactionsNotes Specifies the user notes entered at the time of transaction creation. View the Response Sample Code
{
"Transactions": [
{
"payeeCurrency": "INR",
"transactionId": "20204",
"fromAccountNumber": "87122",
"description": "Transfer To My Loan Account",
"transactionType": "InternalTransfer",
"amount": "-75.91",
"transactionDate": "2020-02-11T05:33:42Z",
"postedDate": "2020-02-11T05:33:42Z",
"statusDescription": "Pending",
"fromAccountBalance": "5328.66",
"transactionsNotes": "",
},
{
"payeeCurrency": "INR",
"amountRecieved": "0",
"fromAccountNumber": "87122",
"description": "Transfer To Albert",
"transactionType": "ExternalTransfer",
"amount": "-37.19",
"transactionDate": "2020-02-11T05:33:42Z",
"postedDate": "2020-02-11T05:33:42Z",
"statusDescription": "Pending",
"fromAccountBalance": "5252.75",
"transactionsNotes": "",
}
]
}
|
||
| Error Code(s): | Error Code: 20041 Error Message: "Message stating backend failed while retrieving transactions" |
||
| Associated Services: |
|
GET
| Description: | Retrieves the pending and posted transactions of a specific account. This API is used in search scenarios. | ||
| Method: | GET | ||
| URL: | /services/data/v1/Holdings/objects/TransactionsList | ||
| Security Level: | Authenticated App User | ||
| Header Request: |
X-Kony-Authorization X-Kony-ReportingParams |
||
| Body Request: |
Parameters accountID (Mandatory) Specifies the account number for which the transactions must be fetched. transactionType (Mandatory) The transaction type parameter filters the master data response when the user is switching between tabs such as Transfers, Deposits, and Withdrawals. offset Specifies the starting index of the sorted records that are used in pagination. limit Specifies the ending index of the sorted records that are used in pagination. order Specifies the sorting order for the response (Ascending/Descending). sortBy Specifies the sorting criteria for the response such as amount or transactionDate. searchType The flag which specifies whether the type of request is pending, posted, or search. User_id Specifies the unique ID of the user. isScheduled Specifies whether the transfer is a scheduled transfer or a normal transfer. SearchStartdate (Mandatory) Specifies the date from when all the transactions must be fetched. The date format is yyyy-mm-dd. SearchEnddate (Mandatory) Specifies the date up to when all the transactions must be fetched. The date format is yyyy-mm-dd. searchMinAmount Specifies the minimum amount that must act as the lower limit for the search operation. searchMaxAmount Specifies the maximum amount that must act as the upper limit for the search operation. {
"accountID":"GB0010001-87122",
"transactionType":"LoanSchedule",
"offset":0,
"limit":10,
"order" : "desc",
|
||
| Response: |
View the Response Parameters
Transactions [ ] The collection that is returned to the client. Parameters Transactions/payeeCurrency Specifies the currency of the amount that has been transacted. Transactions/transactionId Specifies the unique transaction identifier that gets created at the time of transaction. Transactions/fromAccountNumber Specifies the account number from where amount is debited. Transactions/description Specifies the reference generated at the time of transaction creation. Transactions/transactionType Specifies the type of transaction. Transactions/amount Specifies the transacted amount. Transactions/transactionDate Specifies the date of transaction. Transactions/postedDate Specifies the date on which the transaction was posted to the actual backend. Transactions/statusDescription Specifies the status of the transaction (Posted/Pending). Transactions/fromAccountBalance Specifies the balance snapshot of the debit account at the time of transaction. Transactions/transactionsNotes Specifies the user notes entered at the time of transaction creation. View the Response Sample Code
{
"Transactions": [
{
"payeeCurrency": "INR",
"transactionId": "20204",
"fromAccountNumber": "87122",
"description": "Transfer To My Loan Account",
"transactionType": "InternalTransfer",
"amount": "-75.91",
"transactionDate": "2020-02-11T05:33:42Z",
"postedDate": "2020-02-11T05:33:42Z",
"statusDescription": "Pending",
"fromAccountBalance": "5328.66",
"transactionsNotes": "",
},
{
"payeeCurrency": "INR",
"amountRecieved": "0",
"fromAccountNumber": "87122",
"description": "Transfer To Albert",
"transactionType": "ExternalTransfer",
"amount": "-37.19",
"transactionDate": "2020-02-11T05:33:42Z",
"postedDate": "2020-02-11T05:33:42Z",
"statusDescription": "Pending",
"fromAccountBalance": "5252.75",
"transactionsNotes": "",
}
]
}
|
||
| Error Code(s): | Error Code: 20041 Error Message: "Message stating backend failed while retrieving transactions" |
||
| Associated Services: |
|
getList(Blocked Funds)
| Description: | This API is invoked from the client to fetch the Pending Transactions from T24 (customizable) and Posted Transactions from the Holdings Micro Services. (This API is used in OLB application) |
| Method: | POST |
| URL: | {base_url}/services/data/v1/Holdings/operations/BlockFunds/getList |
| Security Level: | Authenticated App User |
| Header Request: |
|
| Body Request: |
Parameters accountID (Mandatory) Specifies the account number for which the transactions must be fetched transactionType (Mandatory) The transaction type parameter filters the master data response when the user is switching between tabs such as Transfers, Deposits, and Withdrawals. offset Specifies the starting index of the sorted records that are used in pagination. limit Specifies the ending index of the sorted records that are used in pagination. order Specifies the sorting order for the response (Ascending/Descending). sortBy Specifies the sorting criteria for the response such as amount or transactionDate. {
"accountID": 118068,
"transactionType": "All",
"offset": 0,
"limit": 300,
"isScheduled": false,
"order": "desc"
}
|
| Response: |
View the Response Parameters Transactions [ ] The collection that is returned to the client. Parameters Transactions/installmentAmount Specifies the installment amount that must be paid by the user. Transactions/principal Specifies the principal amount for the loan taken. Transactions/interest Specifies the interest amount that has to be paid for the loan taken. Transactions/outstandingBalance Specifies the outstanding amount that the user has availed. Transactions/charges Specifies the charges levied on the user. Transactions/tax Specifies the tax amount levied on the user for availing the loan. Transactions/insurance Specifies the insurance amount on the loan. Transactions/cumulativeInterest Specifies the cumulative interest that has been accumulated. Transactions/statusDescription Specifies the status of the loan transaction. Transactions/installmentType Specifies the type of installment. Transactions/paymentDate Specifies the date for payment of the interest. {
"Transactions": [
{
"fromDate": "2020-04-16T08:52:35Z",
"toDate": "2020-04-30T08:52:35Z",
"lockedAmount": "550.00",
"lockReason": "Locked By Bank",
"lockedEventId": "ACLK2010813942",
"transactionReference": "ACLK2010813942"
},
{
"fromDate": "2020-04-11T08:52:35Z",
"toDate": "2020-04-17T08:52:35Z",
"lockedAmount": "1500.00",
"lockReason": "Locked By Bank",
"lockedEventId": "ACLK2010813456",
"transactionReference": "ACLK2010813456"
}
],
"Meta": [
{
"pageSize": "300",
"pageStart": "0",
"totalSize": "2"
}
],
"opstatus": 0,
"httpStatusCode": 0
}
|
| Error Code(s): |
|
| Enterprise Provider: | Transact |
| Enterprise API: |
{base_url}/v2.0.0/holdings/accounts/reservedFunds |
Field Mapping
| UI field | Experience API field | MS API field | Transact API Field |
|---|---|---|---|
| transactionReference | transactionId | NA | Transactions.transactionId |
| lockedAmount | lockedAmount | NA | Transactions.lockedAmount |
| fromDate | fromDate | NA | Transactions.fromDate |
| toDate | toDate | NA | Transactions.toDate |
generate(Download Transactions)
| Description: | This API generates the transaction to print. |
| Method: | POST |
| URL: | {base_url}/services/data/v1/Holdings/operations/BlockFunds/getList |
| Security Level: | Authenticated App User |
| Header Request: |
|
| Body Request: | {
"accountNumber": "118068",
"accountName": "Current Account",
"searchTransactionType": "Both",
"searchStartDate": "2021-09-15",
"searchEndDate": "2021-09-15",
"dateFormat": "m/d/Y",
"fileType": "csv",
"title": "Transactions",
"generatedBy": "2931303417"
}
|
| Response: | {
"opstatus": 0,
"fileId": "8611254904",
"httpStatusCode": 0
}
|
| Error Code(s): |
|
| Enterprise Provider: | MS |
| Enterprise API: |
{base_url}/holdings/accounts/$accountId/transactions |
Field Mapping
| UI field | Experience API field | MS API field | Transact API Field |
|---|---|---|---|
| NA | accountNumber | accountNumber | NA |
| NA | accountName | accountName | NA |
| NA | searchStartDate | searchStartDate | NA |
| NA | searchEndDate | searchEndDate | NA |
| NA | fileType | fileType | NA |
Object Data Model
BlockFunds
| Parameter Name | DataType | Description |
|---|---|---|
|
accountID |
string |
|
|
errmsg |
string |
|
|
searchEndDate |
string |
|
|
searchStartDate |
string |
|
|
fromDate |
string |
|
|
toDate |
string |
|
|
lockedAmount |
string |
|
|
transactionReference |
string |
|
|
lockReason |
string |
|
|
lockedEventId |
string |
|
|
totalSize |
string |
|
|
pageSize |
string |
|
|
pageStart |
string |
|
|
pendingApproval |
string |
|
|
stopReason |
string |
|
|
stopInstructionChannel |
string |
|
In this topic