PIpismo
Holidays v2 - Transaction banking (deprecated)

Create holiday (deprecated)

DEPRECATED. Call the Add holiday endpoint instead.

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.

post/holidays-core/v2/holiday

Request

  • Base URL
    https://sandbox.pismolabs.io/holidays-core
  • URL
    https://sandbox.pismolabs.io/holidays-core/holidays-core/v2/holiday
  • Auth
    HTTP bearer

Request body

namestring required

Holiday name

holiday_datestring required

Holiday date. Format = yyyy-mm-dd.

descriptionstring

Holiday description

administrative_division_idinteger

Administrative division ID.

When passed as a parameter, either this or external_id is REQUIRED.

Note: Holiday metadata always takes precedence over the administrative division settings. If a holiday is not specifically configured using the transaction banking parameters, the platform defaults to the settings in the administrative division's metadata object when processing transactions.

external_idstring

Existing ID value from another process or application.

When passed as a parameter, either this or administrative_division_id is REQUIRED.

metadataMetadataV2

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.

You can use metadata <a href="https://developers.pismo.io/pismo-docs/docs/posting-transactions-on-holidays#parameters">parameters</a> to specify holiday business rules. For details, refer to <a href="https://developers.pismo.io/pismo-docs/docs/posting-transactions-on-holidays">Posting Transactions on Holidays</a>.

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.

Example request

{
  "name": "New Year's Day",
  "holiday_date": "2023-12-01",
  "description": "Day to party like it's 1999",
  "administrative_division_id": 100100,
  "external_id": "38400-000"
}

Response

Holidays response

idinteger

Holiday ID

namestring

Holiday name

descriptionstring

Holiday description

holiday_datestring

Holiday date. Format = yyyy-mm-dd.

next_business_datestring date

Next work day following the holiday. Format = yyyy-mm-dd.

administrative_division_idinteger

Administrative division ID.

When passed as a parameter, either this or external_id is REQUIRED.

metadataMetadata

A valid JSON schema as specified in https://json-schema.org/specification.html. Used to register rules used to authorize the transaction.

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.

Example response

{
  "id": 8675309,
  "name": "New Year's Day",
  "description": "Day to party like it's 1999",
  "holiday_date": "2023-12-01",
  "next_business_date": "2023-01-02",
  "administrative_division_id": 100100
}

Changes

No recorded changes to this operation across all 1 revision of this API.