Requesting a payout report

POST https://payments-api.booking.com/connectivity-payments/recon-reports

The Report API allows you to request a payout report for a given property or a list of properties belonging to the same legal owner (same legal ID). To request a report, you first need to get the list of applicable filters for the given legal entity ID using the Filters API.

You need to be connected with the reservations connection type to use this API.

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

Take these expiration times/dates into account:

• 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 status GENERATING.

The API supports two authorization modes:

• Legal entity-based: If you don't provide property_ids or leave the parameter empty, you must be authorized (i.e. through your machine account ID) for every property under the specified legal_entity_id.
• Property-based: If you provide property_ids, you must be authorized for each of the listed property IDs.

{
  "properties": [
    {
      "legal_entity_id": "LE12345",
      "property_ids": [
        "ASSET001"
      ]
    }
  ],
  "from_date": "2025-06-01", 
  "to_date": "2025-06-30",
  "report_configurations": [
     {
      "config_key": "format_type",
      "config_value": "JSON"
    },
    {
      "config_key": "locale",
      "config_value": "en"
    }
  ],
  "report_filters": [
    {
      "filter_key": "bank_accounts",
      "filter_values": ["1234", "5678"] 
    },
    {
      "filter_key": "payout_type",
      "filter_values": ["NET"]
    },
    {
      "filter_key": "statement_descriptor",
      "filter_values": ["12345678", "9101112"] 
    }
  ]
}

The following table describes the request elements:

{
  "meta": {
    "ruid": "string"
  },
  "data": {
	    "request_id": "UUID-R1234", 
	    "report_status": "GENERATING"
  },
  "errors": [
    {
      "description": "string",
      "message": "",
      "status_code": 0,
      "debug_message": "string"
    }
  ],
  "warnings": [
    {
      "message": "string"
    }
  ]
}

The following table describes the response elements:

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

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