Skip to main content

Developer documentation

Paybilt Tips is Paybilt's tip management platform — wallets, tip pools, distributions, and staff payouts. These docs are for building integrations with restaurant API keys: POS sync, scheduling imports, nightly tip runs, accounting exports.

If you're looking for the owner portal UI, that's at tips-portal.paybilt.ca. This site covers the HTTP API only.

Where to start

Concept guides

Staff roles — job categories like Server or Bartender; used in tip math, separate from login permissions.

Shifts — hours someone worked in a role on a given day. Usually synced from your scheduler.

Tip pools — the rules for splitting a tip total. Points, hours, percentage, or equal split.

Distributions — the calculated result for a period. Draft first, approve when ready to pay.

Wallets & payouts — the restaurant's funded account, API deposits, auto top-ups, and the e-Transfer/EFT out to staff.

Invites & members — staff and managers joining a restaurant, including pending invite states.

Transactions — the ledger. Funding in, payouts out. Read-only, good for reconciliation.

Each has its own page under Concepts in the sidebar.

API keys vs portal login

API keys are for server-to-server automation. They're scoped to one restaurant and a set of permissions you choose when creating the key.

Portal login (JWT) is for humans using the web app — owners, managers, staff viewing their own tips. Key management itself also requires portal login; you can't create keys via the integration API.

See Authentication for header format and scope details.