APIs

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

  • Version 1.0.0
  • Version 2.0.0
  • Version 3.0.0

Version 1.0.0

The following are the supported APIs in Version 1.0.0.

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"
  }
]

Version 2.0.0

The following are the supported APIs in Version 2.0.0.

Get Balances For Account
This API helps to fetch the balances list for given accountId.

GET/v2.0.0/holdings/accounts/{accountId}/balances

Sample URL
https://localhost:8302/ms-holdings-api/api/v2.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",
    "disbursedAmount": 500.06,
    "outstandingBalance": 500.06,
    "sanctionedAmount": 500.06,
    "extensionData": {}
}]
Get Accounts Balances
This API helps to fetch the balances for entitled accountIds.

GET/v2.0.0/holdings/accounts/balances

Sample URL
https://localhost:8302/ms-holdings-api/api/v2.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",
    "disbursedAmount": 500.06,
    "outstandingBalance": 500.06,
    "sanctionedAmount": 500.06,
    "extensionData": {}
}]
Get Transactions For Account
This API helps to fetch the transactions list for given accountId.

GET/v2.0.0/holdings/accounts/{accountId}/transactions

Sample URL
https://localhost:8302/ms-holdings-api/api/v2.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",
    "extensionData": {}
}]
Get Transactions For Entitled Accounts
This API helps to fetch the transactions list for entitled accountIds.

GET/v2.0.0/holdings/accounts/transactions

Sample URL
https://localhost:8302/ms-holdings-api/api/v2.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",
    "extensionData": {}
}]

Version 3.0.0

The following are the supported APIs in Version 3.0.0.

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

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

Sample URL
https://localhost:8302/ms-holdings-api/api/v3.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",
    "disbursedAmount": 500.06,
    "outstandingBalance": 500.06,
    "sanctionedAmount": 500.06,
    "extensionData": {}
}]
Get Balances for Entitled Accounts
This API helps to fetch the balances information for the entitled account IDs.

GET/v3.0.0/holdings/accounts/balances

Sample URL
https://localhost:8302/ms-holdings-api/api/v3.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",
    "disbursedAmount": 500.06,
    "outstandingBalance": 500.06,
    "sanctionedAmount": 500.06,
    "extensionData": {}
}]
Get Transactions for Account
This API helps to fetch the transaction information for the provided account ID.

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

Sample URL
https://localhost:8302/ms-holdings-api/api/v3.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",
    "extensionData": {}
  }
]
Get Transactions for Entitled Accounts
This API helps to fetch the transaction information for the entitled account IDs.

GET/v3.0.0/holdings/accounts/transactions

Sample URL
https://localhost:8302/ms-holdings-api/api/v3.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",
    "extensionData": {}
  }
]
Expand/Collapse
Share
Print

In this topic

Copyright © 2020- Temenos Headquarters SA

Published on :
Tuesday, October 5, 2021 11:12:42 AM IST

Feedback
x