Checkout API

Use the Checkout API to trigger a complete CheckYout check-out from your own system — exactly as if the guest had scanned the QR code at the door. The call sends the WhatsApp notification to the cleaner, dispatches email and webhook notifications, drops the heating into eco mode (tado°, Netatmo, Vaillant, Nest), turns lights off (Hue), and runs your Shelly devices.

When to use

Use this endpoint when your system (e.g. Resavio, Smoobu check-out, your own PMS) already detects when a guest leaves the property — for example through an online check-out, a paid final invoice, or a manual trigger by the host. Instead of asking the guest to scan the QR code as well, CheckYout takes over all downstream actions.

Endpoint

Request

Request body

Property mapping

So CheckYout can match a device to a Resavio property, the host stores the Resavio property ID per property in the CheckYout dashboard under Settings → Resavio Property ID. After that, calling with resavio_property_id is enough.

Response

Success response (200)

{
  "success": true,
  "eventId": "8a4b1c2d-3e4f-5a6b-7c8d-9e0f1a2b3c4d",
  "notified": true,
  "device_id": "ZNKKPJZV",
  "property_name": "Chalet Rösi"
}

If a check-out for the same device was already triggered within the last 60 seconds, the API responds with "eventId": "rate-limited" and "reason": "rate_limited" — this is not an error, just a guard against double triggering.

Error responses

Code examples

curl -X POST https://checkyout.app/api/v1/checkout \
  -H "Content-Type: application/json" \
  -H "X-API-Key: cyo_YourApiKey" \
  -d '{
    "resavio_property_id": "abc-123"
  }'

const response = await fetch('https://checkyout.app/api/v1/checkout', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'X-API-Key': process.env.CHECKYOUT_API_KEY,
  },
  body: JSON.stringify({
    resavio_property_id: 'abc-123',
  }),
});

const data = await response.json();
console.log('Check-out triggered:', data.eventId);

import requests
import os

response = requests.post(
    "https://checkyout.app/api/v1/checkout",
    headers={
        "Content-Type": "application/json",
        "X-API-Key": os.environ["CHECKYOUT_API_KEY"],
    },
    json={"resavio_property_id": "abc-123"},
)

response.raise_for_status()
data = response.json()
print(f"Check-out triggered: {data['eventId']}")

<?php
$ch = curl_init('https://checkyout.app/api/v1/checkout');
curl_setopt_array($ch, [
    CURLOPT_POST => true,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Content-Type: application/json',
        'X-API-Key: ' . getenv('CHECKYOUT_API_KEY'),
    ],
    CURLOPT_POSTFIELDS => json_encode([
        'resavio_property_id' => 'abc-123',
    ]),
]);

$response = curl_exec($ch);
curl_close($ch);
echo $response;

Behaviour