Holiday Data Request

Method

GET command, in “application/json” format

Endpoint

https://apps.applyfinancial.co.uk/validate-api/rest/convert/4.6

Request

The user is able to retrieve holidays using this call in 2 ways

Requesting holiday for a country/currency

  1. The user can enter a token and retrieve the holidays for a country.  This requires the input of the following fields
Field Field description Type of field
countryCode ISO Country Code xs:string
token Security token xs:string

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 Field description Type of field
startDate Start date of the holiday that you want.  IF blank then todays date is used xs:string
endDate End date of holiday, if left blank then we will give 3 months xs:string

Requesting holiday for a specific payment

The holiday can be requested for a specific payment.  This requires the user to enter the bankToken and the freeToken from a payment which will give the holidays that relate to the initial search.

Field Field description Type of field
bankToken Token relating to the bank you searched for xs:string
freeToken Token relating to the bank you searched for xs:string

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 Field description Type of field
startDate Start date of the holiday that you want.  IF blank then todays date is used xs:string
endDate End date of holiday, if left blank then we will give 3 months xs:string

Example

https://apps.applyfinancial.co.uk/validate-api/rest/convert/4.6?token=ENTERTOKEN&countryCode=IN&holidayType=&startDate=01/11/19&endDate=01/03/20&bankToken=&freeToken=&ref=1&errorComment=

Response

Field Name Description Format
countryCode ISO Country Code ISO 2 digit country code
currencyCode ISO Currency Code ISO 3 digit currency code
holidays Label
id Holiday unique Unique id for the holiday
title Name of holiday Local holiday name
start Date and time of start dd/mm/yy hh:mm:ss:sss
end Date and time of end dd/mm/yy hh:mm:ss:sss
code type of holiday w – Weekend
N – National holiday
C – Currency holiday