1. Create an experience checkout session (PREBOOK)

Overview

Create a temporary hold on the selected tour slot and a Stripe PaymentIntent for checkout. If your account has an enabled credit line with payment bypass, you can instead pass usePaymentSdk: false to skip Stripe entirely and hold the slot for a credit-line booking.

When to Use

  • Checkout start — After the user picks option, slot, and participants from booking-options
  • Payment setup — Obtain transactionId and secretKey for Stripe SDK confirmation
  • Hold window — Reserve inventory for ~10 minutes before book

What You Get

  • Checkout context — tourId, optionId, dateTime, language, participants, and pricing echoed back
  • Reservation references — cartId, experienceBookingId, providerBookingId, status, reservationExpiresAt
  • Stripe fields — transactionId, secretKey, and paymentTypes including TRANSACTION_ID when usePaymentSdk is true
  • Credit line (alongside Stripe) — creditLine.remainingCredit and CREDIT in paymentTypes when usePaymentSdk is true, the account has an enabled credit line with payment bypass, and the remaining credit covers this prebook. The Stripe intent is still created; book with either method
  • Credit line (no Stripe) — Pass usePaymentSdk: false instead to skip Stripe entirely. This requires an enabled credit line with payment bypass on the account, otherwise the request is rejected with 400. Stripe fields are omitted and paymentTypes returns ["CREDIT"] only

Quick Start

POST the same selection used for display pricing from booking-options with usePaymentSdk: true. Confirm payment with Stripe, then call POST /experiences/bookings with payment.method: TRANSACTION_ID. If the response includes CREDIT in paymentTypes, you may instead call book with payment.method: CREDIT and skip Stripe confirmation.

If your account has an enabled credit line and you'd rather skip Stripe from the start, POST with usePaymentSdk: false and call book with payment.method: CREDIT.

Error codes

Product-operation codes are listed below. Authentication, access and rate-limit errors can use common codes such as 401, 40301 or 4290. HTTP status and error code are separate; do not parse message text.

CodeMeaning
72001selection price mismatch
72002invalid experience selection
72003prebook resource not found
72004experience selection rejected
72005experience prebook conflicts with the current state
72006prebook request failed
72007prebook request timed out
72008prebook request is unauthorized
72009prebook request is forbidden
72010prebook is temporarily unavailable
72011booking currency is not accepted for this selection
72099failed to create prebook

For 72001, requested/expected are customer SELL totals; do not apply markup or FX again. Inspect the code on HTTP 400, 409 and 422. A generic no-money error must not open price-change consent.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Tour identifier

Body Params
selection
object
required
string
enum
required

Preferred language for prebook and booking content.

string
required

ISO 4217 currency code for the prebook and booking. See GET /data/currencies for the list of currently supported codes.

string

Partner reference echoed in prebook response and stored on the checkout session.

boolean
required

Phase 1 requires true to create a Stripe PaymentIntent.

string

Optional discount voucher code. When valid the voucher amount is deducted from the Stripe PaymentIntent and charged separately to the agency's stored card at book time.

payment
object

Optional Stripe metadata (e.g. statement descriptor suffix).

Responses

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