---
updatedAt: 2026-06-12T20:28:13.000Z
---
Fetch the complete documentation index at: https://developers.pismo.io/pismo-docs/llms.txt. Use this file to discover all available pages before exploring further.
# Create holiday (deprecated)
**DEPRECATED**. Call the [Add holiday](ref:post-add-holiday-to-calendar) endpoint instead.
This endpoint is deprecated starting April 30, 2026, and final removal from both test (EXT) and production environments on October 30, 2026.
Create a holiday—a day on which your company's offices are closed for normal business activity though online financial transactions and other business activity could still be occurring.
**Note:** This endpoint is designed for transaction banking. For more information, refer to [Calendars and holidays in transaction banking](doc:calendars-and-holidays-in-transaction-banking).
# OpenAPI definition
```json
{
"openapi": "3.0.1",
"info": {
"title": "Platform setup - Holidays",
"description": "Manage business and non-business days by organization",
"version": "v1.0",
"contact": {
"name": "Pismo Support",
"url": "https://developers.pismo.io/support/"
},
"license": {
"name": "Copyright Pismo"
}
},
"servers": [
{
"url": "https://sandbox.pismolabs.io/holidays-core",
"description": "API sandbox server for testing"
}
],
"security": [
{
"S2SAuthentication": []
}
],
"tags": [
{
"name": "Holidays v2 - Transaction banking (deprecated)",
"description": "View and manage business and non-business days configurations (for Transaction banking only)"
}
],
"components": {
"schemas": {
"AdminDivIdV1Only": {
"type": "integer",
"description": "Administrative division ID. \n\nWhen passed as a parameter, either this or `external_id` is **REQUIRED**.\n",
"example": 100100
},
"AdminDivIdV2Only": {
"type": "integer",
"description": "Administrative division ID. \n\nWhen passed as a parameter, either this or `external_id` is **REQUIRED**.\n\n**Note:** \nHoliday metadata always takes precedence over the administrative division settings. If a holiday is not specifically configured using the [transaction banking parameters](https://developers.pismo.io/pismo-docs/docs/posting-transactions-on-holidays#parameters), the platform defaults to the settings in the administrative division's `metadata` object when processing transactions.\n",
"example": 100100
},
"ExternalIdV1Only": {
"type": "string",
"description": "Existing ID value from another process or application.\n\nWhen passed as a parameter, either this or `administrative_division_id` is **REQUIRED**.\n",
"example": "38400-000"
},
"handler.HTTPError": {
"description": "Error",
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Error code"
},
"message": {
"type": "string",
"description": "Error message"
}
}
},
"HolidayDate": {
"type": "string",
"description": "Holiday date. Format = yyyy-mm-dd.",
"example": "2023-12-01"
},
"HolidayDescription": {
"type": "string",
"description": "Holiday description",
"maxLength": 500,
"example": "Day to party like it's 1999"
},
"HolidayID": {
"type": "integer",
"description": "Holiday ID",
"example": 8675309
},
"HolidayName": {
"type": "string",
"description": "Holiday name",
"example": "New Year's Day",
"maxLength": 80,
"minLength": 1
},
"Metadata": {
"type": "object",
"description": "A valid JSON schema as specified in https://json-schema.org/specification.html. Used to register rules used to authorize the transaction.\n\n**Note**: This field must not be used to send Personally Identifiable Information (PII), Payment Card Industry (PCI) data, or any sensitive/regulated information. Metadata fields are intended for operational, non-sensitive data only. For sensitive data, use the specific parameters designed for that purpose. For more information, refer to [Get started with Pismo APIs](https://developers.pismo.io/pismo-docs/reference/get-started-with-pismo-apis#metadata).\n"
},
"MetadataV2": {
"type": "object",
"description": "A valid JSON schema, as specified in https://json-schema.org/specification.html. Used to register the rules that are used to authorize the transaction.\n\nYou can use metadata parameters to specify holiday business rules. For details, refer to Posting Transactions on Holidays.\n\n**Note**: This field must not be used to send Personally Identifiable Information (PII), Payment Card Industry (PCI) data, or any sensitive/regulated information. Metadata fields are intended for operational, non-sensitive data only. For sensitive data, use the specific parameters designed for that purpose. For more information, refer to [Get started with Pismo APIs](https://developers.pismo.io/pismo-docs/reference/get-started-with-pismo-apis#metadata).\n"
},
"NextBusinessDate": {
"type": "string",
"format": "date",
"description": "Next work day following the holiday. Format = yyyy-mm-dd.",
"example": "2023-01-02"
},
"presenter.CreateHolidayRequestV2": {
"description": "Create holiday for transaction banking payload",
"type": "object",
"required": [
"name",
"holiday_date"
],
"properties": {
"name": {
"$ref": "#/components/schemas/HolidayName"
},
"holiday_date": {
"$ref": "#/components/schemas/HolidayDate"
},
"description": {
"$ref": "#/components/schemas/HolidayDescription"
},
"administrative_division_id": {
"$ref": "#/components/schemas/AdminDivIdV2Only"
},
"external_id": {
"$ref": "#/components/schemas/ExternalIdV1Only"
},
"metadata": {
"$ref": "#/components/schemas/MetadataV2"
}
}
},
"presenter.CreateHolidayResponseV2": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/HolidayID"
},
"name": {
"$ref": "#/components/schemas/HolidayName"
},
"description": {
"$ref": "#/components/schemas/HolidayDescription"
},
"holiday_date": {
"$ref": "#/components/schemas/HolidayDate"
},
"next_business_date": {
"$ref": "#/components/schemas/NextBusinessDate"
},
"administrative_division_id": {
"$ref": "#/components/schemas/AdminDivIdV1Only"
},
"metadata": {
"$ref": "#/components/schemas/Metadata"
}
}
}
},
"responses": {
"400BadRequestCreateHoliday": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/handler.HTTPError"
},
"examples": {
"missing-x-tenant-header": {
"$ref": "#/components/examples/BadRequestResponseMissingHeader"
},
"invalid-id-params": {
"$ref": "#/components/examples/BadRequestResponseInvalidParams"
},
"holiday-date-wrong-format": {
"$ref": "#/components/examples/BadRequestResponseHolidayWrongFormat"
},
"working-date-wrong-format": {
"$ref": "#/components/examples/BadRequestResponseWorkingDateWrongFormat"
},
"working-date-less-than-current-date": {
"$ref": "#/components/examples/BadRequestResponseDatesWrong"
},
"holiday-already-exists": {
"$ref": "#/components/examples/BadRequestResponseAlreadyExists"
}
}
}
}
},
"401UnauthorizedError": {
"description": "Access token missing or invalid"
},
"404NotFound": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/handler.HTTPError"
},
"examples": {
"response-missing-tenant": {
"$ref": "#/components/examples/NotFoundResponse"
}
}
}
}
},
"500InternalServerError": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/handler.HTTPError"
},
"examples": {
"generic-internal-error": {
"$ref": "#/components/examples/InternalServerErrorResponse"
}
}
}
}
}
},
"securitySchemes": {
"S2SAuthentication": {
"type": "http",
"scheme": "bearer",
"description": "All requests must pass an [account-specific token](https://developers.pismo.io/pismo-docs/docs/account-specific-access-tokens).\n"
}
},
"examples": {
"InternalServerErrorResponse": {
"value": {
"code": "EHLD0001",
"message": "Something went wrong - please try again"
}
},
"BadRequestResponseMissingHeader": {
"value": {
"code": "EHLD0016",
"message": "Missing x-tenant header"
}
},
"BadRequestResponseAlreadyExists": {
"value": {
"code": "EHLD0027",
"message": "Holiday calendar already exists"
}
},
"BadRequestResponseHolidayWrongFormat": {
"value": {
"code": "EHLD0028",
"message": "Holiday date with the wrong format"
}
},
"BadRequestResponseWorkingDateWrongFormat": {
"value": {
"code": "EHLD0030",
"message": "Working date with the wrong format"
}
},
"BadRequestResponseDatesWrong": {
"value": {
"code": "EHLD0031",
"message": "Working date less than the current date"
}
},
"BadRequestResponseInvalidParams": {
"value": {
"code": "400",
"message": "Invalid parameter value: {parameter name}"
}
},
"NotFoundResponse": {
"value": {
"code": "404",
"message": "{target name} not found"
}
},
"CreateHolidayResponseV2": {
"value": {
"id": 1,
"name": "New Year's Day",
"description": "New Year's Day",
"holiday_date": "2023-01-01",
"administrative_division_id": 1,
"metadata": {
"accrue_interest": true,
"check_dormancy": true,
"create_account": false,
"defer_statement_due_date": true,
"defer_transactions": true,
"post_interest": false,
"post_transactions": false,
"run_cycle_closing": false,
"any_value": "any_value"
}
}
}
}
},
"paths": {
"/holidays-core/v2/holiday": {
"post": {
"summary": "Create holiday (deprecated)",
"description": "**DEPRECATED**. Call the [Add holiday](https://developers.pismo.io/pismo-docs/reference/post-add-holiday-to-calendar) endpoint instead.\n\nThis endpoint is deprecated starting April 30, 2026, and final removal from both test (EXT) and production environments on October 30, 2026.\n\nCreate a holiday—a day on which your company's offices are closed for normal business activity though online financial transactions and other business activity could still be occurring. \n\n**Note:** This endpoint is designed for transaction banking. For more information, refer to [Calendars and holidays in transaction banking](https://developers.pismo.io/pismo-docs/docs/calendars-and-holidays-in-transaction-banking).\n",
"operationId": "post-v2-holiday",
"deprecated": true,
"tags": [
"Holidays v2 - Transaction banking (deprecated)"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/presenter.CreateHolidayRequestV2"
}
}
}
},
"responses": {
"201": {
"description": "Holidays response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/presenter.CreateHolidayResponseV2"
},
"examples": {
"response-create-holidays-v2": {
"$ref": "#/components/examples/CreateHolidayResponseV2"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/400BadRequestCreateHoliday"
},
"401": {
"$ref": "#/components/responses/401UnauthorizedError"
},
"404": {
"$ref": "#/components/responses/404NotFound"
},
"500": {
"$ref": "#/components/responses/500InternalServerError"
}
}
}
}
}
}
```