Get the hotel voucher

Get the voucher PDFs of a hotel booking: the confirmation to hand to the traveler, with the price for you and without it for the traveler. Only the agency that owns the booking can read its voucher.

Permission: Read

Request

GET /api/v1/hotels/get_voucher

curl 'https://api.fx-port.com/api/v1/hotels/get_voucher?booking_id=HMVXX4ZQ3' \
  -H "Authorization: Bearer fxp_test_YOUR_KEY"

Legacy names

These older spellings still work. The answer carries a deprecated_field warning that names the spelling to use (see Legacy names).

Response

A real answer of the sandbox (the links are replaced):

{
  "environment": "sandbox",
  "success": true,
  "data": {
    "bookingId": "HMVXX4ZQ3",
    "voucherUrl": "https://files.example.com/hotel-bookings/HMVXX4ZQ3-Jane-Smith.pdf",
    "voucherUrlWithPrice": "https://files.example.com/hotel-bookings/HMVXX4ZQ3-Jane-Smith.pdf",
    "voucherUrlNoPrice": "https://files.example.com/hotel-bookings/HMVXX4ZQ3-Jane-Smith-no-price.pdf",
    "status": "confirmed"
  }
}

Both variants are made for every confirmed booking. The same links are in the answer of the booking detail (voucherUrl, voucherUrlNoPrice): use whichever call fits your flow, get_voucher is the lighter one when you only need the link.

When the voucher exists

The voucher is made after the booking is confirmed: at the same moment, or up to about 10 seconds later. Before that the call answers 404 with the code pdf_not_found. So:

1. Poll the booking until it is confirmed.
2. Ask for the voucher; on 404 pdf_not_found, wait 2 seconds and ask again, up to about 10 times.

• A booking that is still pending has no voucher.
• The links stay after a cancellation: the voucher of a cancelled booking is still returned, so do not hand it out again.

The links are public

The links are permanent public addresses with no signature and no expiry: anyone who has one can open the voucher, without a key. The file name is <booking id>-<first name>-<last name>.pdf, so it contains the name of the first guest.

• Do not log them, post them in a ticket or send them to anybody who is not the traveler or your own staff.
• Give the traveler voucherUrlNoPrice; keep voucherUrl for your agency.
• Fetch the link again from this call when you need it rather than storing it in many places.

Errors

Related