Skip to navigation
Hotel APIHotels

Get checkout data

Retrieves traveler profile and payment information.

Use case

This endpoint can be used on a reservation check-out page to allow users to view their profile and payment information prior to booking. The response includes the traveler name, default billing address, hotel brand loyalty program, hotel preference, payment methods and some other data that can be used on checkout.

What’s next?

The payment information in the response can be displayed on a payment/checkout page. The next step is to book the hotel via the book endpoint.

Path parameters

versionstringRequired

Headers

AuthorizationstringOptional

Request signature for authentication. Format: Signature YOUR_SIGNATURE. Calculated using HMAC-SHA256 with your secret key.

Query parameters

api_keystringOptional

Your public API key. Example: api_key=testkey.

timestampstringOptional

The UNIX (UTC) timestamp created by your application for this request (in seconds). Must be within 2.5 minutes of the current time.

noncestringOptional
A unique cryptographic identifier created by your application to secure the request. Must be 32 characters or less and cannot be reused within 5 minutes.
localestringOptional

The language preference of your user. Valid values: en_US, fr_FR, de_DE, es_ES, it_IT, pt_PT, ja_JP, ko_KR. Default is en_US.

customer_ipstringOptional
The IP address of your user. Allows determination of the user's location for fraud recovery and analytics purposes.
session_idstringOptional
A unique user session identifier created by your application. Do not use the real user's session identifier. Allows identification of all requests throughout a user session for error handling and troubleshooting.
user_agentstringOptional

The user agent (device, application or browser) of your user. Allows retrieval of mobile rates and discounts from some providers. Must be properly encoded. Max 32 characters. Required to get discounted mobile rates.

configuration_idintegerOptional

Configuration ID for proper company settings. Obtain via the get_configurations endpoint.

systemstringOptional

The booking channel. Valid values include: aft, obt, web.

accepted_credit_cardsstringOptional
checkoutstringOptional
internal_traveler_idintegerOptional
paid_policystringOptional
sso_saml_artstringOptional
sso_urlstringOptional
tspm_company_iddoubleOptional
tspm_traveler_iddoubleOptional