Microservices
Updated On 03 December 2024 | Min(s) read

Enterprise APIs

The Holdings Microservice APIs can be categorized under the following versions:

Following are the list of Business APIs supported:

Tags Scenario Operation Name  API Version URI
Balances List Balances for given Account ID getBalancesForAccount V1.0.0 /holdings/accounts/{accountId}/balances
List Balances for Entitled Account IDs getAccountsBalances V1.0.0 /holdings/accounts/balances
Transactions List Transactions for given accountId getTransactionsForAccount V1.0.0 /holdings/accounts/{accountId}/transactions
List Transactions for entitled accountIds getTransactionsForEntitledAccounts V1.0.0 /holdings/accounts/transactions
  Create the new Arrangement, party and payInOut data createArrangementInfo V1.0.0 /holdings/arrangements/
  Update the existing Arrangement, party and payInOut data updateArrangementInfo V1.0.0 /holdings/arrangements/{arrangementId}
  Get the Arrangement, party and payInOut data getArrangementDetails V1.0.0 /holdings/arrangements/{arrangementId}
  Get ArrangementDetails for the list of arrangementid/IBAN getBulkArrangements V1.0.0 /holdings/bulkArrangements/{arrangementId}
  Get all the Arrangement Details of the partyId getPartyArrangementDetails V1.0.0 /holdings/parties/{partyId}/bulkArrangements
  Get the Party Roles for the ArrangementId getPartyRoleForArrangement V1.0.0 /holdings/arrangement/{arrangementId}/roles
Arrangement Details Get the Arrangement data getReconciledArrangementDetails V1.0.0 /holdings/arrangements/{arrangementId}/reconcile
Get all Arrangements of the partyId and search using extension data getArrangementsForParty V1.0.0 /holdings/parties/{partyId}/arrangements
Get all the Arrangement's Basic Details for a PartyId and its balances via query param includeBalance getPartyArrangementBasicDetails V1.0.0 /holdings/accounts/parties/{partyId}/arrangements
Party Arrangement Details Get the list of Accounts for a party getListofAccounts V1.0.0 /holdings/parties/{partyId}/accounts
Party Details Create the new Party createPartyInfo V1.0.0 /party/parties/{partyId}
Update the existing Party updatePartyInfo V1.0.0 /party/parties/{partyId}
Get the Party Details getPartyDetails V1.0.0 /party/parties/{partyId}
Get the Party Roles for the PartyId getPartyRole V1.0.0 /party/roles/{partyId}
Enrichment Details Get the List of Product Details available getListOfProducts V1.0.0 /reference/products
Create new product createProduct V1.0.0 /reference/products/{productId}
Update new product updateProduct V1.0.0 /reference/products/{productId}
Get the List of Officer Details available getListOfOfficer V1.0.0 /reference/officers
Create new officer createOfficer V1.0.0 /reference/officers/{officerId}
Update officer details updateOfficer V1.0.0 /reference/officers/{officerId}
Get the List of Posting Restrict Details available getListOfPostingRestrict V1.0.0 /reference/postingRestricts
Create new Posting Restrict createPostingRestrict V1.0.0 /reference/postingRestricts/{postingRestrictId}
Update Posting Restrict updatePostingRestrict V1.0.0 /reference/postingRestricts/{postingRestrictId}
Get the List of company Details available getListOfCompany V1.0.0 /reference/companies
Create new Company createCompany V1.0.0  /reference/companies/{companyId}
Update Company Details updateCompany V1.0.0  /reference/companies/{companyId}
Payment Schedule Get the Payment Schedules for the Arrangement ID getScheduleForArrangement V1.0.0 /holdings/arrangement/{arrangementId}/schedules
Get the Payment Schedules for the Arrangement ID getScheduleStatusForArrangement V1.0.0 /holdings/arrangement/{arrangementId}/scheduleStatus
Payments Get STP rate of payments GetSTPRate V1.0.0 /holdings/payments/rates/stpRates
Get Payments GetPayments V1.0.0 /holdings/payments/paymentDetails
Get payments activity by Channel getPaymentsByChannel V1.0.0 /holdings/payments/channels/currencies/amounts
Get payments activity by Scheme getPaymentsByScheme V1.0.0 /holdings/payments/schemes/transfers
Sub Asset Type Details Get the sub Asset Type details based on the subAssetTypeId getSubAssetTypeDetails V1.0.0 /reference/references/holdings/subAssetType/{subAssetTypeId}
Customer Allocation Details Create the customer Allocations based on the customer Id createCustomerAllocation V1.0.0 /holdings/portfolios/customers/{customerId}/allocations
Get the customer Allocations based on the customer Id getCustomerAllocation V1.0.0 /holdings/portfolios/customers/{customerId}/allocations
assetId, subAssetId as a query param
Update the customer Allocations based on the customer Id updateCustomerAllocation V1.0.0 /holdings/portfolios/customers/{customerId}/allocations
Portfolio Allocation Details Create the portfolio Allocations based on the portfolio Id createPortfolioAllocation V1.0.0 /holdings/portfolios/portfolios/{portfolioId}/allocations
Get the portfolio Allocations based on the portfolio Id getPortfolioAllocation V1.0.0 /holdings/portfolios/portfolios/{portfolioId}/allocations
assetId, subAssetId as a query param
Update the portfolio Allocations based on the portfolio Id updatePortfolioAllocation V1.0.0 /holdings/portfolios/portfolios/{portfolioId}/allocations
Instrument Details Create the instruments based on the instrument Id createInstruments V1.0.0 /reference/references/holdings/instruments/{instrumentId}/instrumentDetails
Get the instruments based on the instrument Id getInstruments V1.0.0 /reference/references/holdings/instruments/{instrumentId}/instrumentDetails
Update the instruments based on the instrument Id updateInstruments V1.0.0 /reference/references/holdings/instruments/{instrumentId}/instrumentDetails
  Create the portfolio position details based on the portfolio Id createPositionDetails V1.0.0 /holdings/portfolios/{portfolioId}/positions
