Skip to main content

ReceiptSummary Payload Samples

These are the JSON payloads a client will receive for all supported variations of the ReceiptSummary webhook.


1. Scan (complete)

Triggered when a new paper receipt is successfully scanned and processed. Subscribe to this event if you want to receive paper receipt data as soon as it's processed.

{
"id": "051748df-36f2-4a70-ac67-0d00faf1b84f",
"timestamp": 1776744008355,
"payload_data": {
"blink_receipt_id": "954d737a-c813-4249-8fab-428338abecff",
"receipt_type": "paper",
"status": "[accepted|rejected]",
"merchant_name": "Walmart",
"purchase_date": "2026-04-15 00:00:00",
"total": 5,
"item_count": 6,
"reason": "[DUPLICATE_RECEIPT|INVALID_RECEIPT|RECEIPT_TOO_OLD|USER_CAP]",
"client_user_id": "test_user_123",
},
"payload_type": "ReceiptSummary",
"version": 1,
}

Field Reference

FieldTypeDescription
versionnumberTop-level payload schema version.
idstring (UUID)Unique ID for this webhook delivery.
timestampnumberUnix timestamp in milliseconds.
payload_typestringPayload event type. Always "ReceiptSummary"
payload_dataobjectContainer for the webhook payload data.
payload_data.blink_receipt_idstringUUID — Primary Blink Receipt ID.
payload_data.receipt_typestringType of receipt (example - "paper")
payload_data.merchant_namestringMerchant or store name.
payload_data.purchase_datestringDate the purchase was made.
payload_data.totalnumberTotal amount charged.
payload_data.item_countnumberNumber of items purchased in the receipt.
payload_data.client_user_idstringYour user ID that is passed to Actual via the SDK for you to match to users on your end.
payload_data.statusstringaccepted or rejected
payload_data.reasonstringOnly present when status: rejected. See rejection reason codes below.

Rejection Reason Codes

reasondescription
DUPLICATE_RECEIPTReceipt was determined to be a duplicate
INVALID_RECEIPTImage was determined to an invalid receipt (not a receipt / fraudulent)
RECEIPT_TOO_OLDReceipt is older than allowable threshold (default 14 days)
USER_CAPUser exceeded one or more submission thresholds
note

ReceiptSummary fires for all receipt scans regardless of content of scan data.