Create holiday

Use case

Use case data	API parameters with values
We will add a new bank holiday.	"holidayTypeCode": "BANKHOLIDAY"
This bank holiday should apply to Germany. Note: the bank holiday requires country information.	"countryCode": "DE"
The bank holiday date. Note: the date must be in the future.	"date": "2027-12-23"

The holidayTypeCode parameter can have one of the following values:

• BANKHOLIDAY - to add a bank holiday,

• WEEKEND - to add a weekend,

• TARGET2 - to add holidays related to the pan-European payment system, TARGET2.

Sample API call

To create a holiday, use the following endpoint:

https://holiday-api.sandbox.tuumplatform.com/api/v1/holidays

Learn more about the add holiday endpoint in the Tuum developer portal.

Sample request

The sample request body is as follows:

JSON

{
  "holidayTypeCode": "BANKHOLIDAY",
  "countryCode": "DE",
  "date": "2027-12-23"
}

cURL

curl --location 'https://holiday-api.sandbox.tuumplatform.com/api/v1/holidays' \
--header 'x-channel-code: SYSTEM' \
--header 'x-auth-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJuYW1lIjoiT2ZmaWNlciBUZXN0IiwiZW1wbG95ZWVJZCI6IklELTEwMDAiLCJ0ZW5hbnRDb2RlIjoiTUIiLCJleHBpcnlEVGltZSI6IjIwMjQtMTItMTlUMTU6NTk6MTciLCJleHAiOjE3MzQ2MjM5NTcsInJvbGVzIjpbIkFETUlOIl19.KbElTk79s6pZJDXzv6pWgYEGatet0mpHMYBLsUlNhkw' \
--header 'Content-Type: application/json' \
--data '{
  "holidayTypeCode": "BANKHOLIDAY",
  "countryCode": "DE",
  "date": "2027-12-23"
}'

Sample response

Below you will find the response to the sample request:

Response

{
    "errors": null,
    "validationErrors": null,
    "data": {
        "holidayId": "ID-4505",
        "holidayTypeCode": "BANKHOLIDAY",
        "countryCode": "DE",
        "date": "2027-12-23",
        "statusCode": "ACCEPTED",
        "holidayDeclineReason": null,
        "dependentUpdatesRequired": true
    }
}

Result

As a result, a new country-specific bank holiday with the holidayId ID-4505 was added to the Tuum system.