Portfolio Position Details Get the portfolio position details based on the portfolio Id getPositionDetails V1.0.0 /holdings/portfolios/{portfolioId}/positions
  depositoryId, instrumentId as a query param
  Update the portfolio position details based on the portfolio Id updatePositionDetails V1.0.0 /holdings/portfolios/{portfolioId}/positions
Balance and Activites Return the balance details for a product bundle. contractBalances V1.0.0 /holdings/arrangements/balances
Return the activity details for a product bundle getActivities V1.0.0 /holdings/arrangements/activities
Return the balance details for a product bundle. getBalances V1.0.0 /holdings/arrangements/contracts/balances
  Create an activity in the micro service database createActivities V1.0.0 /products/accounts/activities
  Create the balance information createBalances V1.0.0 /products/accounts/balances
Event Aggregator Details Create an aggregation details for an event createDetailsforEventAggregator V1.0.0 /enterprise/arrangements/aggregatorDetails
Fetch an aggregation details for an event getDetailsforEventAggregator V1.0.0 /enterprise/arrangements/aggregatorDetails/{aggregatorId}
Updates an existing aggregation details for an event updateDetailsforEventAggregator V1.0.0 /enterprise/arrangements/aggregatorDetails/{aggregatorId}
Delete an aggregation details for an event in the micro service database which creation date is less than today deleteEventAggregatorByDate V1.0.0 /enterprise/arrangements/aggregatorDetails/{aggregatorId}
External LOC Create arrangement createAccountDetails V1.0.0 /holdings/accounts/{accountId}/accountDetails
  Update arrangement updateAccountDetails V1.0.0 /holdings/accounts/{accountId}/accountDetails
  Get Account details getAccountDetails V1.0.0 /holdings/accounts/{accountId}/accountDetails
  Update the balance types for an account updateBalanceTypesForAccounts V1.0.0 /holdings/accounts/{accountId}/balances/balanceUpdates
Company Get the list of companies available getListOfCompany V1.0.0 /reference/companies
Create a new company createCompany V1.0.0 /reference/companies/{companyId}
Update company details updateCompany V1.0.0 /reference/companies/{companyId}

