Checking the onboarding request status

Copy

• Copy for LLM

  Copy page as Markdown for LLMs
• View as Markdown

  Open this page as Markdown
• Open in ChatGPT

  Get insights from ChatGPT
• Open in Claude

  Get insights from Claude
• Connect to Cursor

  Install MCP server on Cursor
• Connect to VS Code

  Install MCP server on VS Code

The Payments Configuration Status API allows you to check the status of your Payments by Booking onboarding or configuration change request.

Required connection type

You need to be connected with the Payments by Booking.com onboarding connection type to use this API.

For more information on the connection types, see Connections API Overview.

To simplify the process of setting up a connection between Booking.com and your platform, you can use Quick Connect.

With Quick Connect, you can request to connect a property directly from your interface. You can use it for already connected properties and for newly connecting properties. For more information, see this deck.

Ways to check the status

POST https://payments-api.booking.com/connectivity-payments/pbb/configurations/status

You can check the status of the request by using either:

• Request ID – in case a configuration has already been accepted (you've received a notification that the given configuration has been ACCEPTED or a response from calling the Payments Configuration API that the configuration has been ACCEPTED), or
• Property ID – to check the status of an individual property, or a set of properties in case you submitted multiple requests for different properties belonging to the same legal ID.

The API only returns information for requests that were successfully validated and accepted for processing. Therefore:

• In case request_id is used in the request, the API returns the latest status of all the ACCEPTED requests, if available.

• In case property_ids is used in the request, the API returns the latest status of the most recently ACCEPTED request for the given property, if available.

Example request: using request ID

{
   "property_ids": [],
   "request_id": "681fb7d4-a469-470a-b105-faba177bfc57",
   "kyc_callback_url": "https://www.google.com"
}

Example request: using property IDs

{
    "property_ids": ["1234567","7654321"],
    "request_id": null,
    "kyc_callback_url": "https://www.google.com"
}

Request elements

The following table describes the request elements:

Headers

Response example

The response structure is identical for both request methods:

{
  "meta": {
    "ruid": "9693efa1-fda3-407f-a700-62fa67bbe4e2"
  },
  "data": {
    "config_update_details": [
      {
        "property_id": "1234567",
        "request_id": "681fb7d4-a469-470a-b105-faba177bfc57",
        "status": "WAITING",
        "requested_at": "2025-05-02",
        "actions": [
          {
           "reference": "https://connect.stripe.com/setup/c/acct_123/abc",
           "type": "SUBMIT_KYC"
          }
        ]
      },
      {
        "property_id": "7654321",
        "request_id": "1f11033b-7d11-65b3-acb0-7108ea9d653b",
        "status": "IN_PROGRESS",
        "requested_at": "2025-05-01",
        "actions": []
      }
    ]
  },
  "errors": [],
  "warnings": []
}

Response headers

Response elements

The following table describes the response elements:

Request statuses

Request rejection reasons

Rate limiting

To prevent excessive load on our systems, we limit the number of API calls that a provider can make per minute. For the Payments Configuration Status API, the limit is 30 requests per minute.

Response codes

This table lists and describes the response codes that the API can return.