The API functionality is in closed beta phase. Currently, the closed beta is available only for select providers. Make sure to direct any questions during the beta phase to your Booking.com contact person via the appropriate channels.
To start receiving notifications, follow the instructions from the Notification service documentation.
Once the payout report is ready, you will receive a RECONCILIATION_REPORT_STATUS notification with the status set to READY. From this notification, you can download the payout report using the download link.
Take these expiration times/dates into account:
- Download link: Valid for 15 minutes. To download a report after this time, you need to request a new link.
- Report request: Identical report requests are cached for 1 hour. If a report is requested with the same filters as the previous request within one hour, the previous report is returned (if
READY). If it's still generating, the API will return the statusGENERATING. A notification is sent only for the first identical report.
The RECONCILIATION_REPORT_STATUS notification has:
requestId: Specifies the identifier of the payout report request.reportStatus: Status of the report:READY,ERROR, orEMPTY.filename: Name of the payout report file (e.g.,report.json).downloadUrl: URL to download the reconciliation report.downloadUrlExpiresAt: Expiration time of the download URL.errorDetails: Details of the error ifreportStatusisERROR.
The fields filename, downloadUrl, and downloadUrlExpiresAt are only present when reportStatus is READY. For ERROR or EMPTY statuses, these fields are completely absent from the response.
Example:
{
"requestId": "string",
"reportStatus": "READY|ERROR|EMPTY",
"filename": "report.json",
"downloadUrl": "string",
"downloadUrlExpiresAt": "ISO-8601 timestamp",
"errorDetails": null
}