To view the complete APIs specification, refer to the Service Spec (Swagger).

Following are the list of Business APIs supported:

Tags Scenario Operation Name  API Version URI
Balances List Balances for given Account ID getBalancesForAccountV2 V2.0.0 /holdings/accounts/{accountId}/balances
List Balances for entitled accountIds getAccountsBalancesV2 V2.0.0 /holdings/accounts/balances
Transactions List Transactions for given Account ID getTransactionsForAccountV2 V2.0.0 /holdings/accounts/{accountId}/transactions
List Transactions for entitled Account IDs getTransactionsForEntitledAccountsV2 V2.0.0 /holdings/accounts/transactions
Arrangement Details Get the Party Details for the Party ID getPartyDetailsV2 V2.0.0 /holdings/parties/{partyId}
Get the Party Roles for the Arrangement ID getPartyRoleForArrangementV2 V2.0.0 /holdings/arrangement/{arrangementId}/roles
Get the Payment Schedules for the Arrangement ID getScheduleForArrangementV2 V2.0.0 /holdings/arrangement/{arrangementId}/schedules
Get the Payment Schedules status for the Arrangement ID getScheduleStatusForArrangementV2 V2.0.0 /holdings/arrangement/{arrangementId}/scheduleStatus
Get all the Arrangement Details of the Party ID getPartyArrangementDetailsV2 V2.0.0 /holdings/parties/{partyId}/bulkArrangements
Get ArrangementDetails for the list of Arrangement ID / IBAN getBulkArrangementsV2 V2.0.0 /holdings/bulkArrangements/{arrangementId}

To view the complete APIs specification, refer to the Service Spec (Swagger).

Following are the list of Business APIs supported:

Tags Scenario Operation Name  API Version URI
Balances List Balances for given Account ID.  This API fetches the latest balance for the given criteria/query param. Future Dated transactions will be excluded based on Period End Date in Bank Dates application. The latest Balance is calculated based on the Reverse sorted Opening Date from Balance Entity which should be before or equal to Period End Date from Bank Dates Entity. When opening date is mentioned in query param, the balance details will be fetched for that particular opening date if the opening date is before or equal to Period End Date from Bank Dates Entity. getBalancesForAccountV3 V3.0.0 /holdings/accounts/{accountId}/balances
List Balances for entitled Account IDs getAccountsBalancesV3 V3.0.0 /holdings/accounts/balances
Create Balances for given Account ID createBalancesForAccountV3 V3.0.0 /holdings/accounts/balances
Update Balances for given Account ID updateBalancesForAccountV3 V3.0.0 /holdings/accounts/balances
Transactions List Transactions for given Account ID getTransactionsForAccountV3 V3.0.0 /holdings/accounts/{accountId}/transactions
List Transactions for entitled Account IDs getTransactionsForEntitledAccountsV3 V3.0.0 /holdings/accounts/transactions
Create Transactions for given Account ID  createTransactionsForAccountV3 V3.0.0 /holdings/accounts/transactions
Arrangement Details Create the Arrangement and its related data createArrangementInfoV3 V3.0.0 /holdings/arrangements/
Update the existing Arrangement and its related data updateArrangementInfoV3 V3.0.0 /holdings/arrangements/
Get the bill details for an existing arrangement getBillDetailsV3 V3.0.0 /holdings/arrangements/{arrangementId}/bills
Get all the Arrangement Details of the Party ID getPartyArrangementDetailsV3 V3.0.0 /holdings/parties/{partyId}/bulkArrangements
Get ArrangementDetails for the list of arrangementid/IBAN getBulkArrangementsV3 V3.0.0 /holdings/bulkArrangements/{arrangementId}
Customer Values List customerValues for given Customer ID getCustomerValuesV3 V3.0.0 /holdings/portfolios/customers/{customerId}/customerValues
Create Customer Values createCustomerValuesV3 V3.0.0 /holdings/portfolios/customers/customerValues
Update Customer Values updateCustomerValuesV3 V3.0.0 /holdings/portfolios/customers/customerValues
Portfolio Values List portfolioValues for given Portfolio ID getPortfolioValuesV3 V3.0.0 /holdings/portfolios/{portfolioId}/portfolioValues
Create Portfolio Values  createPortfolioValuesV3 V3.0.0 /holdings/portfolios/portfolioValues
Update Portfolio Values updatePortfolioValuesV3 V3.0.0 /holdings/portfolios/portfolioValues
Socket API List Transactions getTransactionList V3.0.0 /holdings/transactions
List Transactions for the given ID getTransactionDetails V3.0.0 /holdings/transactions/{accountId}
List Accounts. This API fetches the Account details with latest balance for the given criteria. Future Dated transactions will be excluded based on Period End Date in Bank Dates application. The latest Balance is calculated based on the Reverse sorted Opening Date from Balance Entity which should be before or equal to Period End Date from Bank Dates Entity.  getAccountList V3.0.0 /holdings/accounts

