Adjust deposit contract interest

Use case

In this use case, we will create an interest adjustment for an active deposit contract. We will use the deposit contract that was previously created.

Use case data	API parameters with values
The contract header is ID-1696407222. See find deposit contract page for more details.	...contracts/ID-1696407222/adjustments
The contract adjustment is an interest increase. And the component is interest. Note: to create an interest decrease adjustment, use the following value for the eventTypeCode parameter: INTEREST_DECREASE.	"eventTypeCode": "INTEREST_INCREASE", "componentTypeCode": "INT",
The interest increase amount is 0.25 EUR. Note: the contract interest adjustments must fall within the overall deposit interest adjustments rule.	"money": { "amount": 0.25, "currencyCode": "EUR" }

Sample API call

To adjust the deposit contract interest, make the following API call. deposit-api.sandbox.tuumplatform.com/api/v1/contracts/{headerId}/adjustments

See more about the create contract adjustment endpoint in the Tuum developer portal.

Sample request

Below is an example request body of the API call for changing deposit contract payout details.

JSON

{
  "valueDateRule": "APPROVAL_DATE",
  "valueDate": "2027-03-06",
  "eventTypeCode": "INTEREST_INCREASE",
  "details": "Test",
  "componentTypeCode": "INT",
  "money": {
    "amount": 0.25,
    "currencyCode": "EUR"
  }
}

cURL

curl --location 'https://deposit-api.sandbox.tuumplatform.com/api/v1/contracts/ID-1696407222/adjustments' \
--header 'x-channel-code: SYSTEM' \
--header 'x-auth-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHBpcnlEVGltZSI6IjIwMjQtMDMtMTVUMTU6Mjk6MzgiLCJyb2xlcyI6WyJBRE1JTiJdLCJuYW1lIjoiSm9obiBPZmZpY2VyIiwiZW1wbG95ZWVJZCI6IjEiLCJ0ZW5hbnRDb2RlIjoiTUIuRVUiLCJleHAiOjE3MTA1MTY1Nzh9.B5YRuidueo8Ykoqv3z89Jm1rYSwPe2_B1w7Kk_sjP-k' \
--header 'Content-Type: application/json' \
--data '{
  "valueDateRule": "APPROVAL_DATE",
  "valueDate": "2027-03-06",
  "eventTypeCode": "INTEREST_INCREASE",
  "details": "Test",
  "componentTypeCode": "INT",
  "money": {
    "amount": 0.25,
    "currencyCode": "EUR"
  }
}'

Sample response

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

Response

{
    "errors": null,
    "validationErrors": null,
    "data": {
        "adjustmentBookingId": "ID-1021",
        "componentTypeCode": "INT",
        "eventTypeCode": "INTEREST_INCREASE",
        "adjustmentType": "BOOKING",
        "postingDate": "2027-06-03",
        "valueDateRule": "APPROVAL_DATE",
        "valueDate": "2027-06-03",
        "statusCode": "PROCESSED",
        "initiatedByUserId": "1",
        "amountMoney": {
            "amount": 0.25,
            "currencyCode": "EUR"
        },
        "details": "Test",
        "source": {
            "sourceName": "DEPOSIT.CONTRACT_HEADER",
            "sourceRef": "ID-1696407222",
            "sourceLink": null
        },
        "originalAdjustmentBookingId": null,
        "headerId": "ID-1696407222",
        "personId": "ID-2660",
        "versionId": "ID-1696407267"
    }
}

Result

As a result a deposit contract interest adjustment: INTEREST_INCREASE with ID-1021 was created.