Campaign Validation Overview

What This Category Covers

Campaign validation checks submitted receipts against a stored rule set — a campaign — and returns pass/fail results with reasons. This category holds the full lifecycle: five endpoints to create and manage campaign settings, plus the validation endpoint that receipts are submitted to. Campaigns suit promotions, loyalty programmes, and cashback offers where the same rules apply to every receipt.

Campaign Lifecycle

1. Create a campaign's settings under your chosen campaignId — dates, merchants, products, and other rule sections.
2. Validate receipts against it by sending them with that campaignId — as a file upload or a URL.
3. List and inspect your campaigns to see what is currently configured.
4. Update settings as the promotion evolves.
5. Delete the campaign when it ends, if desired.

Endpoints in This Category

Need to validate receipts against rules supplied inline per request, without a stored campaign? See the Receipt Validation (Beta) overview.

Key Concepts

• campaignId — the identifier you choose at creation; every validation request and every management call is scoped by it.
• Rule sections — a campaign's settings combine sections such as dates, merchant names, product line items, and fraud-detection options. The full catalogue lives in the Campaign Settings Reference.
• Validation results — responses state whether the receipt passed and which rules it failed, so your application can tell the end user why.

Related Guides

• Setting Up Validation Campaigns — build your first campaign.
• Campaign Management — operate campaigns over their lifetime.
• Campaign Settings Reference — every rule section in detail.
• Validating Receipts — the validation flow end to end.

Parameters

All endpoints authenticate with your API key and are scoped by campaignId. The management endpoints take campaignId in the path with the rule sections as the JSON body (Campaign Settings Reference); the parameters below apply to Validate Receipts.