APIs

This section covers the details of the APIs supported by Holdings microservices.

Get Balances for Account
This API helps to fetch the balance information for the provided account ID.

GET/v1.0.0/holdings/accounts/{accountid}/balances

Sample URL
https://localhost:8302/ms-holdings-api/api/v1.0.0/holdings/accounts/{accountid}/balances
Response
[
  {
    "accountId": "GB0010001-93114",
    "openingDate": "2020-10-01",
    "availableBalance": 500.06,
    "clearedBalance": 500.06,
    "workingBalance": 500.06,
    "onlineActualBalance": 500.06,
    "currencyId": "USD",
    "customerId": "GB0010001-93114",
    "iban": "GB2015468956233FG6",
    "displayName": 100387,
    "sortCode": "575",
    "productName": "Accounts",
    "availableLimit": 546.87,
    "portfolioId": 54,
    "externalIndicator": false,
    "processingTime": "2020-10-01"
  }
]
Get Balances for Entitled Accounts
This API helps to fetch the balances information for the entitled account IDs.

GET/v1.0.0/holdings/accounts/balances

Sample URL
https://localhost:8302/ms-holdings-api/api/v1.0.0/holdings/accounts/balances
Response
[
  {
    "accountId": "GB0010001-93114",
    "openingDate": "2020-10-01",
    "availableBalance": 500.06,
    "clearedBalance": 500.06,
    "workingBalance": 500.06,
    "onlineActualBalance": 500.06,
    "currencyId": "USD",
    "customerId": "GB0010001-93114",
    "iban": "GB2015468956233FG6",
    "displayName": 100387,
    "sortCode": "575",
    "productName": "Accounts",
    "availableLimit": 546.87,
    "portfolioId": 54,
    "externalIndicator": false,
    "processingTime": "2020-10-01"
  }
]
					
Get Transactions for Account
This API helps to fetch the transaction information for the provided account ID.

GET/v1.0.0/holdings/accounts/{accountid}/transactions

Sample URL
https://localhost:8302/ms-holdings-api/api/v1.0.0/holdings/accounts/{accountid}/transactions
								
Response
[
  {
    "id": 192630981843469.03,
    "chequeNumber": 456895,
    "accountId": "GB0010001-80028",
    "valueDate": "2020-10-01",
    "bookingDate": "2020-10-01",
    "processingDate": "2020-10-01",
    "customerId": 100387,
    "accountOfficerId": 26,
    "categorisactionId": 258,
    "amountInAccountCurrency": 5000.06,
    "transactionAmount": 5000.06,
    "currency": "USD",
    "amountInEventCurrency": 5000.06,
    "exchangeRate": 5000.06,
    "externalReference": "FT20108S7K80",
    "customerReference": "FT20108S7K80",
    "transactionReference": "FT20108S7K80",
    "narrative": "Testing",
    "tradeDate": "2020-10-01",
    "externalIndicator": true,
    "balanceSnapshot": 5000.06,
    "processingTime": "2020-10-01"
  }
]
					
Get Transactions for Entitled Accounts
This API helps to fetch the transaction information for the entitled account IDs.

GET/v1.0.0/holdings/accounts/transactions

Sample URL
https://localhost:8302/ms-holdings-api/api/v1.0.0/holdings/accounts/transactions
						
Response
[
  {
    "id": 192630981843469.03,
    "chequeNumber": 456895,
    "accountId": "GB0010001-80028",
    "valueDate": "2020-10-01",
    "bookingDate": "2020-10-01",
    "processingDate": "2020-10-01",
    "customerId": 100387,
    "accountOfficerId": 26,
    "categorisactionId": 258,
    "amountInAccountCurrency": 5000.06,
    "transactionAmount": 5000.06,
    "currency": "USD",
    "amountInEventCurrency": 5000.06,
    "exchangeRate": 5000.06,
    "externalReference": "FT20108S7K80",
    "customerReference": "FT20108S7K80",
    "transactionReference": "FT20108S7K80",
    "narrative": "Testing",
    "tradeDate": "2020-10-01",
    "externalIndicator": true,
    "balanceSnapshot": 5000.06,
    "processingTime": "2020-10-01"
  }
]
					

Bookmark Name Actions
Feedback
x