---
title: "Check payments eligibility"
method: POST
path: "/connectivity-payments/pbb/eligibility"
tags: ["Payments eligibility details for partners"]
---

# Check payments eligibility

`POST /connectivity-payments/pbb/eligibility`

## Request

- Base URL: `https://payments-by-booking-onboarding-api.wiremockapi.cloud`
- URL: `https://payments-by-booking-onboarding-api.wiremockapi.cloud/connectivity-payments/pbb/eligibility`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/booking/apis/payments-by-booking-onboarding-api/docs/connectivity-payments/pbb/eligibility/post.ts> (a function with typed inputs; its response is checked against the schema)

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 and any associated costs or restrictions.

## Headers

- `accept-version` string

## Request body

- PaymentsEligibilityRequest
  - `property_ids` integer[], required: <=10 property IDs per request.

## Response `200`

Request for eligibility accepted.

- PaymentsEligibilityResponse: Response containing payments eligibility information for the specified property IDs
  - `meta` DefaultMeta: Metadata for the response
    - `ruid` string: Request unique identifier
  - `data` PaymentsEligibilityModel: Data containing required information
    - `payout_configurations` PaymentsEligibility[]: Details about payout configurations for property_ids
      - `property_id` string: Property identifier
      - `legal_entity_id` string: Legal entity identifier
      - `current_payout_configuration` CurrentPayoutOption: Current payout configuration for a property
        - `payin_collection_strategy` string: Payin collection strategy. Possible values: PARTIAL, ALL.
        - `payout_method` string: The method by which Booking.com remits payments to the partner for this property. Possible values: VCC, BT, STRIPE.
        - `payout_frequency` string, nullable: How often payouts are executed to the partner for this property, as per the current configuration. Applies mainly when payout_method is 'BT'. Possible values: DAILY, WEEKLY, MONTHLY. For VCC, null is returned.
        - `payout_netting` string: Defines how commissions or payment-related costs are deducted directly from each payout. Possible values: GROSS, NET.
      - `payout_configuration_options` PayoutOption[]: List of other payout configuration options
        - `is_eligible` boolean: Indicates if this payout option is currently eligible
        - `payin_collection_strategy` string: Payin collection strategy. Possible values: PARTIAL, ALL.
        - `payout_method` string: The method by which Booking.com remits payments to the partner for this property. Possible values: VCC, BT, STRIPE.
        - `payout_frequency` string[]: Available payout frequencies for this option. Applies mainly when payout_method is 'BT'
        - `payout_netting` string[]: Defines how commissions or payment-related costs are deducted directly from each payout
        - `additional_requirements` AdditionalRequirement[]: List of additional requirements for this payout option
          - `name` string: Name of the requirement
          - `action` string: Action needed to complete the requirement
      - `vcc_activation_policy_code` string: VCC activation policy code
      - `bt_payout_cost_information` BTPayoutCostInformation: Bank transfer payout cost information
        - `value` string
        - `type` string
        - `decimals` integer
      - `is_config_update_supported_by_api` boolean: Indicates whether the property can be onboarded to Payments by Booking via the Payments Configuration API.
  - `errors` unknown[]
    - unknown
  - `warnings` unknown[]
    - unknown

## Other responses

- `400`: Invalid request payload.
- `401`: Unauthorized. Missing or invalid authentication token.
- `403`: Access Denied!
- `429`: Rate limit exceeded. Maximum 30 requests per minute.
- `500`: The request failed with an internal server error.

---

[API](https://skmtc.dev/booking/apis/payments-by-booking-onboarding-api.md) - [All operations](https://skmtc.dev/booking/apis/payments-by-booking-onboarding-api/llms.txt) - [OpenAPI document](https://skmtc.dev/booking/apis/payments-by-booking-onboarding-api/revisions/a0a3b004344f?raw)