Endpoint: https://api.validate.bankersalmanac.com/holiday
Swagger link: https://api.validate.bankersalmanac.com/swagger-ui/index.html#/conversion-service-endpoint/holiday
Overview
The user can retrieve holidays list by using this call in 2 ways:
- Requesting holiday for a country/currency
The user can enter a token and the country code and retrieve the holidays for a country.
| Field Name | Description | Format |
| countryCode | ISO Country Code | Alpha |
| token | Security token | Alphanumeric & Extended Characters |
This call will give a default of 3 months holiday from today.
The user also has the option of entering the start date and the end date of the holiday.
If start date is blank, then the today date is used. If End date is left blank, then will give a default of 3 months holyday from today.
| Field Name | Description | Format |
| startDate | Start date of the holiday that you want. IF blank then todays date is used | Date |
| endDate | End date of holiday, if left blank then we will give 3 months | Date |
- Requesting holiday for a specific payment
The holiday can be requested for a specific payment. This requires the user to enter the Bank Token and the Free Token from a payment which will give the holidays that relate to the initial search.
| Field Name | Description | Format |
| bankToken | Token relating to the bank you searched for | Alphanumeric & Extended Characters |
| freeToken | Token relating to the bank you searched for | Alphanumeric & Extended Characters |
This will give a default of 3 months holiday from today.
The user also has the option of entering the dates they would like the holiday for which are
| Field Name | Description | Format |
| startDate | Start date of the holiday that you want. IF blank then todays date is used | Date |
| endDate | End date of holiday, if left blank then we will give 3 months | Date |
Endpoint inputs
| Field Name | Description | Format | Mandatory or Optional | Default Value |
| countryCode | ISO Country Code | Alpha | Mandatory | |
| holidayType | Type of holiday requested | Alpha | Optional | |
| startDate | Start date of the holiday that you want. IF blank then today’s date is used | Date | Optional | |
| endDate | End date of holiday, if left blank then we will give 3 months | Date | Optional | |
| bankToken | This is similar to “token” but for a specific bank only. Required to be used with “freeToken” | Alphanumeric & Extended Characters | Mandatory | |
| freeToken | This is similar to “token” but when used, the validation will be free. | Alphanumeric & Extended Characters | Mandatory | |
| ref | Payment reference | Alphanumeric & Extended Characters | Optional | |
| errorComment | 1-character flag to determine if the enhanced “comment” from VSS will be returned | Alpha | Optional |
Response modifications
No modification can be done to the response.
Response outcomes
To understand the responses, please refer to Swagger – https://api.validate.bankersalmanac.com/swagger-ui/index.html#/conversion-service-endpoint/holiday
| Field Name | Description | Format | ||
| countryCode | ISO Country Code | Alpha | ||
| currencyCode | Label | Alpha | ||
| status | Status of the response PASS, CAUTION or FAIL | Alpha | ||
| comment | Description of the status | Alpha | ||
| ref | Reference | Alphanumeric & Extended Characters | ||
| holidays | ||||
| id | Unique holiday ID | |||
| title | Name of holiday | Alpha | ||
| start | Start date and time of holiday | date | ||
| end | End date and time of holiday | date | ||
| code | Code for type of holiday |
Test Examples
token
country code “US”