Create Campaign Settings

Stores the rule set that Validate Receipts checks submissions against. Every rule section is optional — include only the checks your campaign needs. Full field definitions and a worked example: Campaign Settings Reference; see also Setting Up Validation Campaigns and a complete example request.

📘

Availability

Available on Advanced plans and above. Enable Campaign Validation in your account Feature Settings when it is available on your plan — see Plans & Feature Access.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

A unique identifier for the campaign

Body Params
date
object

The promotion period

merchantNames
object

A list of merchants participating in the campaign

productLineItems
object

List of eligible product details including description, quantity, and price.

smartValidate
object

Option to create a validation rule with a specific question

productCodes
object

List of eligible product codes

balanceOwing
object

Defines a range for the total amount due. Used to validate if the balance falls within the campaign's minimum and maximum limits.

fraudDetection
object

Detects potential fraudulent activity in the documents

Responses

413

Request body exceeds the 20 MiB (20,971,520-byte) HTTP body limit. See Document Types & File Requirements.

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json