Create deposit product

Use case

Here we will review how to create a deposit product with the minimum set of data:

Use case data	API parameters with values
The description of the deposit product.	"description": "Premium deposit"
The deposit group code. Currently, the TIME_DEPOSIT is the only available value.	"depositGroupCode": "TIME_DEPOSIT"
A unique code for product identification. It must be a unique value and can contain uppercase letters, numbers, and the special characters “-” (dash), “_” (underscore), and “.” (full-stop). Spaces are not allowed.	"depositTypeCode": "PREMIUM"
The code of the tenant where the deposit product is going to be opened.	"tenantCode": "MB"
The deposit product country is Estonia and the currency is euro.	"countryCode": "EE", "currencyCode": "EUR"
A contract number prefix. It must be a unique value and can contain uppercase letters, numbers, and the special characters “-” (dash), “_” (underscore), “/” (slash), and “.” (full-stop). Spaces are not allowed.	"contractNumberPrefix": "PR-EE-"
The deposit offer opened based on this product will be valid for 1 day. The number of days that the system will wait for the contracts of this product type to receive the deposit balance amount from the servicing account. If the expected deposit amount is not received within 2 days, the system cancels the deposit product.	"offerValidDays": 1, "daysToWaitCredit": 2
The premature contract termination is without interest. The automatic prolongation of the deposit contract is allowed.	"terminationType": "WITHOUT_INTEREST", "autoProlongationAllowed": true
Deposit product interest settings: Interest calculation method 30/360 - considers that each month has 30 days and there are 360 days in a year. Interest conditions are applied for a fixed period of time. The amount that the customer can deposit is a range from 5000 to 10000 EUR. Note: The endValue is an exclusive parameter. The default deposit interest rate is 0.25. The minimum interest rate is 0.21 and the maximum is 0.75. The deposit period is 3 months. The deposit interest is paid out at the end of the deposit period.	"interestCalculationMethod": { "daysInMonth": "30", "daysInYear": 360 }, "interestPeriodSelector": "FIXED", "interests": [ { "amountRange": { "startValue": 5000, "endValue": 10001 }, "interestRate": 0.25, "minInterestRate": 0.21, "maxInterestRate": 0.75, "period": 3, "periodTypeCode": "MONTH", "paymentFrequencyTypeCode": "END", "validityRange": { "startDate": "2027-01-09", } } ],
The deposit class code that was created as a first step.	"depositClassCode": "PREMIUM_CUSTOMER"
This deposit product holder is a private person.	"personTypeCode": "P"

Sample API call

To create a deposit product, make the following API call.

deposit-api.sandbox.tuumplatform.com/api/v2/deposits/product

See more information about the create deposit product endpoint in the Tuum developer portal.

Sample request

Below is an example request body of the API call for creating a deposit product.

JSON

{
  "description": "Premium deposit",
  "depositGroupCode": "TIME_DEPOSIT",
  "depositTypeCode": "PREMIUM",
  "tenantCode": "MB",
  "countryCode": "EE",
  "currencyCode": "EUR",
  "contractNumberPrefix": "PR-EE-",
  "offerValidDays": 1,
  "daysToWaitCredit": 2,
  "terminationType": "WITHOUT_INTEREST",
  "autoProlongationAllowed": true,
  "interestCalculationMethod": 
{ 
    "daysInMonth": "30", 
    "daysInYear": 360
  },
  "interestPeriodSelector": "FIXED",
  "interests": [
    {
      "amountRange": { 
        "startValue": 5000,
        "endValue": 100001
      },
      "interestRate": 0.25,
      "minInterestRate": 0.21,
      "maxInterestRate": 0.75,
      "period": 3,
      "periodTypeCode": "MONTH",
      "paymentFrequencyTypeCode": "END",
      "validityRange": {
        "startDate": "2027-01-09"
      }
    }
  ],
  "depositClassCode": "PREMIUM_CUSTOMER",
  "personTypeCode": "P"
}

cURL

curl --location 'https://deposit-api.sandbox.tuumplatform.com/api/v2/deposits/product' \
--header 'x-channel-code: SYSTEM' \
--header 'x-auth-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHBpcnlEVGltZSI6IjIwMjQtMDItMjJUMTk6MTc6MDAiLCJyb2xlcyI6WyJBRE1JTiJdLCJuYW1lIjoiSm9obiBPZmZpY2VyIiwiZW1wbG95ZWVJZCI6IjEiLCJ0ZW5hbnRDb2RlIjoiTUIuRVUiLCJleHAiOjE3MDg2Mjk0MjB9.Np7yiNhKpkY35dIPSBD8h1qMoe9zz4IRbsHYZnnoBlo' \
--data '{
  "description": "Premium deposit", 
  "depositGroupCode": "TIME_DEPOSIT", 
  "depositTypeCode": "PREMIUM", 
  "tenantCode": "MB", 
  "countryCode": "EE", 
  "currencyCode": "EUR", 
  "contractNumberPrefix": "PR-EE-", 
  "offerValidDays": 1, 
  "daysToWaitCredit": 2,  
  "terminationType": "WITHOUT_INTEREST",
  "autoProlongationAllowed": true, 
  "interestCalculationMethod": { 
    "daysInMonth": "30", 
    "daysInYear": 360
  },
  "interestPeriodSelector": "FIXED", 
  "interests": [
    {
      "amountRange": { 
        "startValue": 5000, 
        "endValue": 100001 
      },
      "interestRate": 0.25,
      "minInterestRate": 0.21,
      "maxInterestRate": 0.75,
      "periodRange": { 
        "startValue": 0,
        "endValue": 0
      },
      "period": 3, 
      "periodTypeCode": "MONTH", 
      "paymentFrequencyTypeCode": "END", 
      "validityRange": {
        "startDate": "2027-01-09", 
        "endDate": null 
      }
    }
  ],
  "depositClassCode": "PREMIUM_CUSTOMER",
  "personTypeCode": "P"
}'

Sample response

Below you find an example response body to the API call above.

Response

{
    "errors": null,
    "validationErrors": null,
    "data": null
}

Result

As an outcome, a new deposit product was created in a DRAFT status.