{
  "aid": "swaggerhub.fastpayhotels:bookingapi-1.9.3",
  "name": "Fastpayhotels Booking API",
  "type": "Index",
  "description": "\nFastpayhotels Booking API is a specification designed for API integration customers in order to connect to Fastpayhotels Booking Engine System. \n\n  # **What's new in 1.9.3 version?**\n- **Availability in local currency**\n  - Customers can now see hotel availability and book in the local currency of the hotel. (Previous authorisation is required)\n  - See #/definitions/options\n  \n- **Payment details**\n  - Customer capability to send VCC payment details in booking request. (Previous authorisation is required)     \n  - See #/definitions/payment\n\n# **What's new in 1.9.2 version?**\n\n- **RatePlan details**\n  - New property ratePlanDetails: Contains detailed descriptive info for ratePlan selected\n  - See #availRoomRate/ratePlanDetails\n\n\n# **What's new in 1.9.1 version?**\n\n- **Nearby Airport IATA Code added to hotelDetails API request**\n  - See #hotelInfo/location node to find new IATA info for hotel nearby airport.\n\n# **What's new in 1.9.0 version?**\n\n- **Destination and supplier Taxes:**\n  - Now all rates will include hotel taxes information with total transparency.\n  - Public price will be updated with taxes not already included in base price.\n- **Special Requests:**\n  - Customers now have the capability to include special requests for their guests during Reservation step.\n  \n# **What's new in 1.8.0 version?**\n\n- **Booking avail response message.**\n  - Add a new field called **ratePlanCode**.\n  - Add a new field called **ratePlanName**.\n- **Booking book response message.**\n  - Add a new field called **ratePlanCode**.\n  - Add a new field called **ratePlanName**.\n  - Add a new field called **name**.\n  \n# **Workflows**\n\nFastpayhotels Booking API has three main workflows, hotel portfolio and catalogue, availability queries, and real time booking methods.\n\nThese three workflows are hosted in different URL endpoints so implementors should take into account that different security token retrieval must be performend for each workflow\n\n\nAs per development integration phase, URL endpoints would be:\n\n- Portfolio and catalogue endpoint: *https://catalogue.fastpayhotels.net/api*\n- Availability requests endpoint: *https://avail.fastpayhotels.net/api*\n- Booking engine access endpoint: *https://booking.fastpayhotels.net/api*\n\n\n**Mandatory HTTPS protocol**\nAll request to API must be performed through https:// protocol\n\n\n\n**Security based on OAuth 2.0 technology**.\nThe API has two main roles **Customer API** and **Agency** and the authentication protocol is token-based.\nOnce you get a valid token, you retain access as long as the token remains valid. \nThe token is invalidated if the access credentials change or the token expires.\n\n**Authentication URL:** .../security/token\n\nFor hotel portfolio and catalogue workflow you can get a Customer API rol access token by using client credential **client Id** and **client secret**.\nEndpoint: https://catalogue.fastpayhotels.net/security/token\n**Example:** \"grant_type=client_credentials&scope=integrations_api&&client_id=example.customer.es&client_secret=wPEfpVQQDkRD3nbaktoR0g5a%2BXMfwBZvWv7wjGeKwVc%3D&version=1\n\nFor avail and real-time booking workflow you can get an Agency rol access token using user credentials  **username** and **password** and client credential **client Id** and **client secret**.\nEndpoint: https://avail.fastpayhotels.net/security/token \n**Note: The availability endpoint can be customized per customer.**\n**Example:** \"grant_type=password&username=username&password=password&client_id=example.customer.es&client_secret=wPEfpVQQDkRD3nbaktoR0g5a%2BXMfwBZvWv7wjGeKwVc%3D&version=1\"\n\n**To ensure max compatibility, make sure to use x-form-www-urlencoded post**\n\n**The access token is valid for one year.**\n\n\nThe Agency rol token can also access the hotel portfolio workflow too.\n\nCredentials and environment URLs will be provided by Fastpayhotels during development.\n\n\n\n **Cancellation Policies**\n \n Cancellation policy defines that penalty will be charged when a guest cancels the booking at certain advance time range. The penalty is related to No-show or a time range before check-in.\n \n Descriptive Penalty Type: when received as descriptive it means that we are working on codifying the penalty rules.\n \n **Time Range**\n \n No Show: The customer doesn’t cancel the booking or cancel it after arrival day. The first penalty without advance day is the penalty of no show.\nDeadline on arrival day or No-show: Many hotels have a deadline on arrival day and will apply different penalty when the customer cancel the booking after the deadline. The format of deadline is 4 AM/PM. Deadline always will appear after **#** Example: 100P_7D15P#3PM. If deadline does not appear, the default deadline time will be 12AM accommodation local time.\nAdvance day: The format is 1D, 2D, 7D or AD. 1D means 24 hours before ‘Deadline’. AD means unlimited advance day. \nAdvance hour: The time format is 1H,75H or 150H. Means X hours before ‘Deadline’.\nAdvance day and hour can be a time range: In this case is separate by a T. Example: 2DT1D10P.\nTimezone: The timezone of the deadline or advance day is accommodation local timezone.\n\n**Penalty Type**\n\nPercentage: will charge the percentage of: Booking Value 80P, Most expensive night MEN100P or Nights’ average AVG50P.\nAmount: will charge fix amount. The currency of this amount will be the same as booking rate. For example, 120, 245.75.\nNights: night fee to be charged. For example, 1N, 2N.\n\n**Examples**\n1. 100P_AD100P => Non Refundable.\n2. 0 or 0P or AD0_0 or AD0P_0P => Free cancellation.\n3. 100P_0D80P_1D70P_5D2N_AD0#9PM (Booking Date on 2021-03-01, check-in on 2021-08-10)\n  All advance day/hour penalty will apply after 9PM in accommodation Time Zone.\n  100P => is the penalty of no show. It means 100 percent of the whole stay will be charged if customer doesn't cancel the booking or doesn't arrive at hotel.\n  0D80P => defines the penalty between 9PM on arrival day (0D) and no show. It means 80 percent of whole stay will be charge if booking is cancelled after 9PM, 2021-08-10.\n  1D70P => define the penalty between 9PM, 2021-08-09 and 9PM, 2021-08-10. It means 70 percent of whole stay will be charged.\n  5D2N => defines the penalty between 9PM, 2021-08-05 and 9PM, 2021-08-09. It means 2 nights will be chargesd.\n  AD0 => defines the penalty between booking date and 9PM, 2021-08-05. Free cancellation.\n  \n  \n",
  "url": "https://raw.githubusercontent.com/jentic/jentic-public-apis/refs/heads/main/apis/openapi/swaggerhub.fastpayhotels/bookingapi/1.9.3/apis.json",
  "tags": [
    "swaggerhub.fastpayhotels",
    "bookingapi"
  ],
  "created": "2026-04-02",
  "modified": "2026-04-02",
  "specificationVersion": "0.19",
  "access": "3rd-Party",
  "maintainers": [
    {
      "FN": "Jentic",
      "X-github": "jentic",
      "url": "https://github.com/jentic"
    }
  ],
  "apis": [
    {
      "aid": "swaggerhub.fastpayhotels:bookingapi-1.9.3",
      "name": "Fastpayhotels Booking API",
      "description": "\nFastpayhotels Booking API is a specification designed for API integration customers in order to connect to Fastpayhotels Booking Engine System. \n\n  # **What's new in 1.9.3 version?**\n- **Availability in local currency**\n  - Customers can now see hotel availability and book in the local currency of the hotel. (Previous authorisation is required)\n  - See #/definitions/options\n  \n- **Payment details**\n  - Customer capability to send VCC payment details in booking request. (Previous authorisation is required)     \n  - See #/definitions/payment\n\n# **What's new in 1.9.2 version?**\n\n- **RatePlan details**\n  - New property ratePlanDetails: Contains detailed descriptive info for ratePlan selected\n  - See #availRoomRate/ratePlanDetails\n\n\n# **What's new in 1.9.1 version?**\n\n- **Nearby Airport IATA Code added to hotelDetails API request**\n  - See #hotelInfo/location node to find new IATA info for hotel nearby airport.\n\n# **What's new in 1.9.0 version?**\n\n- **Destination and supplier Taxes:**\n  - Now all rates will include hotel taxes information with total transparency.\n  - Public price will be updated with taxes not already included in base price.\n- **Special Requests:**\n  - Customers now have the capability to include special requests for their guests during Reservation step.\n  \n# **What's new in 1.8.0 version?**\n\n- **Booking avail response message.**\n  - Add a new field called **ratePlanCode**.\n  - Add a new field called **ratePlanName**.\n- **Booking book response message.**\n  - Add a new field called **ratePlanCode**.\n  - Add a new field called **ratePlanName**.\n  - Add a new field called **name**.\n  \n# **Workflows**\n\nFastpayhotels Booking API has three main workflows, hotel portfolio and catalogue, availability queries, and real time booking methods.\n\nThese three workflows are hosted in different URL endpoints so implementors should take into account that different security token retrieval must be performend for each workflow\n\n\nAs per development integration phase, URL endpoints would be:\n\n- Portfolio and catalogue endpoint: *https://catalogue.fastpayhotels.net/api*\n- Availability requests endpoint: *https://avail.fastpayhotels.net/api*\n- Booking engine access endpoint: *https://booking.fastpayhotels.net/api*\n\n\n**Mandatory HTTPS protocol**\nAll request to API must be performed through https:// protocol\n\n\n\n**Security based on OAuth 2.0 technology**.\nThe API has two main roles **Customer API** and **Agency** and the authentication protocol is token-based.\nOnce you get a valid token, you retain access as long as the token remains valid. \nThe token is invalidated if the access credentials change or the token expires.\n\n**Authentication URL:** .../security/token\n\nFor hotel portfolio and catalogue workflow you can get a Customer API rol access token by using client credential **client Id** and **client secret**.\nEndpoint: https://catalogue.fastpayhotels.net/security/token\n**Example:** \"grant_type=client_credentials&scope=integrations_api&&client_id=example.customer.es&client_secret=wPEfpVQQDkRD3nbaktoR0g5a%2BXMfwBZvWv7wjGeKwVc%3D&version=1\n\nFor avail and real-time booking workflow you can get an Agency rol access token using user credentials  **username** and **password** and client credential **client Id** and **client secret**.\nEndpoint: https://avail.fastpayhotels.net/security/token \n**Note: The availability endpoint can be customized per customer.**\n**Example:** \"grant_type=password&username=username&password=password&client_id=example.customer.es&client_secret=wPEfpVQQDkRD3nbaktoR0g5a%2BXMfwBZvWv7wjGeKwVc%3D&version=1\"\n\n**To ensure max compatibility, make sure to use x-form-www-urlencoded post**\n\n**The access token is valid for one year.**\n\n\nThe Agency rol token can also access the hotel portfolio workflow too.\n\nCredentials and environment URLs will be provided by Fastpayhotels during development.\n\n\n\n **Cancellation Policies**\n \n Cancellation policy defines that penalty will be charged when a guest cancels the booking at certain advance time range. The penalty is related to No-show or a time range before check-in.\n \n Descriptive Penalty Type: when received as descriptive it means that we are working on codifying the penalty rules.\n \n **Time Range**\n \n No Show: The customer doesn’t cancel the booking or cancel it after arrival day. The first penalty without advance day is the penalty of no show.\nDeadline on arrival day or No-show: Many hotels have a deadline on arrival day and will apply different penalty when the customer cancel the booking after the deadline. The format of deadline is 4 AM/PM. Deadline always will appear after **#** Example: 100P_7D15P#3PM. If deadline does not appear, the default deadline time will be 12AM accommodation local time.\nAdvance day: The format is 1D, 2D, 7D or AD. 1D means 24 hours before ‘Deadline’. AD means unlimited advance day. \nAdvance hour: The time format is 1H,75H or 150H. Means X hours before ‘Deadline’.\nAdvance day and hour can be a time range: In this case is separate by a T. Example: 2DT1D10P.\nTimezone: The timezone of the deadline or advance day is accommodation local timezone.\n\n**Penalty Type**\n\nPercentage: will charge the percentage of: Booking Value 80P, Most expensive night MEN100P or Nights’ average AVG50P.\nAmount: will charge fix amount. The currency of this amount will be the same as booking rate. For example, 120, 245.75.\nNights: night fee to be charged. For example, 1N, 2N.\n\n**Examples**\n1. 100P_AD100P => Non Refundable.\n2. 0 or 0P or AD0_0 or AD0P_0P => Free cancellation.\n3. 100P_0D80P_1D70P_5D2N_AD0#9PM (Booking Date on 2021-03-01, check-in on 2021-08-10)\n  All advance day/hour penalty will apply after 9PM in accommodation Time Zone.\n  100P => is the penalty of no show. It means 100 percent of the whole stay will be charged if customer doesn't cancel the booking or doesn't arrive at hotel.\n  0D80P => defines the penalty between 9PM on arrival day (0D) and no show. It means 80 percent of whole stay will be charge if booking is cancelled after 9PM, 2021-08-10.\n  1D70P => define the penalty between 9PM, 2021-08-09 and 9PM, 2021-08-10. It means 70 percent of whole stay will be charged.\n  5D2N => defines the penalty between 9PM, 2021-08-05 and 9PM, 2021-08-09. It means 2 nights will be chargesd.\n  AD0 => defines the penalty between booking date and 9PM, 2021-08-05. Free cancellation.\n  \n  \n",
      "image": "",
      "baseURL": "https://virtserver.swaggerhub.com/fastpayhotels/BookingAPI/1.5.0",
      "humanURL": "https://github.com/jentic/jentic-public-apis/tree/main/apis/openapi/swaggerhub.fastpayhotels/bookingapi/1.9.3",
      "version": "1.9.3",
      "tags": [
        "swaggerhub.fastpayhotels",
        "bookingapi"
      ],
      "properties": [
        {
          "type": "OpenAPI",
          "name": "OpenAPI definition",
          "url": "https://raw.githubusercontent.com/jentic/jentic-public-apis/refs/heads/main/apis/openapi/swaggerhub.fastpayhotels/bookingapi/1.9.3/openapi.json",
          "mediaType": "application/openapi+json"
        },
        {
          "type": "GitHubRepo",
          "url": "https://github.com/jentic/jentic-public-apis/tree/main/apis/openapi/swaggerhub.fastpayhotels/bookingapi/1.9.3"
        }
      ],
      "contact": [
        {
          "FN": "with Fastpayhotels",
          "email": "boarding@fastpayhotels.com"
        }
      ]
    }
  ]
}