Create deposit application

Use case

In this example, we will review how to create a deposit application with a minimum data set.

Use case data	API parameters with values
We will create a deposit application for a test person whose account ID is ID-2660.	...persons/ID-2660/applications
The amount that the test person is going to deposit is 5000 EUR.	"initialMoney": { "amount": 5000, "currencyCode": "EUR" }
The deposit application is opened for a PREMIUM deposit product created earlier.	"depositTypeCode": "PREMIUM"
The servicing account ID that is tied to the deposit. Note: see the create account article to learn more about the account creation.	"accountId": "ID-5334"
The deposit is offered with the 3 month duration. The interest will be paid at the end of the contract period. The deposit's jurisdiction country is Estonia.	"period": 3, "periodTypeCode": "MONTH", "interestPaymentFreqCode": "END", "countryCode": "EE"
The tax residency code determines which tax rate is enabled for this country when deducting the tax from the interest during the pay out. The tax exempt is false by default. Note: the taxResidencyCountryCode and taxExempt parameters are editable even after the deposit contract is created or activated.	"taxResidencyCountryCode": "EE", "taxExempt": "false"

Sample API call

deposit-api.sandbox.tuumplatform.com/api/v2/persons/{personId}/applications

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

Sample request

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

JSON

{
  "initialMoney": {
    "amount": 5000,
    "currencyCode": "EUR"
  },
  "depositTypeCode": "PREMIUM",
  "accountId": "ID-5334",
  "period": 3,
  "periodTypeCode": "MONTH",
  "interestPaymentFreqCode": "END",
  "countryCode": "EE",
  "taxResidencyCountryCode": "EE",
  "taxExempt": "false"
}

cURL

curl --location 'https://deposit-api.sandbox.tuumplatform.com/api/v2/persons/ID-2660/applications' \
--header 'x-channel-code: SYSTEM' \
--header 'x-auth-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJuYW1lIjoiSm9obiBPZmZpY2VyIiwiZW1wbG95ZWVJZCI6IjEiLCJ0ZW5hbnRDb2RlIjoiTUIuRVUiLCJleHBpcnlEVGltZSI6IjIwMjQtMDUtMjlUMTc6MjM6MDQiLCJleHAiOjE3MTcwMDMzODQsInJvbGVzIjpbIkFETUlOIl19.RyH47_HA4Run4sJtIGeiJmxhlN8sCin_GnGLH_6qKZc' \
--header 'Content-Type: application/json' \
--data '{
  "initialMoney": {
    "amount": 5000,
    "currencyCode": "EUR"
  },
  "depositTypeCode": "PREMIUM",
  "accountId": "ID-5334",
  "period": 3,
  "periodTypeCode": "MONTH",
  "interestPaymentFreqCode": "END",
  "countryCode": "EE",
  "taxResidencyCountryCode": "EE",
   "taxExempt": "false"
}'

Sample response

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

Response

{
    "errors": null,
    "validationErrors": null,
    "data": {
        "applicationId": "ID-1696407202",
        "personId": "ID-2660",
        "depositGroupCode": "TIME_DEPOSIT",
        "depositTypeCode": "PREMIUM",
        "statusCode": "ACCEPTED",
        "accountId": "ID-5334",
        "period": 3,
        "periodTypeCode": "MONTH",
        "endDate": null,
        "initialMoney": {
            "amount": 5000.00,
            "currencyCode": "EUR"
        },
        "interestPaymentFreqCode": "END",
        "prolongationCode": null,
        "countryCode": "EE",
        "interestRate": 0.25,
        "postingDate": "2024-11-14",
        "channelCode": "SYSTEM",
        "tenantCode": "MB",
        "offerId": null,
        "depositClassCode": "PREMIUM_CUSTOMER",
        "payoutDetails": null,
        "personTypeCode": "P",
        "taxResidencyCountryCode": "EE",
        "taxExempt": false
    }
}
     

Result

As a result, a new deposit application ID-1696407202 was created.