Ingest API
The push direction: your site tells Hostwise about bookings and add-ons it created and settled itself — so they appear in the account's back office (reservations list, multi-calendar, cleaning schedule, reporting) alongside everything else. Where the Gateway API is "book through Hostwise", Ingest is "record in Hostwise".
POST/api/ingest
Authenticated with your OAuth 2.1 Bearer token (see Authentication), ingest scope. The body carries one
booking in your brand's shape:
{
"brand": "yourbrand",
"confirmation_code": "YB-4F7K2", // YOUR stable reference — the idempotency key
"listing_id": "…", // Hostwise listingId where applicable
"check_in": "2027-01-10", "check_out": "2027-01-17",
"guests": 4,
"guest": { "name": "…", "email": "…", "phone": "…" },
"money": { "total": 2240, "currency": "EUR" },
"status": "confirmed",
"payment": {
"method": "single", // "single" | "split" (per-guest shares)
"complete": true, // false while shares are still being collected
"paid": 3, "of": 6, "label": "3/6", // split progress (omit for single)
"card_brand": "visa", // card summary, shown on the reservation's Payments tab
"card_last4": "4242", // exactly 4 digits — never send a full card number
"paid_at": "2027-01-03T18:22:00Z", // when the charge succeeded
"url": "https://payments.example.com/…" // deep link to YOUR payment record (https only)
},
"addons": [ { "type": "transfer", "external_id": "YB-4F7K2-T1", "guest_name": "…", "start_date": "2027-01-10",
"amount_cents": 15000, "currency": "EUR",
"items": [ { "id": 52, "qty": 1 } ], // the partner's menu items sold (from /api/storefront/partners)
"quote_id": "q-8812", // a live-priced item: the quote you booked at checkout
"details": { "airport": "GVA" } } ]
}
Selling partner services. Hostwise tells your site what the account can sell (/api/storefront/partners);
you sell it and push the add-on here naming the menu items (and the quote_id of a live item). Hostwise prices the
partner's side from its menu or the quote, opens the request to the partner, and the partner confirms in its portal or from its own
system. The type is the partner's kind (transfer, rental, pass); any other type is recorded for the account's own ledger.
The response carries the guest's reservation number
Take the payment first, then push the booking here. The response returns the reservation number to show your guest:
{
"ok": true,
"reservation": "ok",
"reservation_number": "YB-29BED6D3", // show THIS to the guest, store it on your booking
"reservation_id": 4821
}
- Issue it after payment. A booking only needs a number once it is confirmed, so the order is: charge the guest → push the booking → show the number the response returns (confirmation page, confirmation email, invoice).
- It is yours, visually. The prefix is your brand's own (set it on your brand in the back office); nothing in the number identifies the platform behind it.
- Never lost. The push is idempotent, so if a response is lost, push the same booking again and the same number comes back. It is minted once and never changes.
- Your own key still matters. Keep sending your internal reference as
confirmation_code— it stays the idempotency key and is what add-ons attach to. It simply is not the number the guest quotes any more. - Channel bookings keep theirs. A stay that arrived through another sales channel keeps that channel's own confirmation code, because that is the number the guest was given.
- Idempotent on
confirmation_code: re-pushing the same code updates the record in place. Push again whenever the booking changes — payment progress, added extras, cancellation. - The payment object is the payment RECORD Hostwise shows. Send it and the reservation's
Payments tab reads card, date and status inline, with
urlas a secondary "open on your side" action. Hostwise records payments, it never charges or refunds — and it never accepts a full card number:card_last4is clamped to exactly four digits andcard_brandto a short word, whatever is sent. - Add-ons (ski rental, passes, transfers) attach per guest and flow into the account's supplier and cleaning workflows.
- Ingested bookings appear in back-office views; when the stay occupies an Hostwise listing that Hostwise also distributes, book it through the Gateway instead, so the dates are atomically blocked everywhere — Ingest records, it does not reserve.