1 of 7

Deposit product management

Instructions in this section will help you to manage deposit products throughout their lifecycle.

Below you will find the following chapters:

Create deposit class code

Use case

Here we will review how to create deposit class codes that can be used to define separate general ledger accounts for different deposit products. We will create a new deposit class code for the premium customers.

Use case data

API parameters with values

The new class code is created for the premium customers group.

Sample API call

To create a new deposit class code, make the following API call.

Sample request

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

{
  "description": "Class code for premium customers",
  "depositClassCode": "PREMIUM_CUSTOMER"
}

curl --location 'https://deposit-api.sandbox.tuumplatform.com/api/v1/deposit-class-codes' \
--header 'x-channel-code: SYSTEM' \
--header 'x-auth-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHBpcnlEVGltZSI6IjIwMjQtMDItMjJUMTc6MDE6MTciLCJyb2xlcyI6WyJBRE1JTiJdLCJuYW1lIjoiSm9obiBPZmZpY2VyIiwiZW1wbG95ZWVJZCI6IjEiLCJ0ZW5hbnRDb2RlIjoiTUIuRVUiLCJleHAiOjE3MDg2MjEyNzd9.XD_GcGtj3ArKvsM2OxUKKhBNmhQ-TA5RcjmKxTR2fkA' \
--header 'Content-Type: application/json' \
--data '{
  "description": "Class code for premium customers",
  "depositClassCode": "PREMIUM_CUSTOMER"
}'

Sample response

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

Response

{
    "errors": null,
    "validationErrors": null,
    "data": {
        "description": "Class code for premium customers",
        "depositClassCode": "PREMIUM_CUSTOMER"
    }
}

Result

As an outcome, a new deposit class code for premium customers was created.

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.

The deposit group code. Currently, the TIME_DEPOSIT is the only available value.

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.

The code of the tenant where the deposit product is going to be opened.

The deposit product country is Estonia and the currency is euro.

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.

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.

The premature contract termination is without interest.
The automatic prolongation of the deposit contract is allowed.

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.

This deposit product holder is a private person.

Sample API call

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

Sample request

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

