Understanding the Payments API
The Payments API provides comprehensive payment and payout-related information.
You can get details on reservations with the checkout date in the last 18 months.
The Payments API is currently only applicable for properties who use the Payments by Booking.com (PbB) payment method and who have already implemented the Reservations API. To check if a reservation is a PbB one, see Receiving notifications.
Also, the API doesn't support Pay at Property (P@P) reservations where guests choose to pay for their accommodation upon arrival at the property rather than at the time of booking.
The API now supports Stripe as the payout method with no limitations.
What is possible with the Payments API?
| API category | Description | Notifications |
|---|---|---|
| Payments Details API | Provides comprehensive payout information for accommodation reservations, which includes the payout type, payout status along with additional payout information. It also provides a detailed price breakdown, a clear indication of what Booking.com needs to pay to the partner, and an estimated amount of what the partner needs to collect from the guest. | You receive a notification once an update is available and then query the respective endpoints. |
| Payments Refundable API | Provides information on refundable VCCs at property level. | You don't receive notifications and query the endpoint with the preferred frequency. |
| Payments Chargeable API | Provides information on chargeable VCCs at property level. | You don't receive notifications and query the endpoint with the preferred frequency. |
Notifications you receive
The notifications listed below are only sent if you integrated the notifications functionality as described in Receiving notifications.
We're sending notifications of these four types:
PAYOUT_UPDATEPAYOUT_METHOD_UPDATEVIRTUAL_CREDIT_CARD_UPDATEBANK_TRANSFER_UPDATE(Now supported for both gross and net payouts)
To learn more about the notification types and the endpoints associated with them, see Receiving notifications.
Main URL and use of shortened endpoint paths
The Payments 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 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
Before you go live with your Payments API integration, we recommend contacting your account manager or the Connectivity Support team.
Need help integrating with the Payments 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.