> ## Documentation Index
> Fetch the complete documentation index at: https://docs.rc.cleverhub.co/llms.txt
> Use this file to discover all available pages before exploring further.

# Cashback API Overview

> Hello Clever’s Cashback API lets you embed instant cashback into your platform: manage campaigns, activate accounts, and trigger cashback delivery via API.

The Hello Clever Cashback API lets you integrate instant cashback rewards directly into your own platform or white-label product. Rather than managing campaigns through the Merchant Portal, you call the API to retrieve campaign configurations, activate customer cashback accounts, and initiate cashback delivery and withdrawals programmatically.

## When to use the Cashback API

<CardGroup cols={2}>
  <Card title="Merchant Portal Campaigns" icon="chart-bar" href="/portal/cashback-campaigns">
    Use the Merchant Portal if you want a no-code way to create and manage cashback campaigns for your Hello Clever store. No API calls required.
  </Card>

  <Card title="Cashback API" icon="code" href="/api/cashback/get-cashback-campaign-list">
    Use the Cashback API if you’re building a custom platform, white-labelling Hello Clever cashback, or need programmatic control over campaign delivery and user management.
  </Card>
</CardGroup>

## Authentication

The Cashback API uses `app-id` and `secret-key` as HTTP headers.

```bash theme={null}
curl https://api-merchant.helloclever.co/api/v2/cashbacks/campaigns \
  -H "app-id: your-app-id" \
  -H "secret-key: your-secret-key"
```

Retrieve your credentials from the Merchant Portal. See [Integration Keys](/integration-keys).

## Available endpoints

| Resource                                                          | Description                                                                  |
| ----------------------------------------------------------------- | ---------------------------------------------------------------------------- |
| [Campaigns](/api/cashback/get-cashback-campaign-list)             | List campaigns, get configurations, and retrieve user lists                  |
| [Delivery & Withdrawal](/api/cashback/initiate-cashback-delivery) | Activate cashback accounts, initiate cashback delivery, initiate withdrawals |

## Key features

* **Campaign Management**: Retrieve a list of all cashback campaigns and their detailed configurations (cashback percentage, tiers, duration, limits).
* **User Cashback Accounts**: Activate a cashback account for a specific user to enable them to receive rewards.
* **Cashback Delivery**: Trigger cashback delivery to a user’s account after a qualifying transaction.
* **Cashback Withdrawal**: Initiate a withdrawal of cashback funds to a user’s bank account.
* **User List**: Retrieve all users who have active cashback accounts on your platform.


## Related topics

- [Hello Clever API Overview](/api/overview.md)
- [Card Payment API Overview](/api/card/overview.md)
- [Merchant Portal Overview](/portal/overview.md)