To view the complete APIs specification, refer to the Service Spec (Swagger).

Following are the list of Business APIs supported:

Tags Scenario Operation Name  API Version URI
Arrangement Details Create the  Arrangement and its related data createArrangementInfoV4 V4.0.0 /holdings/arrangements/
Update the existing Arrangement and its related data updateArrangementInfoV4 V4.0.0 /holdings/arrangements/
Get all the Arrangement Details of the Party ID getPartyArrangementDetailsV4 V4.0.0 /holdings/parties/{partyId}/bulkArrangements
Get ArrangementDetails for the list of arrangementid/IBAN getBulkArrangementsV4 V4.0.0 /holdings/bulkArrangements/{arrangementId}
Party Role Details  Get all the party roles getPartyRoles V4.0.0 /reference/partyRoles

To view the complete APIs specification, refer to the Service Spec (Swagger).

Following are the list of Business APIs supported:

Tags Scenario Operation Name  API Version URI
Arrangement Details Get all the Arrangement Details of the Party ID getPartyArrangementDetailsV5 V5.0.0 /holdings/parties/{partyId}/bulkArrangements
Get ArrangementDetails for the list of arrangementid/IBAN getBulkArrangementsV5 V5.0.0 /holdings/bulkArrangements/{arrangementId}
Get the Bulk Arrangement details for a Party ID passed getBulkArrangementForParty V5.0.0 /holdings/parties/{partyId}/arrangements/bulkArrangements
Get the Payment Details for the account by passing alternate Reference ID getAccountPaymentDetails V5.0.0 /holdings/accounts/{accountId}/accountPaymentDetails
Create the Arrangement and its related data createArrangementInfoV5 V5.0.0 /holdings/arrangements/
Update the existing Arrangement and its related data updateArrangementInfoV5 V5.0.0 /holdings/arrangements/
Posting Restriction Get all the Posting Restrictions Details for the Account getAccountPostingRestrictions V5.0.0 /holdings/arrangements/{accountId}/postingRestrictions
Account Services Get the Account Services Details by passing external arrangementId or alternate reference id getAccountServiceDetails V5.0.0 /holdings/accounts/arrangements/{arrangementId}/accountServices

To view the complete APIs specification, refer to the Service Spec (Swagger).

Following are the list of Business APIs supported: 

Tags Scenario Operation Name  API Version URI
Arrangement Details Get all the Arrangement Details of the Party ID getPartyArrangementDetailsV5_1_0 V5.1.0 /holdings/parties/{partyId}/bulkArrangements
Get ArrangementDetails for the list of Arrangement ID/IBAN getBulkArrangementsV5_1_0 V5.1.0 /holdings/bulkArrangements/{arrangementId}

To view the complete APIs specification, refer to the Service Spec (Swagger).

Following are the list of Business APIs supported: 

Tags Scenario Operation Name  API Version URI
Arrangement Details Get all the Arrangement Details of the partyId getPartyArrangementDetailsV5_2_0 V5.2.0 /holdings/parties/{partyId}/bulkArrangements

To view the complete APIs specification, refer to the Service Spec (Swagger).

In this topic

Copyright © 2020- Temenos Headquarters SA

Contact Us

knowledge@temenos.com

Published on :
Tuesday, September 2, 2025 1:05:10 PM IST