Skip to content

Understanding the Payments by Booking Onboarding API

One of the services that Booking.com offers to accommodation partners is Payments by Booking. By managing partner's online payments, Booking.com helps them streamline operations and reach more guests. While joining Payments by Booking is optional, which means the partner can choose to receive payments directly from guests, it offers great benefits, such as revenue security and fewer cancellations.

The Payments by Booking Onboarding API facilitates the experience of onboarding to Payments by Booking. This functionality was previously only available through Extranet.

Only fresh onboarding is supported

The Payments by Booking Onboarding API currently only supports properties that have never been enrolled in Payments by Booking.

Read FAQs about Payments by Booking

We strongly recommend that you go through the FAQs about Payments by Booking before proceeding with the Onboarding API. The FAQs answer important questions that are not covered in this documentation.

Design your onboarding flow

Want to create an intuitive onboarding experience for the partners? Check out our tutorial on designing the Payments by Booking onboarding flow, which includes mockups from Booking.com's Extranet showing how the flow works for bank transfers and virtual credit cards.

What is possible with the API?

✔ See if the given property is eligible to enroll to Payments by Booking and which payout methods are available along with their fee. For properties that are already on Payments by Booking, this API shows the current payout configuration. See the Eligibility API for more information.

✔ Send a request to onboard the given property to Payments by Booking with the preferred payout method and the preferred payout timing. See the Payments Configuration API for more information.

✔ Send a request to change the payout configuration of a property that's already enrolled to Payments by Booking. Currently, it's only possible to change the payout frequency for the properties that use bank transfers as the payout method. See the Payments Configuration API for more information.

✔ Receive a notification when a status update is available regarding the Payments by Booking onboarding process or the payout configuration change request for the given property. See Receiving notifications for more information.

✔ Check the status of the onboarding or configuration change request for a given property. See the Payments Configuration Status API for more information.

Main URL and use of shortened endpoint paths

The Payments by Booking Onboarding API's main URL is https://payments-api.booking.com. All shortened endpoint paths imply that you must add the main URL.

Authentication

The Payments by Booking Onboarding API uses the same authentication methods as other APIs.

Going live

Before you go live with your API integration, you'll need to meet certain requirements. For more information, see Going Live.

Contact us

Need help integrating with the Payments by Booking Onboarding API? The experts in our Connectivity Support team are here to help.

Do you want us to improve this page? Click Yes | No in the Was this page helpful? box at the bottom of this page.