Add interest rate cap type

Use case

In this example we will review how to add an interest rate cap type.

Use case data	API parameters with values
We will add a Bank of Finland PIRC interest rate cap.	"interestRateCapCode": "Bank of Finland PIRC"
The interest rate cap is applied instantly.	"rateCapApplicationRule": "INSTANT"
The 4eye confirmation for the the interest rate cap fixings is not required.	"fourEyeRequired": false

Sample API call

To add a new interest rate cap type, make the following API call.

https://currency-api.sandbox.tuumplatform.com/api/v1/interest-rate-caps/types

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

Sample request

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

JSON

{
  "interestRateCapCode": "Bank of Finland PIRC",
  "rateCapApplicationRule": "INSTANT",
  "fourEyeRequired": false
}

cURL

curl --location 'https://currency-api.sandbox.tuumplatform.com/api/v1/interest-rate-caps/types' \
--header 'x-auth-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHBpcnlEVGltZSI6IjIwMjMtMDktMjVUMTQ6MTc6MjkiLCJyb2xlcyI6WyJBRE1JTiJdLCJuYW1lIjoiSm9obiBPZmZpY2VyIiwiZW1wbG95ZWVJZCI6IjEiLCJ0ZW5hbnRDb2RlIjoiTUIiLCJleHAiOjE2OTU2NTE0NDl9.Zo39uMKkrlxqsjRTwhEGwz2NukSnBigNTztbtYYPb3k' \
--header 'x-channel-code: SYSTEM' \
--header 'Content-Type: application/json' \
--data '{
  "interestRateCapCode": "Bank of Finland PIRC",
  "rateCapApplicationRule": "INSTANT",
  "fourEyeRequired": false
}'

Sample response

Response

{
    "errors": null,
    "validationErrors": null,
    "data": {
        "interestRateCapCode": "Bank of Finland PIRC",
        "rateCapApplicationRule": "INSTANT",
        "fourEyeRequired": false
    }
}

Result

As a result, a Bank of Finland PIRC interest rate cap type with an instant application rule is added to the Tuum system.