{
  "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 --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.

Update deposit product

Use case

Note that you can completely modify the deposit product configuration when the deposit product is in the DRAFT status. Once the product is in the ACTIVE status, you can only update the interest conditions. When the product is in the INACTIVE status, you cannot modify any product fields.

In the table below, you will find a list of the settings that have been modified for the deposit product:

Use case data

API parameters with values

The product description is updated.

The deposit country is set to Germany.

The contract number prefix is modified.

The premature deposit contract termination is with interest.

The deposit contract period is 12 months.

The deposit is offered for legal entities.

The deposit product end is updated. Note: the date format is YYYY-MM-DD.

Sample API call

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

Sample request

Below is an example request body for the API call to update a deposit product.

{
  "description": "Premium deposit Germany"
  "depositGroupCode": "TIME_DEPOSIT"
  "countryCode": "DE"
  "currencyCode": "EUR"
  "contractNumberPrefix": "PR-DE-"
  "offerValidDays": 1
  "daysToWaitCredit": 2
  "calculateTaxesEnabled": false,
  "terminationType": "WITH_TOTAL_INTEREST"
  "interestCalculationMethod": {
    "daysInMonth": "30", 
    "daysInYear": 360
  },
  "interestPeriodSelector": "FIXED",
  "interests": [
    {
      "amountRange": { 
        "startValue": 6000,
        "endValue": 100001
      },
      "interestRate": 0.25,
      "periodRange": { 
        "startValue": 0,
        "endValue": 0
      },
      "period": 12, 
      "periodTypeCode": "MONTH",
      "paymentFrequencyTypeCode": "END",
      "validityRange": {
        "startDate": "2027-02-08", 
        "endDate": "2031-02-08"
      }
    }
  ],
  "personTypeCode": "L"
}

curl --location --request PUT 'https://deposit-api.sandbox.tuumplatform.com/api/v2/deposits/product/PREMIUM' \
--header 'x-channel-code: SYSTEM' \
--header 'x-auth-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHBpcnlEVGltZSI6IjIwMjQtMDUtMDNUMjA6NDQ6MDMiLCJyb2xlcyI6WyJBRE1JTiJdLCJuYW1lIjoiSm9obiBPZmZpY2VyIiwiZW1wbG95ZWVJZCI6IjEiLCJ0ZW5hbnRDb2RlIjoiTUIiLCJleHAiOjE3MTQ3NjkwNDN9.rdBXcIkNYRWcVC_iNUuYaVnaEIuN3my3L3d2hNlwSK8' \
--header 'Content-Type: application/json' \
--data '{
  "description": "Premium deposit Germany", 
  "depositGroupCode": "TIME_DEPOSIT", 
  "countryCode": "DE", 
  "currencyCode": "EUR", 
  "contractNumberPrefix": "PR-DE-", 
  "offerValidDays": 1, 
  "daysToWaitCredit": 2, 
  "calculateTaxesEnabled": false, 
  "terminationType": "WITH_TOTAL_INTEREST", 
  "interestCalculationMethod": { 
    "daysInMonth": "30", 
    "daysInYear": 360
  },
  "interestPeriodSelector": "FIXED", 
  "interests": [
    {
      "amountRange": { 
        "startValue": 6000, 
        "endValue": 100001 
      },
      "interestRate": 0.25,  
      "periodRange": { 
        "startValue": 0,
        "endValue": 0
      },
      "period": 12, 
      "periodTypeCode": "MONTH", 
      "paymentFrequencyTypeCode": "END", 
      "validityRange": {
        "startDate": "2027-02-08", 
        "endDate": null 
      }
    }
  ],
  "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 a result, the following deposit product settings were updated:

description,
countryCode,
contractNumberPrefix,
terminationType,
period,
perconTypeCode,
validityRange - endDate.

The updated deposit product is in the DRAFT status.

Activate deposit product

Use case

Use case data

API parameters with values

The path parameter is depositTypeCode. We will use the PREMIUM deposit product.

.../product/PREMIUM/activate

Sample API call

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

Sample response

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

Response

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

Result

As a result, the PREMIUM deposit product was activated.

Find deposit product

Use case

Use case data

API parameters with values

The path parameter is depositTypeCode. We will use the PREMIUM deposit product.

...deposits/product/PREMIUM

Sample API call

Sample response

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

Response

{
    "errors": null,
    "validationErrors": null,
    "data": {
        "depositTypeCode": "PREMIUM",
        "depositGroupCode": "TIME_DEPOSIT",
        "description": "Premium deposit",
        "tenantCode": "MB",
        "statusCode": "ACTIVE",
        "countryCode": "EE",
        "currencyCode": "EUR",
        "contractNumberPrefix": "PR-EE-",
        "offerValidDays": 1,
        "daysToWaitCredit": 2,
        "calculateTaxesEnabled": false,
        "terminationType": "WITHOUT_INTEREST",
        "signatureRequired": false,
        "daysToWaitSignature": null,
        "fileGenerationRequired": false,
        "withdrawalAllowed": false,
        "autoProlongationAllowed": true,
        "interestCalculationMethod": {
            "daysInMonth": "30",
            "daysInYear": 360
        },
        "interestPeriodSelector": "FIXED",
        "interests": [
            {
                "interestId": "ID-1696407383",
                "amountRange": {
                    "startValue": 5000,
                    "endValue": 100001
                },
                "periodTypeCode": "MONTH",
                "period": 3,
                "periodRange": null,
                "interestRate": 0.25,
                "minInterestRate": null,
                "maxInterestRate": null,
                "paymentFrequencyTypeCode": "END",
                "validityRange": {
                    "endDate": null,
                    "startDate": "2027-01-09"
                },
                "depositTypeCode": "PREMIUM",
                "employeeId": "1"
            }
        ],
        "depositClassCode": "PREMIUM_CUSTOMER"
    }
}

Result

As a result, a complete set of product details about the PREMIUM deposit product was returned.

Inactivate deposit product

Use case

In this example, we will review how to deactivate a deposit product.

Use case data

API parameters with values

The path parameter is depositTypeCode. We will use the PREMIUM deposit product.

...product/PREMIUM/deactivate

Sample API call

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

Sample response

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

Response

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

Result

As a result, the PREMIUM deposit product was deactivated.

Once a deposit product is deactivated, the existing active contracts created under this product will remain active until they reach their maturity date.
Opening new contracts for a deactivated deposit product is not possible.

Update deposit product

Use case

In this use case, we will review how to update a deposit product. We will change the deposit product that was created in a .

In the table below, you will find a list of the settings that have been modified for the deposit product:

Use case data

API parameters with values

The product description is updated.

"description": "Premium deposit Germany"

The deposit country is set to Germany.

 "countryCode": "DE"

The contract number prefix is modified.

"contractNumberPrefix": "PR-DE-"

The premature deposit contract termination is with interest.

"terminationType": "WITH_TOTAL_INTEREST"

The deposit contract period is 12 months.

 "period": 12

The deposit is offered for legal entities.

"personTypeCode": "L"

The deposit product end is updated. Note: the date format is YYYY-MM-DD.

"endDate": "2031-02-08"

Sample API call

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

deposit-api.sandbox.tuumplatform.com/ api/v2/deposits/product/{depositTypeCode}

See more information about the endpoint in the Tuum developer portal.

Sample request

Below is an example request body for the API call to update a deposit product.

{
  "description": "Premium deposit Germany"
  "depositGroupCode": "TIME_DEPOSIT"
  "countryCode": "DE"
  "currencyCode": "EUR"
  "contractNumberPrefix": "PR-DE-"
  "offerValidDays": 1
  "daysToWaitCredit": 2
  "calculateTaxesEnabled": false,
  "terminationType": "WITH_TOTAL_INTEREST"
  "interestCalculationMethod": {
    "daysInMonth": "30", 
    "daysInYear": 360
  },
  "interestPeriodSelector": "FIXED",
  "interests": [
    {
      "amountRange": { 
        "startValue": 6000,
        "endValue": 100001
      },
      "interestRate": 0.25,
      "periodRange": { 
        "startValue": 0,
        "endValue": 0
      },
      "period": 12, 
      "periodTypeCode": "MONTH",
      "paymentFrequencyTypeCode": "END",
      "validityRange": {
        "startDate": "2027-02-08", 
        "endDate": "2031-02-08"
      }
    }
  ],
  "personTypeCode": "L"
}

curl --location --request PUT 'https://deposit-api.sandbox.tuumplatform.com/api/v2/deposits/product/PREMIUM' \
--header 'x-channel-code: SYSTEM' \
--header 'x-auth-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHBpcnlEVGltZSI6IjIwMjQtMDUtMDNUMjA6NDQ6MDMiLCJyb2xlcyI6WyJBRE1JTiJdLCJuYW1lIjoiSm9obiBPZmZpY2VyIiwiZW1wbG95ZWVJZCI6IjEiLCJ0ZW5hbnRDb2RlIjoiTUIiLCJleHAiOjE3MTQ3NjkwNDN9.rdBXcIkNYRWcVC_iNUuYaVnaEIuN3my3L3d2hNlwSK8' \
--header 'Content-Type: application/json' \
--data '{
  "description": "Premium deposit Germany", 
  "depositGroupCode": "TIME_DEPOSIT", 
  "countryCode": "DE", 
  "currencyCode": "EUR", 
  "contractNumberPrefix": "PR-DE-", 
  "offerValidDays": 1, 
  "daysToWaitCredit": 2, 
  "calculateTaxesEnabled": false, 
  "terminationType": "WITH_TOTAL_INTEREST", 
  "interestCalculationMethod": { 
    "daysInMonth": "30", 
    "daysInYear": 360
  },
  "interestPeriodSelector": "FIXED", 
  "interests": [
    {
      "amountRange": { 
        "startValue": 6000, 
        "endValue": 100001 
      },
      "interestRate": 0.25,  
      "periodRange": { 
        "startValue": 0,
        "endValue": 0
      },
      "period": 12, 
      "periodTypeCode": "MONTH", 
      "paymentFrequencyTypeCode": "END", 
      "validityRange": {
        "startDate": "2027-02-08", 
        "endDate": null 
      }
    }
  ],
  "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 a result, the following deposit product settings were updated:

description,
countryCode,
contractNumberPrefix,
terminationType,
period,
perconTypeCode,
validityRange - endDate.

The updated deposit product is in the DRAFT status.

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"

"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.

"contractNumberPrefix": "PR-EE-"

"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 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 endpoint in the Tuum developer portal.

Sample request

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

{
  "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 --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.