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​

How Paybilt Tips works

The moving parts — wallet, shifts, pools, payouts — and how they connect.

Nightly tip run

Walk through a full automation from shift sync to payout confirmation.

First API call

Base URLs, auth headers, and the public OpenAPI spec.

API reference

Interactive endpoint docs with scopes and request schemas.

Concept guides​

Short primers for each object you'll hit in the API. Open a topic when you need the full model — not a wall of definitions.

Staff rolesJob categories such as Server or Bartender. Drive tip math — separate from who can log in.ShiftsHours worked in a role on a given day. Usually imported from your scheduler or POS.Tip poolsRules for splitting a tip total — points, hours, percentage, or equal share.DistributionsThe calculated payout set for a period. Stay in draft until you approve.Distribution paymentsPer-person payment lines after approve — statuses, retries, and failures.WalletsThe restaurant's funded balance. Deposits, auto top-ups, and spend for payouts.PayoutsMoney out to staff — e-Transfer, EFT, and how releases are gated.TransactionsThe ledger: funding in, payouts out. Read-only — built for reconciliation.Invites & membersStaff and managers joining a restaurant, including pending invite states.

API keys vs portal login​

Two different credentials, two different jobs:

API keys

Server-to-server automation. Scoped to one restaurant and the permissions you pick when you create the key.

Portal login

Humans in the web app — owners, managers, staff. Key management itself also needs portal login; you can't mint keys via the integration API.

See Authentication for header format and scope details.