Skip to content

Payments API (1.0)

Retrieve payment and payout details for accommodation reservations, including partner payout information, breakdowns, bank transfer details, and VCC management.

Languages
Servers
Test static response
https://developers.booking.com/_mock/connectivity/docs/openapispecs/payments-api/payments-api-specification
Test using live endpoint
https://payments-api.booking.com

Reservation payout details

Retrieve detailed partner payout information for accommodation reservations.

Operations

Reservation breakdown

Retrieve detailed breakdown for accommodation reservations with respect to partner payout.

Operations

Bank transfer payout

Retrieve Bank Transfer payout details for accommodation reservations.

Operations

VCC payout details, per accommodation reservation

Provides VCC payout details for an accommodation reservation

Operations

VCCs to be charged

Provides information of the VCCs to be charged.

Operations

Refundable VCCs

Provides information of the refundable VCCs.

Operations

Reservation Status API

Provides reservation status information with respect to a reservation ID.

Operations

About Try it

Learn how to effectively use the Try it feature in the Payments API documentation.

Use the Try it feature to send test request examples to the API endpoints directly from the developer portal and depending on the selected environment either see static, pre-built responses or dynamic responses from a test property.

Request

Using the UI, toggle between Edit and Preview tabs to see the values applied to the path or query placeholders (if there are any). You can also click on any unresolved placeholders to add a value or edit an existing placeholder value.

The portal loads the default request body. Where the specification supports multiple request body examples (for example: Rooms API POST endpoint), you can choose a different request body from the drop-down list.

Some helpful pointers before running a request:

  • Authentication (when using live endpoint): Configure your authentication headers

    • API Key or OAuth token as required. Use the Environments tab.
    • Make sure to manage separate machine accounts for test vs. properties in production.
    • Ensure credentials match your selected environment.
  • Parameters: Fill in required parameters

    • Path parameters (like reservation-id)
  • Execute: Click Send to send the request

    • The request is sent to the selected environment
    • When sending requests to the live endpoint, the response will be a real response from the API.

Response

After executing a request, you will see:

  • Status code: HTTP response status
  • Response body: JSON response data
  • Headers: Response headers

Common issues

  • 401 Unauthorized: Check your credentials
  • 403 Forbidden: Verify access permissions
  • 404 Not Found: Confirm the reservation ID exists
  • 410 Gone: The checkout date is older than the allowed 18-months window