This page lists the supported versions and a description of their behaviour. A newer version includes the behaviour of all previous versions.
By default, the API returns the latest version (currently 1.1) response format. If you want to keep the previous behavior until you're ready to migrate, specify accept-version: 1.0 in your request header.
This version introduces a few new, backward‑compatible fields so partners can see a more detailed payout and charges breakdown for Payments by Booking:
Separated commissions vs payment charges:
partner_payout.commissions_and_charges.breakdownincludes distincttotal_commissionsandtotal_charges.Applicable rate on charges (
applicable_rate): exposes the actual rate (e.g. tax %) used to calculate each charge.Applicable type on charges (
applicable_type): indicates how a charge applies (e.g. per person or per night).Bank transfer indentifier to track the payout: a
bank_transfer_referencefield is included per bank transfer payout so partners can tie payout information in the API to actual bank transfer payouts.
The version also introduces a payment_tags field that indicates the payment type and collection method for a reservation (e.g. PAYMENTS_BY_BOOKING).
Note: a new customer_credit_cards field is reserved for future Payments API updates.
For more information, see Managing payment and payout details.
This is the initial version.