Documentation contents

Integration guide

Scopes and locations

Grant only the access your integration needs. Scopes and locations are explicit; no key grants access to another business.

ScopeGrants access to
account:readCompany details and reference data.
locations:readAuthorized locations.
programs:readPublished programs.
customers:readReading and synchronizing contact data.
cards:readReading and synchronizing cards and balances.
transactions:readThe ledger and financial transaction status reads.
checkouts:writeCard lookup and reservation/commit workflows.
purchases:writeRecording already-paid sales.
refunds:writeRefunds and full reversals.