Sign in

v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB
Holidays v2 - Transaction banking (deprecated)

List holidays (deprecated)

DEPRECATED. Call the new List holidays endpoint instead.

This endpoint is deprecated starting April 30, 2026, and final removal from both test (EXT) and production environments on October 30, 2026.

Return a paginated list of holidays registered for an organization.

Note: This endpoint is designed for transaction banking. For more information, refer to Calendars and holidays in transaction banking.

get/holidays-core/v2/holiday

Query parameters

pageinteger

Page number.

perPageinteger
Example:15

Items per page

order'ASC' | 'DESC'

Order to return items: ASC = ascending order, DESC = descending. Default is DESC.

orderBy'ID' | 'NAME'
Example:ID

Sort by ID or NAME. Default = ID.

administrativeDivisionIdinteger required

Administrative Division ID filter

namestring
Example:New Year's Day

Holiday name filter

holidayDatestring
Example:2023-01-01

Holiday date filter. Format = yyyy-mm-dd.

begin_datestring required
Example:2025-01-01

Beginning date filter, format = yyyy-mm-dd

end_datestring required
Example:2025-01-30

End date filter, format = yyyy-mm-dd

deletedboolean

Deleted holidays filter. This field is for internal use only, deleted holidays are not returned,

Response

OK

current_pageinteger

Current page number

pagesinteger

Number of pages

per_pageinteger

Maximum number of items per page

total_itemsinteger

Total number of items

Example response

{
  "current_page": 1,
  "items": [
    {
      "administrative_division": {
        "id": 1111,
        "name": "Brazil"
      },
      "id": 8675309,
      "name": "New Year's Day",
      "description": "Day to party like it's 1999",
      "holiday_date": "2023-12-01",
      "working_date": "2023-01-02",
      "metadata": "{ \"key\": \"value\"}",
      "created_at": "2024-09-12T16:46:16.43663522"
    }
  ],
  "pages": 10,
  "per_page": 15,
  "total_items": 100
}