All pages
Powered by GitBook
1 of 1

Loading...

Edit deposit offer

Use case

In this example, we will review how to edit a deposit offer.

Use case data
API parameters with values

We will change the deposit offer ID-1718024058.

...offers/ID-1718024058

We will change the deposit offer initial amount from 5000 EUR to 6000 EUR.

Sample API call

To edit a deposit offer, make the following API call.

Sample request

Below is an example request body of the API call for editing a deposit offer.

{
  "initialMoney": {
    "amount": 6000,
    "currencyCode": "EUR"
  },
  "period": 3,
  "interestPaymentFreqCode": "END",
  "taxResidencyCountryCode": "EE",
  "prolongationCode": "PRINCIPAL",
  "taxExempt": "false",
  "interestRate": 0.35
}
curl --location --request PUT 'https://deposit-api.sandbox.tuumplatform.com/api/v2/offers/ID-1718024058' \
--header 'x-channel-code: SYSTEM' \
--header 'x-auth-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJuYW1lIjoiT2ZmaWNlciBUZXN0IiwiZW1wbG95ZWVJZCI6IklELTEwMDAiLCJ0ZW5hbnRDb2RlIjoiTUIiLCJleHBpcnlEVGltZSI6IjIwMjQtMTAtMzBUMTM6MzI6MjgiLCJleHAiOjE3MzAyOTUxNDgsInJvbGVzIjpbIkFETUlOIl19.7g3ys-QseNqtzu6P5l5lEdpj1tk5izFT10f4AEc9RVo' \
--header 'Content-Type: application/json' \
--data '{
  "initialMoney": {
    "amount": 6000,
    "currencyCode": "EUR"
  },
  "period": 3,
  "interestPaymentFreqCode": "END",
  "taxResidencyCountryCode": "EE",
  "prolongationCode": "PRINCIPAL",
  "taxExempt": "false",
  "interestRate": 0.35
}'

Sample response

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

Response
{
    "errors": null,
    "validationErrors": null,
    "data": {
        "offerId": "ID-1718024058",
        "personId": "ID-2660",
        "applicationId": null,
        "depositGroupCode": "TIME_DEPOSIT",
        "depositTypeCode": "COPY_PREMIUM_NEW",
        "terminationType": "WITHOUT_INTEREST",
        "statusCode": "PRESENTED",
        "reasonCode": null,
        "accountId": "ID-1012",
        "interestRate": 0.35,
        "period": 3,
        "periodTypeCode": "MONTH",
        "endDate": null,
        "initialMoney": {
            "amount": 6000.00,
            "currencyCode": "EUR"
        },
        "interestPaymentFreqCode": "END",
        "prolongationCode": "PRINCIPAL",
        "countryCode": "EE",
        "maturityDate": "2027-04-26",
        "returnAmount": {
            "amount": 6005.25,
            "currencyCode": "EUR"
        },
        "postingDate": "2027-01-26",
        "lastValidDate": "2027-01-27",
        "channelCode": "BACKOFFICE",
        "tenantCode": "MB",
        "contractHeaderId": null,
        "contractNumber": null,
        "depositClassCode": "PREMIUM_CUSTOMER",
        "payoutDetails": {
            "name": "Test User",
            "accountNumber": {
                "value": "EE961221248796768756",
                "type": "IBAN"
            },
            "financialInstitutionId": null,
            "referenceNumber": null,
            "countryCode": null
        },
        "personTypeCode": "P",
        "taxResidencyCountryCode": "EE",
        "taxExempt": false,
        "marginRate": null
    }
}

Result

As a result the deposit offer ID-1718024058 was updated. The initial offer amount was changed.

deposit-api.sandbox.tuumplatform.com/api/v2/offers/{offerId}

See more about the endpoint in the Tuum developer portal.

"initialMoney": {
    "amount": 6000,
    "currencyCode": "EUR"
  }
edit deposit offer