Booking.com Payments API

openapi: 3.0.1
info:
  title: Payments API
  description: Retrieve payment and payout details for accommodation reservations, including partner payout information, breakdowns,
    bank transfer details, and VCC management.
  contact:
    name: Connectivity Team
    url: https://connect.booking.com
    email: connectivity@booking.com
  version: '1.0'
servers:
- url: https://payments-api.booking.com/
  description: Test using live endpoint
tags:
- name: About Try it
  description: "Learn how to effectively use the Try it feature in the Payments API documentation.\n\nUse the **Try it** feature\
    \ to send sample requests to API endpoints directly from the developer portal. In the **Mock (schema only)** environment,\
    \ Try it returns schema-driven mock responses or pre-built example responses. In the **Production** environment, it sends\
    \ the request to the live API and returns dynamic responses from your selected test property.\n\n## Environment\n\nYou\
    \ can select between two different environments (top right corner in the UI):\n\n**Mock (schema only)** (default):\n-\
    \ Helps to understand the response data schema\n- Recommended for all write operations (POST, PUT, DELETE)\n- Environment\
    \ for testing without affecting live/test data\n\n**Test live endpoint**:\n- Make sure to use only test properties.\n\
    - Changes will affect your test property data\n- Requires valid credentials\n- Same API structure as production\n\n##\
    \ Request\n\nYou can click on any unresolved placeholders to add a value or edit an existing placeholder value.\n\nThe\
    \ 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.\n\nSome helpful pointers\
    \ before running a request:\n\n- **Authentication** (when using live endpoint): Configure your authentication headers\n\
    \  - API Key or OAuth token as required. Use the **Environments** tab.\n  - Make sure to manage separate machine accounts\
    \ for test vs. properties in production.\n  - Ensure credentials match your selected environment.\n\n- **Parameters**:\
    \ Fill in required parameters\n  - Path parameters (like `reservation-id`)\n\n- **Execute**: Click **Send** to send the\
    \ request\n  - The request is sent to the selected environment\n  - When sending requests to the live endpoint, the response\
    \ will be a real response from the API.\n\n## Response\n\nAfter executing a request, you will see:\n\n- **Status code**:\
    \ HTTP response status\n- **Response body**: JSON response data\n- **Headers**: Response headers\n\n## Common issues\n\
    \n- **401 Unauthorized**: Check your credentials\n- **403 Forbidden**: Verify access permissions\n- **404 Not Found**:\
    \ Confirm the reservation ID exists\n- **410 Gone**: The checkout date is older than the allowed 18-months window"
- name: Reservation payout details
  description: Retrieve detailed partner payout information for accommodation reservations.
- name: Reservation breakdown
  description: Retrieve detailed breakdown for accommodation reservations with respect to partner payout.
- name: Bank transfer payout
  description: Retrieve Bank Transfer payout details for accommodation reservations.
- name: VCC payout details, per accommodation reservation
  description: Provides VCC payout details for an accommodation reservation
- name: VCCs to be charged
  description: Provides information of the VCCs to be charged.
- name: Refundable VCCs
  description: Provides information of the refundable VCCs.
- name: Reservation Status API
  description: Provides reservation status information with respect to a reservation ID.
x-tagGroups:
- name: API Endpoints
  tags:
  - Reservation payout details
  - Reservation breakdown
  - Bank transfer payout
  - VCC payout details, per accommodation reservation
  - VCCs to be charged
  - Refundable VCCs
  - Reservation Status API
- name: Documentation
  tags:


# --- truncated at 32 KB (49 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/booking-com/refs/heads/main/openapi/booking-com-payments-api-openapi.yml