Savings Pot

Savings Pot microservice provides an independent cloud-enabled solution for managing savings pot information required for both the front office (Infinity) and back office (could be T24 or any other back-office system of the bank). The distribution service of Savings Pot MS is fully containerized and can be deployed independently irrespective of any back-office system of the bank.

The following Experience APIs are associated with the Savings Pot microservice.

Name Description Introduced In
createSavingsPot This API allows the user to create a new savings pot for the user based on the Funding Account ID. 2020.10
closeSavingsPot This API allows the user to close a Savings Pot based on the Savings Pot ID. 2020.10
getAllSavingsPot This API allows the user to fetch all the Savings Pots for the user based on the Funding Account ID. 2020.10
updateSavingsPot This API allows the user to update the Savings Pot based on the Savings Pot ID and the other parameters passed in the request. 2020.10
updateSavingsPotBalance This API allows the user to update the amount in the Savings Pot. The amount can be debited or credited from the Savings Pot. 2020.10
getCategoriesForGoal This API allows the user to fetch the list of categories available for the goals. 2020.10
ClosedcreateSavingsPot
 
Description: This API allows the user to create a new savings pot for the user based on the Funding Account ID.
Method: POST
URL: SavingsPot/operations/SavingsPot/createSavingsPot
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request:
ClosedRequest for Budget

Parameters

fundingAccountId

Specifies the unique ID of the Funding account.

productId

Specifies the unique ID of the product.

potType (Mandatory)

Specifies the type of pot (Goal/Budget).

potName

Specifies the name of the pot.

targetAmount

Specifies the target amount.

currency

Specifies the currency code.

{
        "fundingAccountId": "",
        "productId": "SAVINGS.ACCOUNT",
        "potType": "Budget",
        "potName": "ABCD",
        "targetAmount": "2000",
        "currency": "USD"
}
ClosedRequest for Goals

Parameters

fundingAccountId

Specifies the unique ID of the Funding account.

productId

Specifies the unique ID of the product.

potType (Mandatory)

Specifies the type of pot (Goal/Budget).

potName

Specifies the name of the pot.

startDate

Specifies the start date for the contribution

endDate

Specifies the end date for contribution.

savingsType

Specifies the type of savings.

frequency

Specifies the frequency at which the payment transfers must be made. The transfers can be made daily, weekly, or monthly.

targetAmount

Specifies the target amount.

targetPeriod

Specifies the period for reaching the target amount.

periodicContribution

Specifies the contribution that has to be paid based on the frequency.

currency

Specifies the currency code.

{
        "fundingAccountId": "",
        "productId": "SAVINGS.ACCOUNT",
        "potType": "Goal",
        "potName": "ABCD",
        "startDate": "mm/dd/yyyy",
        "endDate": "mm/dd/yyyy",
        "savingsType": "Vehicle",
        "frequency": "Monthly",
        "targetAmount": "2000",
        "targetPeriod": "24 M",
        "periodicContribution": "200",
        "currency": "USD"
}
Response:

Parameters

Successful

Specifies the success JSON response.

Successful/savingsPotId

Specifies the unique ID of the Savings Pot.

Successful/status

Specifies the status of the operation.

Successful/message

Specifies the message based on the status.

 

 Successful: {
        savingsPotId: "SP001",
        status: "Success",
        message: "Operation completed Successfully’,
        opstatus: 0,
        httpstatuscode: 200
    }

Error Response

Failure {
    Success: "Failed",
    dbpErrorCode: 2100
    dbpErrorMessage: "Failed to create Goal",
    opstatus: 0,
    httpstatuscode: 200
}
Error Code(s):
  • Error Code: 20040
    Error Message: Internal service error
  • Error Code: 20041
    Error Message: Failed to fetch data from MS
  • Error Code: 20043
    Error Message: User doesn't have the access to the mentioned Account ID
ClosedcloseSavingsPot
 
Description: This API allows the user to close a Savings Pot based on the Savings Pot ID.
Method: POST
URL: SavingsPot/operations/SavingsPot/closeSavingsPot
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request:

Parameters

savingsPotId

Specifies the unique ID of the Savings Pot.

potAccountId

Specifies the unique ID of the Pot Account.

{
  "savingsPotId": "SP001",
  "potAccountId": "MEMO XXX"
}
Response:

Parameters

Successful

Specifies the success JSON response.

Successful/savingsPotId

Specifies the unique ID of the Savings Pot.

Successful/status

Specifies the status of the operation.

Successful/message

Specifies the message based on the status.

 

