Enterprise APIs

The following are the list of Business APIs supported for Savings Pot Microservice.

API

Description
createSavingsPot This API is used to create a savings pot for   an existing customer.
getSavingPots This API is used to fetch the details of   savings pot. This details can be fetched with or without criteria.
reallocateSavingsPot This API is used to update the details of   existing savings pot.
closeSavingsPot This API is used to update the status of   savings pot to “CLOSED”.
updateSavingsPotBalances This API is used to update the balance of   the specified savings pot when funding/withdrawal.

 

To view the Swagger spec of Savings Pot microservice APIs, click here.

createSavingsPot
The createSavingsPot API creates a new savings pot record.

POST/holdings/savingPots

Sample Request
{
  "savingsPot": {
    "partyId": "100100",
    "portfolioId": "100100-1",
    "productId": "SAVINGS.ACCOUNT",
    "currency": "USD",
    "fundingAccountId": "123456",
    "fundingAccountHoldingsId": "GB0010001-123456",
    "potAccountId": "MEMO XXX",
    "potType": "Goal",
    "potName": "Tesla Car",
    "savingsType": "Vehicle",
    "targetAmount": 300000,
    "periodicContribution": 1000,
    "targetPeriod": 30,
    "frequency": "Monthly",
    "startDate": "2020-08-12",
    "endDate": "2024-04-12"
  }
}
Sample Response
{
  "savingsPotId": "SP001",
  "status": "Success",
  "message": "Operation completed successfully"
}
reallocateSavingsPot
The reallocateSavingsPot API updates the savings pot.

PUT/holdings/savingPots/{savingsPotId}

Sample Request
{
  "savingsPot": {
    "potName": "Tesla Car",
    "targetAmount": 300000,
    "periodicContribution": 1000,
    "targetPeriod": 30,
    "frequency": "Monthly",
    "startDate": "2020-08-12",
    "endDate": "2024-04-12"
  }
}
Sample Response
{
  "savingsPotId": "SP001",
  "status": "Success",
  "message": "Operation completed successfully"
}
closeSavingPots
The closeSavingPots API closes a savings pot.

PUT/holdings/savingPots/{savingsPotId}/closeSavingPots

Sample Response
{
  "savingsPotId": "SP001",
  "status": "Success",
  "message": "Operation completed successfully"
}
updateSavingsPotBalances
The updateSavingsPotBalances API updates updates the balance of the specified savings pot when funding/withdrawal is initiated for the pot.

PUT/holdings/savingPots/{savingsPotId}/balances

Sample Request
{
  "savingsPot": {
    "amount": 10000,
    "isCreditDebit": "Credit"
  }
}
Sample Response
{
  "savingsPotId": "SP001",
  "status": "Success",
  "message": "Operation completed successfully"
}
getSavingPots
The getSavingPots API retrieves details of the savings pot.

GET/holdings/savingPots

Sample Response
{
  "savingsPot": [
    {
      "savingsPotId": "SP001",
      "partyId": "100100",
      "portfolioId": "100100-1",
      "productId": "SAVINGS.ACCOUNT",
      "currency": "USD",
      "fundingAccountId": "123456",
      "fundingAccountHoldingsId": "GB0010001-123456",
      "potAccountId": "MEMO XXX",
      "potType": "Goal",
      "potName": "Tesla car",
      "savingsType": "Vehicle",
      "targetAmount": 300000,
      "periodicContribution": 1000,
      "targetPeriod": 30,
      "frequency": "Monthly",
      "creationDate": "2019-08-12",
      "startDate": "2020-08-12",
      "endDate": "2024-04-12",
      "availableBalance": 200000,
      "amountWithdrawn": 10000,
      "status": "ACTIVE",
      "lastModifiedDate": "2024-04-12 08:23:45"
    }
  ]
}

Bookmark Name Actions
BACK

In this topic

Feedback
x

Are you sure you want to log-off?