Managing the client ID and client secret
Explains how to obtain the client ID and client secret issued when you register a ReceiptRoller app, storage rules, what to do on a leak, and operating across multiple environments.
What is application registration
Explains the concept of ReceiptRoller application registration. Registering an app as an OAuth client issues a client ID, secret, and redirect URI, letting you start API and Webhook integrations.
Rotating and safely storing secrets
Explains the rotation plan for safely operating ReceiptRoller client secrets and Webhook secrets, how to use the old/new parallel period, and best practices for storage.
Creating a new app
Explains the concrete steps to register a new app (OAuth client) in the ReceiptRoller developer portal. Covers the input fields, validation, the post-creation credentials display, and common errors.
What You Can Do with the Developer Portal
An overview of what the ReceiptRoller developer portal lets you do. Combine data retrieval and operations via the REST API with real-time event delivery via Webhooks to connect store and user data from external systems.
Obtaining and refreshing an access token
Explains how to obtain the access token and refresh token used with the ReceiptRoller API, their expiry, the refresh procedure, and what to do on errors.
Cannot obtain a token (authentication error)
How to isolate the cause when you cannot obtain an access token. Explains the representative errors — invalid_client, invalid_grant, redirect_uri_mismatch — and what to do about them.
Survey API and receipt embed
The ReceiptRoller Survey feature lets a store collect responses via QR / link / digital receipt embed and optionally hand back a coupon. This article covers the…
The flow to getting started
Explains the flow to start using the ReceiptRoller developer portal. If you register as a store user and are on the Starter plan or higher, no separate developer application is needed; you can register an app and begin API implementation right away.
Contacting support (technical integration)
Explains the types of support available to ReceiptRoller developers, a checklist to run before contacting support, and a template of the information to attach so issues get resolved efficiently.
Store-facing: Guide to Issuing Digital Receipts from Your Own App and Getting Webhook Notifications
Explains how a store or brand issues digital receipts to customers from its own app and receives real-time notifications via Webhooks. Covers app registration, OAuth, Webhook setup, and signature verification.
Representative API examples
Introduces, as curl commands, examples of calling the representative ReceiptRoller API endpoints (retrieving receipts, listing stores, creating products, registering Webhooks).
Rate limiting and throttling
Explains the unit of rate limiting for the ReceiptRoller API, the per-plan limits, how to read the response headers, and implementation patterns to avoid hitting 429.
How to read the API reference and docs
Explains the structure of ReceiptRoller's developer documentation and when to use each part. Covers the four entry points — the developer help, the API top page, the Swagger-based API reference, and the developer community — and how to obtain the OpenAPI spec (openapi/v1.json) for use with AI assistants and code generators.
Developer Help Index
The index of ReceiptRoller developer help. Covers the developer application, app registration, OAuth authentication and scopes, implementation guides (wallet apps, store-facing Webhooks, the Survey API), guides by data domain, operations and security, the community, and troubleshooting.
Guide for native mobile apps: multi-business-account access and the OAuth flow
An implementation guide for Android / iOS native apps. Turning off "bind the token to one business account at authorization time" during app registration issues a user-scoped OAuth token. With the /api/v1/me/organizations + ?organizationId= pattern, you can access multiple business accounts across the board.
Access control and audit logs
Explains how to design access control for operating a ReceiptRoller integration app, the principle of least privilege, how to take audit logs, and how to run periodic reviews.
SLA, uptime, and the checking procedure during an incident
Explains ReceiptRoller's API uptime targets, how to check the status page, the isolation procedure when an incident occurs, and the flow for escalating to support.
Endpoints and versioning
Explains the base URL of the ReceiptRoller API, the versioning policy, the deprecation-notice flow, and how to check the current version.
The basics of requests and responses (JSON)
Explains the request format, required headers, response structure, pagination, filtering, and date/time format rules of the ReceiptRoller API.