Successful: {
        status: "Success",
        message: "Operation completed Successfully’,
        opstatus: 0,
        httpstatuscode: 200
    }

Error Response

Failure {
    Success: "Failed",
    dbpErrorCode: 2100
    dbpErrorMessage: "Failed to create Goal",
    opstatus: 0,
    httpstatuscode: 200
}
Error Code(s):
  • Error Code: 20040
    Error Message: Internal service error
  • Error Code: 20041
    Error Message: Error from Microservice
  • Error Code: 20044
    Error Message: User doesn't have the access to the mentioned Savings Pot ID
  • Error Code: 20047
    Error Message: Savings Pot that the user is trying to access is already closed
ClosedgetAllSavingsPot
 
Description: This API allows the user to fetch all the Savings Pots for the user based on the Funding Account ID.
Method: POST
URL: SavingsPot/operations/SavingsPot/getAllSavingsPot
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request:

Parameters

fundingAccountId

Specifies the unique ID of the Funding account.

{
  "fundingAccountId": "1234"
}
Response:

Parameters

savingsPot

Specifies the success JSON response.

savingsPot/savingsPotId

Specifies the unique ID of the Savings Pot.

savingsPot/partyId

Specifies the unique ID of the Party.

savingsPot/portfolioId

Specifies the unique ID of the portfolio.

savingsPot/productId

Specifies the unique ID of the product.

savingsPot/currency

Specifies the currency code.

savingsPot/fundingAccountHoldingsId

Specifies the unique ID of the Funding Holdings account.

savingsPot/potType

Specifies the type of pot (Budget/Goal)

savingsPot/potName

Specifies the name of the Savings pot.

savingsPot/targetAmount

Specifies the target amount.

savingsPot/creationDate

Specifies the date of creation for the Savings Pot.

savingsPot/availableBalance

Specifies the available balance in the Savings Pot

savingsPot/amountWithdrawn

Specifies the amount withdrawn from the Savings Pot.

savingsPot/lastModifiedDate

Specifies the last modified date for the Savings Pot.

savingsPot/potCurrentStatus

Specifies the status for the Savings Pot

savingsPot/potAmountPercentage

Specifies the pot amount percentage.

savingsPot/monthsLeftForCompletion

Specifies the number of months left for the completion.

savingsPot/remainingSavings

Specifies the savings in the Savings Pot.

savingsPot/frequencyDay

Specifies the frequency (Monthly/Biweekly)

NOTE: If the Pot Type is set to Budget, then remainingSavings, frequencyDay, and monthsLeftForCompletion parameters will not be present in the response.


 {
  " savingsPot": [{
        "savingsPotId": "SP001",
        "partyId": "100100",
        "portfolioId": "100100-1",
        "productId": "SAVINGS.ACCOUNT",
        "currency": "USD",
        "fundingAccountHoldingsId": "123456",
        "potAccountId": "MEMO XXX",
        "potType": "Budget",
        "potName": "Tesla car",
        "targetAmount": 300000,
        "creationDate": "2019-08-12",
        "availableBalance": 200000,
        "amountWithdrawn": 10000,
        "lastModifiedDate": "2024-04-12 08:23:45",
        "potCurrentStatus": "partially funded"/Completed - Budget   "not on track", "on Track", Completed - Goal
        "potAmountPercentage": "",
		"monthsLeftForCompletion": "",
		"remainingSavings":"
		"frequencyDay": "",
    },{},{}...]
}

Error Response

Failure {
    Success: "Failed",
    dbpErrorCode: 2100
    dbpErrorMessage: "Failed to create Goal",
    opstatus: 0,
    httpstatuscode: 200
}
Error Code(s):
  • Error Code: 20040
    Error Message: Internal service error
  • Error Code: 20041
    Error Message: Error from Microservice
  • Error Code: 20042
    Error Message: No records found
  • Error Code: 20043
    Error Message: User doesn't have the access to the mentioned Account ID
ClosedupdateSavingsPot
 
Description: This API allows the user to update the Savings Pot based on the Savings Pot ID and the other parameters passed in the request.
Method: POST
URL: SavingsPot/operations/SavingsPot/updateSavingsPot
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request:
ClosedRequest for Budget

Parameters

savingsPotId (Mandatory)

Specifies the unique ID of the Savings Pot.

potAccountId (Mandatory)

Specifies the unique ID of the Pot account.

potName

Specifies the name of the pot.

targetAmount

Specifies the target amount.

{
    "savingsPotId": "SP001",
    "potAccountId": "MEMO XXX",
    "potName": "ABCD",
    "targetAmount": "2000",
}
ClosedRequest for Goals

Parameters

