Skip to content
/
Receiving notifications
Last updated

Receiving notifications

To start receiving notifications, follow the instructions from the Notification service documentation.

A notification is sent when a status update is available regarding the Payments by Booking onboarding process or the payout configuration change request for the given property (or a group of properties).

Upon receiving the notification, you can call the Payments Configuration Status API using the requestId or propertyId parameter to fetch the latest status and any additional requirements.

Notification details

The PBB_CONFIG_UPDATE_STATUS notification has the following two elements:

  • Metadata: Describes the payload type, UUID, as well as any other information that might be relevant for processing the notification.
  • Payload: Represents the actionable notification content. It's different for each type of notification message.
Notifications sent per property

For onboarding or configuration change requests, a separate notification is sent for each individual property once its status changes.

metadata:

  • uuid: Stores the UUID for this notification. Useful when contacting Connectivity Support Executives to inquire about a given message.

  • type: Type of the message.

  • payloadVersion: Version of the payload JSON element. 1.0 for now, subject to change.

payload:

  • propertyId: Refers to the Booking.com ID of the property for which an onboarding request was sent or a configuration change was requested.

  • requestId: Unique identifier for the specific onboarding or configuration change request in ACCEPTED state. For bulk requests, this corresponds to the request_id of an ACCEPTED configuration that the given propertyId is part of.

  • activationStatus: Current status of the request: WAITING, SUCCESSFUL, or FAILED.

  • configurationChangeAt: The timestamp indicating when the status change actually occurred in the system, in ISO-8601 format (UTC).

  • timestamp: Timestamp in which the notification was triggered and sent, in ISO-8601 format (UTC).

Activation statuses

Notifications are sent for these statuses:

StatusMeaningAction required
WAITINGThe onboarding process requires an action from the partner (e.g. SUBMIT_KYC).Use the Payments Configuration Status API to learn more.
SUCCESSFULThe property has been successfully onboarded to Payments by Booking. The configuration is now active.None. You can now manage payments for this property via the Payments API.
FAILEDThe onboarding or configuration change request could not be completed.Retry or reach out to the Connectivity Support team.

Example:

{
  "metadata": {
    "uuid": "FC70575E-ED0E-11EE-B5FA-B675273ACEB0",
    "type": "PBB_CONFIG_UPDATE_STATUS",
    "payloadVersion": "1.0"
  },
  "payload": {
    "timestamp": "2025-08-10T10:10:32Z",
    "propertyId": 10345,
    "requestId": "1f09952e-00b2-6578-abff-b723490a38d8",
    "activationStatus": "SUCCESSFUL"
    "configurationChangedAt": "2025-08-10T09:10:00Z"
  }
}
Previous page
Next page