BlinkReceipt Documentation
website·Indexed 31 days ago
https://docs.actualplatform.comDeveloper documentation for BlinkReceipt, featuring the Scan API for extracting purchase data from physical and digital receipts, iOS and Android SDK references, and webhook event guides for ReceiptProcessed, ReceiptSummary, and RewardUpdate.
What's inside BlinkReceipt
- Purchase Intelligence provides a platform to capture and standardize purchase data from multiple formats, including paper receipts, digital receipts, and retailer accounts. It uses real-time enrichment to transform zero-party transaction data from verified purchases into actionable product intelligence.
Overview of the Actual Webhook Service
The Webhook Service provides reliable, asynchronous delivery of event data (such as status updates and receipt processing results) from the Actual backend to configured HTTP endpoints. It decouples receipt processing from user interactions and provides delivery guarantees via automatic retry mechanisms and an audit trail of all delivery attempts.Overview of Microblink Paper Receipt SDK Android classes
The Microblink Paper Receipt SDK for Android organizes its functionality into classes located primarily within thecom.microblinkorcom.microblink.corepackages. Most objects implementParcelablefor easy passing between Android components, and data is accessed via standard Java-style getter methods.Overview of Android SDK packages for Digital Receipt processing
The Android SDK for digital receipts is organized into two primary packages based on the data source:
com.microblink.linking: Used for retailer account linking and scraping order history.com.microblink.digital: Used for parsing e-receipts from email providers such as Gmail, Outlook, and IMAP.
Overview of the Product Intelligence API
The Product Intelligence API is used to enrich raw extracted product and trip data from physical or digital receipts. It transforms raw data into full product catalog information, enabling developers to validate purchases, manage reward promotions, and generate reports at the brand, category, or UPC (Universal Product Code) level. The API can process data sourced from mobile SDKs, web APIs, asynchronous digital services, or other external sources.Overview of BRIMAPAccount class
TheBRIMAPAccountclass represents an IMAP account and inherits fromBREmailAccount. It must be instantiated with user credentials before beginning the IMAP setup process inBREReceiptManager. This class is compatible with SDK version 3.2.0.@interface BRIMAPAccount : BREmailAccountclass BRIMAPAccount : BREmailAccountOverview of Actual Activation Platform User Journeys
The Actual Activation Platform SDK enables mobile applications to monetize user shopping activity by rewarding users for specific engagement tasks. There are five primary user journeys:
- Offer Discovery & Clipping: Browsing and saving available promotional offers.
- Receipt Scanning: Scanning receipts to earn rewards on qualifying purchases.
- Receipt Boosters: Watching rewarded ads for bonus rewards.
- Product Capture (UGC Tasks): Photographing products for extra rewards.
- Missed Earnings: Correcting receipt data to claim potential credits.
Overview of Digital Receipt SDK capabilities
The Digital Receipt SDK extends the BlinkReceipt SDK to provide e-receipt parsing and retailer account linking. It allows applications to authenticate users with retailers and mail providers to retrieve and parse digital receipts on both iOS and Android platforms. Key capabilities include:
- Account Linking: Connect user accounts with supported retailers to automatically retrieve order history via native credential prompts or webview authentication (supporting 2FA and CAPTCHA).
- Email Linking: Parse structured receipt data from Gmail, Outlook, Yahoo, and AOL accounts, supporting multiple simultaneous linked accounts.
- Background Fetch: Periodically retrieve new orders while the application is running in the background.
Overview of Digital Receipt iOS SDK Global Classes
The Digital Receipt iOS SDK provides several global classes to manage digital receipt operations, email account parsing, and retailer account linking. Key managers includeBRDigitalManagerfor general operations,BREReceiptManagerfor e-receipts and email accounts, andBRAccountLinkingManagerfor retailer account connections.Overview of Purchase Activation
Purchase Activation allows developers to generate revenue from purchase data by serving contextually relevant content, offers, and ads during pre- and post-purchase moments when user engagement is highest. It transforms receipt scanning functionality into a profit center by leveraging user transaction data to deliver targeted experiences.Overview of Purchase Activation
Purchase Activation allows developers to generate revenue from purchase data by serving contextually relevant content, offers, and ads during pre- and post-purchase moments. It transforms receipt scanning into a profit center by leveraging user engagement at the point of transaction.Overview of Purchase Intelligence
Purchase Intelligence is a platform that captures and standardizes purchase data from multiple formats, including paper receipts, digital receipts, and retailer accounts. It uses real-time enrichment to transform zero-party transaction data from verified purchases into actionable product intelligence.