PIpismo
Holidays (deprecated)

Check if business day (deprecated)

DEPRECATED. Call the Get business day endpoint instead.

Check if a specific date is a business day for an administrative division.

Note: The response could contain outdated information until at least one minute after an administrative division update.

post/holidays-core/v1/search-business-day

Request

  • Base URL
    https://sandbox.pismolabs.io/holidays-core
  • URL
    https://sandbox.pismolabs.io/holidays-core/holidays-core/v1/search-business-day
  • Auth
    HTTP bearer

Request body

current_datestring required

Holiday date. Format = yyyy-mm-dd.

division_idinteger required

Division ID

Example request

{
  "current_date": "2023-12-01"
}

Response

OK

division_idinteger

Division ID

namestring

Holiday name

descriptionstring

Holiday description

current_datestring date

Current date. Format = yyyy-mm-dd.

next_business_datestring date

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

prior_business_datestring date

Business day prior to holiday. Format = yyyy-mm-dd.

is_holidayboolean

Is this a holiday?

is_weekendboolean

Is this a weekend day?

holiday_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.

division_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

{
  "division_id": 100,
  "name": "New Year's Day",
  "description": "Day to party like it's 1999",
  "current_date": "2023-01-02",
  "next_business_date": "2023-01-02",
  "prior_business_date": "2023-01-02",
  "is_holiday": true,
  "is_weekend": true
}

Changes

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