The Cashback Delivery API lets you programmatically activate customer cashback accounts, deliver cashback rewards after qualifying purchases, and initiate withdrawals to users’ bank accounts. These endpoints are the core of a white-label cashback integration where you control the transaction flow.
Cashback delivery deducts funds from your merchant balance. Ensure you have sufficient balance before calling the delivery endpoint. Check your balance using the Balance API.

POST /v2/cashbacks/activate — Activate User Cashback Account

Activate a cashback account for a new user before delivering cashback to them. A user must have an active cashback account to receive rewards.
app-id
string
required
Your application ID.
secret-key
string
required
Your secret key.
user_id
string
required
Your internal user identifier.
email
string
required
The user’s email address.
name
string
required
The user’s full name.
phone
string
The user’s phone number including country code.

POST /v2/cashbacks/deliver — Initiate Cashback Delivery

Calculate and deliver cashback to a user after a qualifying transaction. Hello Clever applies the campaign’s tier rules to the purchase amount and credits the result to the user’s cashback account.
app-id
string
required
Your application ID.
secret-key
string
required
Your secret key.
user_id
string
required
Your internal user identifier. The user must have an active cashback account.
campaign_id
string
required
The campaign ID to apply. Retrieve campaign IDs from GET /v2/cashbacks/campaigns.
purchase_amount
number
required
The total purchase amount in the transaction (used to calculate cashback based on campaign tiers).
transaction_id
string
required
Your internal transaction or order ID for tracking.
payment_method
string
required
Payment method used (e.g. payid, payto, card). Must match the campaign’s applicable methods.
webhook_notification
object
Optional webhook override to receive delivery confirmation.

POST /v2/cashbacks/withdraw — Initiate Cashback Withdrawal

Initiate a withdrawal of cashback funds from a user’s cashback account to their linked bank account.
app-id
string
required
Your application ID.
secret-key
string
required
Your secret key.
user_id
string
required
Your internal user identifier.
amount
number
required
Amount to withdraw. Must not exceed the user’s available cashback balance.
Withdrawal processing times depend on the user’s linked bank account and payment rail. Real-time bank accounts typically settle within seconds; other methods may take 1–2 business days.