Scopes and locations
Grant only the access your integration needs. Scopes and locations are explicit; no key grants access to another business.
| Scope | Grants access to |
|---|---|
| account:read | Company details and reference data. |
| locations:read | Authorized locations. |
| programs:read | Published programs. |
| customers:read | Reading and synchronizing contact data. |
| cards:read | Reading and synchronizing cards and balances. |
| transactions:read | The ledger and financial transaction status reads. |
| checkouts:write | Card lookup and reservation/commit workflows. |
| purchases:write | Recording already-paid sales. |
| refunds:write | Refunds and full reversals. |