Holidays

Check the non-working days due to national holidays in each country that you have an LP's account

Holidays

GET https://api.stage.localpayment.com/api/resources/holidays

Holidays

Path Parameters

Name	Type	Description
CountryISOCode3*	String	Mandatory. Country in ISOCode3 format
Year	String	Optional. Add an year, i.e.: 2022. If no year is added in this field, the response will return the of the holidays for the current year

200: OK

[
    {
        "country": "BRA",
        "date": "2022-01-01T00:00:00",
        "description": "New Year's Day"
    },
    {
        "country": "BRA",
        "date": "2022-05-01T00:00:00",
        "description": "Labour Day"
    },
    {
        "country": "BRA",
        "date": "2022-11-02T00:00:00",
        "description": "All Souls' Day"
    },
    {
        "country": "BRA",
        "date": "2022-09-07T00:00:00",
        "description": "Independence Day"
    },
    {
        "country": "BRA",
        "date": "2022-10-12T00:00:00",
        "description": "Virgin Mary Commemoration (Nossa Senhora Aparecida)"
    },
    {
        "country": "BRA",
        "date": "2022-11-15T00:00:00",
        "description": "Republic Proclamation Day"
    },
    {
        "country": "BRA",
        "date": "2022-04-21T00:00:00",
        "description": "Tiradentes Memorial Day"
    },
    {
        "country": "BRA",
        "date": "2022-12-25T00:00:00",
        "description": "Christmas Day"
    }
]

400: Bad Request

{
    "Status": 400,
    "Message": "Country ISO code does not exist"
}

Holidays: request & response examples

Example request

curl --location --request GET 'https://api.stage.localpayment.com/api/resources/holidays?CountryISOCode3=BRA&year=2022' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNjQ3ODg1NjkxLCJqdGkiOiI3YTgzOTI4NzY3ODY0MzVmODhmMzg2MTc5MzlmZjgxZSIsInVzZXJfaWQiOjMwLCJzdXBlcnVzZXIiOnRydWUsImlzX3N0YWZmIjpmYWxzZSwicm9sZXMiOlsiQUxMIl0sImNvdW50cmllcyI6WyJBTEwiXSwiY29tcGFueSI6IjAwMDEiLCJjbGllbnRfY29kZSI6IjAwMDEifQ.GN6UgRaGXwpJu44NMhZS2SbdWluGxy_zf56b6-91xgY' \
--data-raw ''

Example response

[
    {
        "country": "BRA",
        "date": "2022-01-01T00:00:00",
        "description": "New Year's Day"
    },
    {
        "country": "BRA",
        "date": "2022-05-01T00:00:00",
        "description": "Labour Day"
    },
    {
        "country": "BRA",
        "date": "2022-11-02T00:00:00",
        "description": "All Souls' Day"
    },
    {
        "country": "BRA",
        "date": "2022-09-07T00:00:00",
        "description": "Independence Day"
    },
    {
        "country": "BRA",
        "date": "2022-10-12T00:00:00",
        "description": "Virgin Mary Commemoration (Nossa Senhora Aparecida)"
    },
    {
        "country": "BRA",
        "date": "2022-11-15T00:00:00",
        "description": "Republic Proclamation Day"
    },
    {
        "country": "BRA",
        "date": "2022-04-21T00:00:00",
        "description": "Tiradentes Memorial Day"
    },
    {
        "country": "BRA",
        "date": "2022-12-25T00:00:00",
        "description": "Christmas Day"
    }
]

Check the CountryISO Code3 in the following section:

Country Codes