Add interest base rate type - periodic

Use case

With the example of the EURIBOR 1 month we will show how to add an interest base rate type with periodic rate application rule to the Tuum system.

Use case data	API parameters with values
We will add the EURIBOR 1 month base rate.	{ "rateBaseCode": "EURIBOR 1 month", "maturityTypeCode": "M", "maturityLength": 1, "currencyCode": "EUR", "referenceRateTypeCode": "EURIBOR", ... }
The base rate is applied to the existing loan offers and contracts periodically.	"rateApplicationRule": "PERIODIC"
The 4eye confirmation for the the rate fixings is not required.	"fourEyeRequired": false

The rateApplicationRule parameter can have the following values:

• INSTANT - base rate requires contracts mass update after the new fixing rate is added.

• PERIODIC - the base rate has a defined contract floating period.

• NONE - the base rate type does not require contracts update.

Sample API call

To add new base rate types, use the following endpoint:

https://currency-api.sandbox.tuumplatform.com/api/v1/base-rates/types

Learn more about the add base rate type endpoint in the Tuum developer portal.

Sample request

Below is an example request body of the API call for adding a new base rate types.

JSON

{
  "rateBaseCode": "EURIBOR 1 month",
  "maturityTypeCode": "M",
  "maturityLength": 1,
  "currencyCode": "EUR",
  "referenceRateTypeCode": "EURIBOR",
  "rateApplicationRule": "PERIODIC",
  "fourEyeRequired": false
}

cURL

curl --location 'https://currency-api.sandbox.tuumplatform.com/api/v1/base-rates/types' \
--header 'x-auth-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHBpcnlEVGltZSI6IjIwMjMtMDktMjVUMTQ6MTc6MjkiLCJyb2xlcyI6WyJBRE1JTiJdLCJuYW1lIjoiSm9obiBPZmZpY2VyIiwiZW1wbG95ZWVJZCI6IjEiLCJ0ZW5hbnRDb2RlIjoiTUIiLCJleHAiOjE2OTU2NTE0NDl9.Zo39uMKkrlxqsjRTwhEGwz2NukSnBigNTztbtYYPb3k' \
--header 'x-channel-code: SYSTEM' \
--header 'Content-Type: application/json' \
--data '{
  "rateBaseCode": "EURIBOR 1 month",
  "maturityTypeCode": "M",
  "maturityLength": 1,
  "currencyCode": "EUR",
  "referenceRateTypeCode": "EURIBOR",
  "rateApplicationRule": "PERIODIC",
  "fourEyeRequired": false
}'

Sample response

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

Response

{
    "errors": null,
    "validationErrors": null,
    "data": {
        "rateBaseCode": "EURIBOR 1 month",
        "maturityTypeCode": "M",
        "maturityLength": 1,
        "currencyCode": "EUR",
        "referenceRateTypeCode": "EURIBOR",
        "rateApplicationRule": "PERIODIC",
        "fourEyeRequired": false
    }
}

Result

As a result, the EURIBOR 1 month rate with a periodic application rule is added to the Tuum system.