# Payments by Booking Onboarding API

Manage Payments by Booking onboarding configurations, check property eligibility for different payout options, and monitor the processing status of configuration update requests.

Version: 1.0

## Servers

Mock (stateful simulator)
```
https://payments-by-booking-onboarding-api.wiremockapi.cloud/
```

Production
```
https://payments-api.booking.com/
```

## Security

### bearerAuth

Bearer token for authentication. Use your API credentials to obtain a token.

Type: http
Scheme: bearer

## Download OpenAPI description

 - [Payments by Booking Onboarding API](https://developers.booking.com/_bundle/connectivity/docs/openapispecs/payments-by-booking-onboarding-api/pbb-onboarding-api-specification.yaml)

## Payments eligibility details for partners

 - [POST /connectivity-payments/pbb/eligibility](https://developers.booking.com/connectivity/docs/openapispecs/payments-by-booking-onboarding-api/pbb-onboarding-api-specification/payments-eligibility-details-for-partners/checkpaymentseligibility.md): Performs a bulk eligibility evaluation for a list of properties (property_ids) by returning their current payout configurations along with all available payout options, including eligibility metadata
## Payments by Booking configurations

 - [POST /connectivity-payments/pbb/configurations](https://developers.booking.com/connectivity/docs/openapispecs/payments-by-booking-onboarding-api/pbb-onboarding-api-specification/payments-by-booking-configurations/updatepbbconfigurations.md): Updates Payments by Booking configurations and returns processing status
## Payments by Booking configurations status

 - [POST /connectivity-payments/pbb/configurations/status](https://developers.booking.com/connectivity/docs/openapispecs/payments-by-booking-onboarding-api/pbb-onboarding-api-specification/payments-by-booking-configurations-status/fetchacceptedpbbconfigurationupdaterequestsstatus.md): Checks the processing status of Payments by Booking configuration update requests for given property IDs or a request ID.
## About Try it

 - [Environment](https://developers.booking.com/connectivity/docs/openapispecs/payments-by-booking-onboarding-api/pbb-onboarding-api-specification/about-try-it/environment.md): ## Environment You can select between three different environments (top right corner in the UI): **Mock (schema only)** (default): - Helps to understand the response data schema - Recommended for all
 - [Request](https://developers.booking.com/connectivity/docs/openapispecs/payments-by-booking-onboarding-api/pbb-onboarding-api-specification/about-try-it/request.md): ## Request You can click on any unresolved placeholders to add a value or edit an existing placeholder value. The portal loads the default request and response body. Where the specification supports m
 - [Response](https://developers.booking.com/connectivity/docs/openapispecs/payments-by-booking-onboarding-api/pbb-onboarding-api-specification/about-try-it/response.md): ## Response After executing a request, you will see: - **Status code**: HTTP response status - **Response body**: JSON response data - **Headers**: Response headers
 - [Simulating error responses](https://developers.booking.com/connectivity/docs/openapispecs/payments-by-booking-onboarding-api/pbb-onboarding-api-specification/about-try-it/simulating-error-responses.md): ## Simulating error responses When using the **Mock (stateful simulator)** environment, you can simulate authentication and server error responses by setting specific values in the `Authorization` hea
 - [Common issues](https://developers.booking.com/connectivity/docs/openapispecs/payments-by-booking-onboarding-api/pbb-onboarding-api-specification/about-try-it/common-issues.md): ## Common issues - **401 Unauthorized**: Check your credentials - **403 Forbidden**: Verify access permissions - **404 Not Found**: Confirm the request ID exists (status endpoint only) - **429 Too Man