Developers Guides Paths Hospitality
Hospitality
Hotels and venues: a deposit online, the balance at reception, pre-authorisation and later capture, stored cards for no-shows, and invoices for corporate guests.
22 guides in reading order. Read them on the site, or take the whole path as one markdown file for your coding agent.
Add this to your codebase
Paste it into Claude Code, Codex, Cursor or any coding agent. It points the agent at this guide in machine-readable form, so it writes against the real API instead of a guess. Wire up the MCP server once and it can read the rest of the platform too.
-
Create an Order
Every charge starts as an order, whether it is taken at reception or online.
-
Payment Lifecycle
Authorise, capture, void, cancel and refund, and when each applies to a stay.
-
Capture a Payment
Pre-authorise at check-in and capture the final amount at check-out.
-
Void a Payment
Release a pre-authorisation that will not be captured.
-
Cancel a Payment
Stop a payment the guest abandoned mid-flow.
-
Tokens
Keep the card from the booking to charge a no-show or incidentals later.
-
Recurring Payments
Charge a stored card from your backend for instalments or memberships.
-
B2B Invoices
Bill a corporate guest on payment terms instead of a card.
-
Refund an Order
Refund a cancelled booking against the original payment.
-
Receipts
Email the receipt to the guest or print it at reception.
Building something else?
The other paths, or ask the assistant on the guides page what to read for your build.
- 01 Food & Beverage Restaurant and café POS: your app on the terminal, tips, split bills, receipts at the counter, and payment links for orders taken online. Open the path
- 02 Retail Store POS on Surfboard terminals: product catalog with barcodes and stock, a compliant cash register for Sweden, returns, gift cards and receipts. Open the path
- 03 SoftPOS only Tap to Pay on iPhone and Android with no hardware: your app beside the CheckoutX app on the same device, then orders, refunds and receipts from your own app. Open the path