Booking.com Payments by Booking Onboarding API

openapi: 3.0.1
info:
  title: Payments by Booking Onboarding API
  description: Manage Payments by Booking onboarding configurations, check property eligibility for different payout options,
    and monitor the processing status of configuration update requests.
  contact:
    name: Connectivity Team
    url: https://connect.booking.com
    email: connectivity@booking.com
  version: '1.0'
servers:
- url: https://payments-by-booking-onboarding-api.wiremockapi.cloud/
  description: Mock (stateful simulator)
- url: https://payments-api.booking.com/
  description: Production
security:
- bearerAuth: []
tags:
- name: About Try it
  description: "Learn how to effectively use the Try it feature in the Payments by Booking Onboarding 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\
    ## Environment\nYou can select between three 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)\n- Environment\
    \ for testing without affecting live/test data\n\n**Mock (stateful simulator)**:\n- Get realistic, stateful response data\
    \ from a mock API\n- Recommended for all write operations (POST)\n- Environment for testing without affecting live/test\
    \ data\n\n**Production**:\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 and response body. Where\
    \ the specification supports multiple request and response body examples, you can choose a different request or response\
    \ body from the drop-down list.\n\nSome helpful pointers before running a request:\n\n- **Authentication** (when using\
    \ Production): Configure your authentication headers\n  - OAuth Bearer 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- **Request body**: Fill in required fields\n  - Property IDs (like `property_ids`)\n\
    \  - Legal entity IDs or request IDs where applicable\n\n- **Execute**: Click **Send** to send the request\n  - The request\
    \ is sent to the selected environment\n  - When sending requests to Production, 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## Simulating error responses\n\nWhen using the **Mock\
    \ (stateful simulator)** environment, you can simulate authentication and server error responses by setting specific values\
    \ in the `Authorization` header:\n\n| Error | Authorization header value | Description |\n|-------|---------------------------|-------------|\n\
    | 403 Forbidden | `Bearer invalid-scope-token` | Simulates a token without the required scope/permissions |\n| 500 Internal\
    \ Server Error | `Bearer trigger-500-test` | Simulates an internal server error |\n\nTo set the Authorization header:\n\
    1. Select the request example for the error you want to trigger (e.g., \"Trigger 403\" or \"Trigger 500\")\n2. In the\
    \ **Authorization** section, set the header value as shown above\n3. Click **Send** to execute the request\n\n## Common\
    \ issues\n\n- **401 Unauthorized**: Check your credentials\n- **403 Forbidden**: Verify access permissions\n- **404 Not\
    \ Found**: Confirm the request ID exists (status endpoint only)\n- **429 Too Many Requests**: Rate limit exceeded (max\
    \ 30 requests per minute)"
- name: Payments eligibility details for partners
  description: Retrieve payments eligibility details for partners.
- name: Payments by Booking configurations
  description: Update Payments by Booking payout configurations for properties.
- name: Payments by Booking configurations status
  description: Check the processing status of Payments by Booking configuration update requests.
x-tagGroups:
- name: API Endpoints
  tags:
  - Payments eligibility details for partners
  - Payments by Booking configurations
  - Payments by Booking configurations status
- name: Documentation
  tags:


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