savingsPotId (Mandatory)

Specifies the unique ID of the Savings Pot.

potAccountId (Mandatory)

Specifies the unique ID of the Pot account.

potName

Specifies the name of the pot.

startDate

Specifies the start date for the contribution

endDate

Specifies the end date for contribution.

frequency

Specifies the frequency at which the payment transfers must be made. The transfers can be made daily, weekly, or monthly.

targetAmount

Specifies the target amount.

targetPeriod

Specifies the period for reaching the target amount.

currency

Specifies the currency code.

{
        "savingsPotId": "SP001",
	 "potAccountId": "MEMO XXX",
        "potName": "ABCD",
        "startDate": "mm/dd/yyyy",
	 "endDate" : "mm/dd/yyyy",
        "frequency": "Monthly",
        "targetAmount": "2000",
        "targetPeriod": "24 M",
        "periodicContribution": ""
}
Response:

Parameters

Successfull

Specifies the success JSON response.

Successfull/savingsPotId

Specifies the unique ID of the Savings Pot.

Successfull/status

Specifies the status of the operation.

Successfull/message

Specifies the message based on the status.

 

 Successful: {
        status: "Success",
        message: "Operation completed Successfully’,
        opstatus: 0,
        httpstatuscode: 200
    }

Error Response

Failure {
    Success: "Failed",
    dbpErrorCode: 2100
    dbpErrorMessage: "Failed to create Goal",
    opstatus: 0,
    httpstatuscode: 200
}
Error Code(s):
  • Error Code: 20040
    Error Message: Internal service error
  • Error Code: 20041
    Error Message: Error from Microservice
  • Error Code: 20044
    Error Message: User doesn't have the access to the mentioned Savings Pot ID
  • Error Code: 20047
    Error Message: Savings Pot that the user is trying to access is already closed
ClosedupdateSavingsPotBalance
 
Description: This API allows the user to update the amount in the Savings Pot. The amount can be debited or credited from the Savings Pot.
Method: POST
URL: SavingsPot/operations/SavingsPot/updateSavingsPotBalance
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request:

Parameters

savingsPotId (Mandatory)

Specifies the unique ID of the Savings Pot.

potAccountId (Mandatory)

Specifies the unique ID of the Pot account.

amount (Mandatory)

Specifies the name of the pot.

isCreditDebit (Mandatory)

Specifies whether the amount is to be credited or debited (Credit/Debit).

{
    "savingsPotId": "SP001",
    "potAccountId": "MEMO XXX",
    "amount": 10000,
    "isCreditDebit": "Credit"
}
Response:

Parameters

Successfull

Specifies the success JSON response.

Successful/savingsPotId

Specifies the unique ID of the Savings Pot.

Successful/status

Specifies the status of the operation.

Successful/message

Specifies the message based on the status.

 

 Successful: {
        status: "Success",
        message: "Operation completed Successfully’,
        opstatus: 0,
        httpstatuscode: 200
    }

Error Response

Failure {
    Success: "Failed",
    dbpErrorCode: 2100
    dbpErrorMessage: "Failed to create Goal",
    opstatus: 0,
    httpstatuscode: 200
}
Error Code(s):
  • Error Code: 20040
    Error Message: Internal service error
  • Error Code: 20041
    Error Message: Error from Microservice
  • Error Code: 20043
    Error Message: User doesn't have the access to the mentioned Account ID
  • Error Code: 20044
    Error Message: User doesn't have the access to the mentioned Savings Pot ID
  • Error Code: 20045
    Error Message: Funding Account does not have sufficient balance to fund the Savings Pot with
  • Error Code: 20046
    Error Message: Savings Pot does not have sufficient balance to withdraw
  • Error Code: 20047
    Error Message: Savings Pot that the user is trying to access is already closed
ClosedgetCategoriesForGoal
 
Description: This API allows the user to fetch the list of categories available for the goals.
Method: POST
URL: SavingsPot/operations/SavingsPot/updateSavingsPotBalance
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request:

None
Response:

Parameters

category

Specifies an array of JSON Objects of categories.

category/name

Specifies the name of the category.

category/description

Specifies the description of the category.

{
"category": 
   [{
      "name": "2020-08-28 07:56:01.0",
      "description": "RCID_ACCOUNTOWNERSHIP"
      },{},{}]
 "opstatus": 0,
"httpStatusCode": 0
}
Error Code(s):
  • Error Code: 20040
    Error Message: Internal service error
  • Error Code: 20042
    Error Message: No records found

Bookmark Name Actions
BACK

In this topic

Feedback
x

Are you sure you want to log-off?