Developers Guides Paths Retail
Retail
Store POS on Surfboard terminals: product catalog with barcodes and stock, a compliant cash register for Sweden, returns, gift cards and receipts.
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.
-
EMV Terminal Integration
The card-present terminal integration end to end, from sandbox to certified and live.
-
Device Registration
Register each till terminal to its store: rotating code, QR link or pre-shipped code.
-
Inter-App Integration
If your POS runs on the terminal itself, this is the app switch that hands each sale to the payment app.
-
Create an Order
Ring up a sale as an order with line items from the catalog and the payment in the same call.
-
Payment Lifecycle
What each payment state means for the till.
-
Refund an Order
Full returns as a return order against the original sale.
-
Partial Refund
Return one item from a basket of many.
-
Gift Cards & Promotions
Issue and redeem gift cards, and run promotions on the catalog.
-
Receipts
Digital receipt links, email, and printing on the terminal.
-
Receipt Printing
Let Surfboard render the receipt from a template, or build it yourself. How to choose.
-
ESC/POS Printing
Your own receipt layout when the default templates are not enough.
-
Merchant Onboarding
Board each retailer through the Partner API.
-
Store Management
Stores are where catalogs, terminals and cash registers live.
-
Terminal & Device Management
Move, rename, configure and reboot terminals across a merchant’s stores.
-
Webhooks
Payment outcomes pushed to your backend.
-
Settlements & Reporting
Settlement reports and the reconciliation a retailer’s finance team asks for.
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 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. 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