Create holiday

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length between 1 and 80

Holiday name

string
required

Holiday date. Format = yyyy-mm-dd.

string
length ≤ 500

Holiday description

integer

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.

string

Existing ID value from another process or application.

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

metadata
object

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 parameters to specify holiday business rules. For details, refer to Posting Transactions on Holidays.

Responses

401

Access token missing or invalid

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json