The Cashback Campaign API endpoints let you fetch available cashback campaigns and their configurations, and retrieve a list of users with active cashback accounts. Use these endpoints to display available offers to users or to validate campaign eligibility before initiating cashback delivery.
All Cashback API endpoints use app-id and secret-key headers. See Authentication for setup instructions.

GET /v2/cashbacks/campaigns — Get Campaign List

Retrieve a paginated list of cashback campaigns for your site, filterable by status.
app-id
string
required
Your application ID.
secret-key
string
required
Your secret key.
status
string
Filter by campaign status: active, scheduled, or inactive.
page
integer
Page number for pagination. Defaults to 1.

GET /v2/cashbacks/campaigns/ — Get Campaign Configurations

Retrieve full configuration details for a specific campaign, including tiers, payment method restrictions, and cashback caps.
id
string
required
The campaign ID.

GET /v2/cashbacks/users — Get User List

Retrieve a list of users who have active cashback accounts on your platform.
app-id
string
required
Your application ID.
secret-key
string
required
Your secret key.
page
integer
Page number. Defaults to 1.