Skip to content
/
Reservation payout detail...

Payments API (1.0)

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

Download OpenAPI description
payments-api-specification.json
payments-api-specification.yaml
Overview
URL
https://connect.booking.com
Connectivity Team
connectivity@booking.com
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

Get payout details for a reservation

Request

Retrieve payout details for a reservation, including the estimated amount to be collected at the property, payout status and amount, commissions and charges, VCC or bank transfer payout details, and price breakdown.

Path
reservation-idintegerrequired

The unique identifier of the reservation.

Headers
accept-versionstring

API version to use.

Authorizationstringrequired

Bearer token for authentication.

Example: Bearer <your_token>
curl -i -X GET \
  'https://developers.booking.com/_mock/connectivity/docs/openapispecs/payments-api/payments-api-specification/connectivity-payments/reservations/{reservation-id}' \
  -H 'Authorization: Bearer <your_token>' \
  -H 'accept-version: string'

Responses

Successfully retrieved payout details including the estimated amount to be collected at the property, payout status and amount, commissions and charges, VCC or bank transfer payout details, and price breakdown.

Bodyapplication/json
metaobject

Response metadata

dataobject

Payout details

errorsArray of any<= 0 items
warningsArray of any<= 0 items
Response
application/json
{
  "meta": {
    "ruid": "string"
  },
  "data": {
    "reservation_id": "string",
    "property_id": "string",
    "payout_type": "string",
    "payout_status": "string",
    "payment_tags": [ … ],
    "total_price_of_reservation": { … },
    "partner_payout": { … },
    "payout": { … },
    "price_breakdown": [ … ]
  },
  "errors": [],
  "warnings": []
}

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.