Reconciliation Endpoint

The Reconciliation API allows users to retrieve a list of bookings for a given date range. This guide will walk you through using the endpoint effectively, including an example query and understanding the response data.

Using the Endpoint

For most accounts, this endpoint is an easy way to query all your bookings for a specific date range and track their status of confirmed or canceled. In addition to internal reporting, this is also helpful when dealing with clients; maybe they entered the wrong email or name, but you can still track down the booking via when it was made to find the details. This can also be helpful when dealing with customer support or cancelation requests, as it allows you to view all the details and track the status of the booking.

Query Parameters

Date Range

Use these to determine the time frame you want to pull bookings from.

startDate (required)
Start date of the booking range.
Format: YYYY-MM-DD
Example: 2025-08-30

endDate (required)
End date of the booking range.
Format: YYYY-MM-DD
Example: 2025-10-31

Filters

Use these to drill down into specific bookings that may be canceled or have payment pending.

status (optional):
Filter by the status of the bookings, either confirmed or canceled.
Accepted Values: confirmed or cancelled

paymentStatus (optional):
Filter by the payment status.
Accepted Values: succeeded or requires_capture

Example Response

{
  "count": 3,
  "data": [
    {
      "id": 3320020,
      "checkin": "2024-09-01",
      "checkout": "2024-09-03",
      "firstName": "Steve",
      "lastName": "Doe",
      "adults": 3,
      "children": "11",
      "hotel_confirmation_code": "dLcN7migy",
      "booking_Id": "Rb5JVigyN",
      "prebook_Id": "0dLcN7mVX",
      "status": "CONFIRMED",
      "payment_status": "succeeded",
      "payment_transaction_id": "tr_cts_vlpBFTjSK7ifl3t_0dGqQ",
      "retail_rate": "654.84",
      "exchange_rate": 0.9187300518,
      "exchange_rate_usd": 1,
      "email": "[email protected]",
      "cancelPolicies": "{\"cancelPolicyInfos\":null,\"hotelRemarks\":null}",
      "tag": "",
      "last_free_cancellation_date": "0001-01-01T00:00:00Z",
      "currency": "USD",
      "api_commission": 64.88999999999999,
      "nationality": "US",
      "holder_title": "",
      "hotelId": "lp19e75",
      "Hotel_name": "",
      "payment_data": "{}",
      "created_at": "2024-08-18T18:39:14Z",
      "updated_at": "2024-08-18T18:39:16Z",
      "cancelled_at": null,
      "refunded_at": null,
      "amount_refunded": 0,
      "refund_type": "",
      "guestId": "",
      "reqId": "IMuclrVuu14wwkxTGXaZi",
      "remarks": "quiet room please",
      "client_reference": "",
      "IP": 0,
      "sandbox": 1,
      "version": 30,
      "link": 0,
      "client_commission": 58.995000000000005,
      "voucher_id": null,
      "voucher_total_amount": 0,
      "voucher_transation_id": null,
      "processing_fee": 0,
      "supplier_Booking_Id": "Rb5JVigyN"
    }
  ]
}

The response contains the key data from the booking; important ones to be aware of are the cancelation policies and information about a refund if it occurs.

"refunded_at": null, // the date the refund occurs
"amount_refunded": 0, // how much was refunded
"refund_type": "", // the method refunded

⭐️Note: Some advanced accounts function as the merchant of record and use this endpoint to help reconcile the billing for their bookings. If you are interested in a more advanced implementation for your accounts that will function as the merchant of record, please get in touch with your account manager.