LogoLogo
Developer portal
  • Welcome
    • About cookbooks
  • Authentication
    • About authentication
    • Authenticate employee
    • Create customer credentials
    • Authenticate customer
    • Refresh JSON Web Token
    • Invalidate customer credentials
    • Export-import roles
      • Export selected roles
      • Import selected roles
      • Import all roles
  • Header parameters
    • About header parameters
    • Mandatory parameters
    • Optional parameters
      • Requests with same request ID
      • Requests without request ID
  • Employee
    • Create employee
    • Find employee by ID
    • Find employee by username
  • Person
    • Create private person
    • Create legal person
    • Activate person
    • Find person
      • Find person details
      • Find person addresses
    • Create person document
    • Update personal info
    • Update person address
    • Create customer group
    • Create additional contact
    • Assign person to group
    • Create person representation
    • Close person representation
    • Create person financial data
    • Inactivate person
    • Reactivate person
    • Reactivate person
    • Forget person
    • Remove person restoration key
  • ACCOUNTS
    • Create currency account
    • Create internal account
    • Create virtual account
    • Create account application
    • Set account access rights
    • Create account limit code
    • Create account limit type
    • Create account limit
    • Create account class code
    • Create account type class rule
    • Find person accounts
    • Search account transactions
  • Reports
    • Reports
    • Request to generate account transactions report
      • Account transactions report parameters
  • Check report generation status
  • Download requested report
  • DEPOSITS
    • Deposit product management
      • Create deposit class code
      • Create deposit product
      • Update deposit product
      • Activate deposit product
      • Find deposit product
      • Inactivate deposit product
    • Deposit flow
      • Create deposit application
      • Find deposit application
      • Create deposit offer
      • Find deposit offer
      • Edit deposit offer
      • Accept deposit offer
      • Decline deposit offer
      • Find deposit contract
    • Deposit contract management
      • Change payout details
      • Change contract prolongation status
      • Update contract header
      • Adjust deposit contract interest
      • Make premature termination
  • Payments
    • Create outgoing payments
      • Create SEPA payment
      • Create SWIFT payment
      • Create domestic UK payment
      • Create domestic US payment
    • Change payment
    • Cancel payment
    • Confirm payment
    • Find AML information of a payment
    • Find settled SEPA transaction
    • Create payment template
    • Initialise FX quote request
    • Get FX quote response
    • Initiate FX order
  • LOANS
    • Create loan application
    • Accept loan application
    • Find loan application offers
    • Create loan offer
    • Accept loan offer
    • Find person contracts
    • Accept loan contract
    • Disburse loan contract
    • Create contract fee booking
    • Default loan contract
  • CARDS
    • Create price list
    • Create price for the price list
    • Card counting and summing groups
      • Create counting group
      • Create summing group
      • Find counting values for card
      • Find summing values for account
    • Add BIN
    • Create upper limit group
    • Create upper usage group
    • Create card design
    • Create debit card product
    • Activate card product
    • Create debit card application
    • Create credit product
    • Create credit card offer
    • Accept credit card offer
  • Interest base rates
    • Add interest base rate type - periodic
    • Add interest base rate type - instant
  • Interest rate caps
    • Add interest rate cap type
  • Webhooks
    • About webhooks
    • Find available webhooks
    • Enable or disable notification for webhook
      • Enable with notification type and channel code
      • Enable with notification ID
      • Disable with notification type and channel code
      • Disable with notification ID
    • Search subscribed webhooks
    • Subscribe webhook
    • Update webhook subscription
    • Unsubscribe webhook
    • Webhooks with payloads
      • Person
      • Account
      • Deposit
      • Payments
      • AML processes
      • Loan
      • Card
      • Debt
      • Finance
      • Reports
      • Processes
  • Lookups
    • About lookups
    • Find existing lookup groups
    • Find lookup values
      • Find entities
      • Find lookup type codes
      • Find lookup types
      • Find translation of lookup type
    • Create lookup values
      • Create lookup type and codes
      • Create lookup code for existing type
      • Create lookup translation
    • Manage lookup values
      • Mark lookup code as default
      • Remove default lookup code
      • Delete lookup code
  • Custom fields
    • About custom fields
    • Create custom fields
      • Create field set
      • Create fields
      • Create fields with copied values
    • Find custom fields
      • Find field sets
      • Find fields
      • Search custom field sources
      • Get custom field value
    • Update custom fields
      • Update field set
      • Update field
      • Update custom field value
    • Manage custom fields
      • Insert custom field values
      • Copy custom field values
      • Deactivate field
      • Delete custom field value
  • Holidays
    • Create holiday
    • Search existing holidays
    • Search holiday by ID
    • Delete holiday
Powered by GitBook

© Tuum 2024

On this page
  • Use case
  • Sample API call
  • Sample request
  • Sample response
  • Result

Was this helpful?

Export as PDF
  1. DEPOSITS
  2. Deposit product management

Create deposit product

PreviousCreate deposit class codeNextUpdate deposit product

Last updated 7 months ago

Was this helpful?

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.

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.

The that was created as a first step.

"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": 10001
      },
      "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"
deposit class code
create deposit product