Introduction

The Cashback API allows you to fetch a list of available cashback offers tailored to a specific user and region. These offers can be shown inside your app or website, enabling users to earn cashback when they shop through the links you provide. It's a user-based API, meaning we will match offers with the user. You need to provide a user ID when calling the endpoint.

Endpoint

curl -X GET "https://api.bitlabs.ai/v1/client/cashback/offers" \
  -H "X-Api-Token: YOUR_API_TOKEN" \
  -H "X-User-Id: YOUR_USER_ID"

Example Response

{
    "data": {
        "offers": [
            {
                "cashback": "1",
                "click_url": "https://api.avemaple.com/?cmd=mp-instore-synd-click&pid=3&tid=3&sid=39501&cid=482549412_18597701cc2a3279_0cdec1&guid=482549412&wuid=482549412&vcp=Points&vcs=Points&vcsh=Points&cr=IK6KMO4G5gRhsjPKnNGDETtSnApsXP06rUY5PR%2BZ8w%3D%3D&affid=186&wid=wd-4479&rt=decimal&timestamp=1754564379441&sig=9e525f7bae7fe0b7dc228db0a64617b4b85137b7b7196af56e930377d0ceba5a",
                "country_code": "DE",
                "currency": "EUR",
                "description": "Mit über 4.000 Hotels in mehr als 80 Ländern ist Best Western die größte Hotelkette der Welt.",
                "flat_payout": false,
                "images": {
                    "backgroundImage": "https://ucontent.prdg.io/img/shop/mgbi/mgbi334.jpg?v=1694024789000",
                    "cardImage": "https://ucontent.prdg.io/img/shop/ms/mb39501.jpg?v=1747402997000",
                    "cardImageSmall": "https://ucontent.prdg.io/img/shop/ms/ms39501.jpg?v=1747402997000"
                },
                "merchant_id": 39501,
                "merchant_name": "Best Western",
                "original_cashback": "1",
                "primary_category": "Travel & Vacations",
                "rank": 0,
                "reward_delay_days": 373,
                "terms": [
                    {
                        "flat_payout": false,
                        "payout": 0,
                        "term": "Kein Points bei Verwendung fremder Gutscheine, auf Steuern und Pauschalen oder Stornierung!"
                    }
                ],
                "tier_mappings": [],
                "up_to": false
            },
            {
                "cashback": "1",
                "click_url": "https://api.avemaple.com/?cmd=mp-instore-synd-click&pid=3&tid=3&sid=39458&cid=482549412_18597701cc2e17ce_ba2978&guid=482549412&wuid=482549412&vcp=Points&vcs=Points&vcsh=Points&cr=RpWSbfSJZP%2Blw86ab%2B1yXpDE1YQ5h6F1plAxmqUeUw%3D%3D&affid=186&wid=wd-4479&rt=decimal&timestamp=1754564379441&sig=de867b3563234de0965d449ceeeba08175dd4e8749fda58c3b29b1cdee1ee9a3",
                "country_code": "DE",
                "currency": "EUR",
                "description": "StyleWe ist eine Online-Fashion-Shopping-Plattform mit Mode von unabhängigen Modedesignern. Der Shop konzentriert sich darauf, seinen Käufern ein besonderes Angebot mit originellen, hochwertigen und exklusiven Modeprodukten von einzigartigen und unterschiedlichen Designern zu bieten.",
                "flat_payout": false,
                "images": {
                    "backgroundImage": "https://ucontent.prdg.io/img/shop/mbi/image9-2x.jpg",
                    "cardImage": "https://ucontent.prdg.io/img/shop/ms/mb39458.jpg?v=1747402902000",
                    "cardImageSmall": "https://ucontent.prdg.io/img/shop/ms/ms39458.jpg?v=1747402902000"
                },
                "merchant_id": 39458,
                "merchant_name": "StyleWe",
                "original_cashback": "1",
                "primary_category": "Clothing & Accessories",
                "rank": 0,
                "reward_delay_days": 47,
                "terms": [],
                "tier_mappings": [],
                "up_to": false
            },
            {
                "cashback": "1",
                "click_url": "https://api.avemaple.com/?cmd=mp-instore-synd-click&pid=3&tid=3&sid=39490&cid=482549412_18597701cc31a641_9f3a12&guid=482549412&wuid=482549412&vcp=Points&vcs=Points&vcsh=Points&cr=kM9BJEmIMRn%2Fj16LbTfEFNRrNhnvHMFJy1NCoicvXg%3D%3D&affid=186&wid=wd-4479&rt=decimal&timestamp=1754564379442&sig=41648c90d0bd9ef22ce964b63600599db5330aeb4deef2ad5e8720ecbf4e0e95",
                "country_code": "DE",
                "currency": "EUR",
                "description": "Wir möchten, dass sich Ihr Urlaub wie ein Schnäppchen anfühlt - denn es ist umso schöner, wenn Sie wissen, dass Sie sich ein Schnäppchen gemacht haben. Egal, ob Sie nach einem günstigen Urlaub in Spanien oder auf den Kanaren sind oder einen günstigen Langstreckenurlaub nach Mexiko oder Thailand planen, Sie sind an der richtigen Stelle gelandet. Aber wir wissen, dass manchmal sogar das nicht billig genug ist. Aus diesem Grund bieten wir geringe Einzahlungen für viele unserer Ferien an, sodass Sie jetzt buchen und später bezahlen können.\r\n",
                "flat_payout": false,
                "images": {
                    "backgroundImage": "https://ucontent.prdg.io/img/shop/mbi/image41-2x.jpg",
                    "cardImage": "https://ucontent.prdg.io/img/shop/mgs/mgb996.jpg?v=1696444049000",
                    "cardImageSmall": "https://ucontent.prdg.io/img/shop/mgs/mgs996.jpg?v=1696444052000"
                },
                "merchant_id": 39490,
                "merchant_name": "First Choice",
                "original_cashback": "1",
                "primary_category": "Travel & Vacations",
                "rank": 0,
                "reward_delay_days": 47,
                "terms": [],
                "tier_mappings": [],
                "up_to": false
            },
            {
                "cashback": "2",
                "click_url": "https://api.avemaple.com/?cmd=mp-instore-synd-click&pid=3&tid=3&sid=39455&cid=482549412_18597701cc3d3d3c_175486&guid=482549412&wuid=482549412&vcp=Points&vcs=Points&vcsh=Points&cr=zEuMZ8rXE%2BmOzxIkbrdhEf73Zc162wDxAKjiW%2FofEQ%3D%3D&affid=186&wid=wd-4479&rt=decimal&timestamp=1754564379442&sig=50dc9218cd53782490c9d57906451fbf2f894a442d95c54d65be9546feb21558",
                "country_code": "DE",
                "currency": "EUR",
                "description": "ASICS ist ein Premium-Sportartikelhersteller, der sich auf die Herstellung von Schuhen, Bekleidung und Accessories der Spitzenklasse für zahlreiche Sportarten wie etwa Laufen, Training, Tennis, Rugby und andere mehr spezialisiert hat.",
                "flat_payout": false,
                "images": {
                    "backgroundImage": "https://ucontent.prdg.io/img/shop/mbi/mbi39455.jpg?v=1747402895000",
                    "cardImage": "https://ucontent.prdg.io/img/shop/ms/mb39455.jpg?v=1747402895000",
                    "cardImageSmall": "https://ucontent.prdg.io/img/shop/ms/ms39455.jpg?v=1747402895000"
                },
                "merchant_id": 39455,
                "merchant_name": "ASICS",
                "original_cashback": "2",
                "primary_category": "Shoes",
                "rank": 0,
                "reward_delay_days": 47,
                "terms": [],
                "tier_mappings": [],
                "up_to": false
            },
            {
                "cashback": "3",
                "click_url": "https://api.avemaple.com/?cmd=mp-instore-synd-click&pid=3&tid=3&sid=39480&cid=482549412_18597701cc508d1a_b8732d&guid=482549412&wuid=482549412&vcp=Points&vcs=Points&vcsh=Points&cr=yLwhQc3wDaPKsujifbJD%2FtnrbNOItcXy12bjSMkRPA%3D%3D&affid=186&wid=wd-4479&rt=decimal&timestamp=1754564379444&sig=2e4dfdae5a0262c6b5967e0dd42711b312f23630560111148f65df7de06a2607",
                "country_code": "DE",
                "currency": "EUR",
                "description": "Béaba ist eine französische Marke für Babyausstattung. Qualität und Sicherheit fürs Kind haben für uns höchste Priorität.\r\n",
                "flat_payout": false,
                "images": {
                    "backgroundImage": "https://ucontent.prdg.io/img/shop/mbi/image31-2x.jpg",
                    "cardImage": "https://ucontent.prdg.io/img/shop/mgs/mgb16452.jpg?v=1727202196000",
                    "cardImageSmall": "https://ucontent.prdg.io/img/shop/mgs/mgs16452.jpg?v=1727202286000"
                },
                "merchant_id": 39480,
                "merchant_name": "Beaba",
                "original_cashback": "3",
                "primary_category": "Home Improvement & Tools",
                "rank": 0,
                "reward_delay_days": 47,
                "terms": [],
                "tier_mappings": [],
                "up_to": false
            },
            {
                "cashback": "4",
                "click_url": "https://api.avemaple.com/?cmd=mp-instore-synd-click&pid=3&tid=3&sid=39507&cid=482549412_18597701cc57a531_588e4a&guid=482549412&wuid=482549412&vcp=Points&vcs=Points&vcsh=Points&cr=dM7Gk3S1VwmuoTtA0pxa7MncrwjfILVeIldKRAvrbA%3D%3D&affid=186&wid=wd-4479&rt=decimal&timestamp=1754564379444&sig=d55b962af7c5bdd211c981e0f224639c36ec0cf86506f49ddb80911ff6892d75",
                "country_code": "DE",
                "currency": "EUR",
                "description": "Thinco® ist ein ganz natürliches, einfaches, hocheffektives 3-Schritte-Programm zum Abnehmen, das von der vielbeschäftigten Mutter Karen Mileto entwickelt wurde. Es wurde entwickelt, um Ihnen zu helfen, Gewicht zu verlieren, Ihr Selbstvertrauen wiederzuerlangen, Ihr Energielevel zu steigern, Ihr Sexy zurückzubekommen, sich auf Ihre Gesundheit und Ihr Wohlbefinden zu konzentrieren oder einfach Ihr Glück wieder in Ihrer eigenen Haut zu finden. Produkte und Programm sind speziell auf vielbeschäftigte Frauen jeden Alters zugeschnitten, erstellt und unterstützt von einem Team von Frauen, da sie genau verstehen, was Ihre Anliegen sind.",
                "flat_payout": false,
                "images": {
                    "backgroundImage": "https://ucontent.prdg.io/img/shop/mbi/image8-2x.jpg",
                    "cardImage": "https://ucontent.prdg.io/img/shop/mgs/mgb7161.jpg?v=1694024834000",
                    "cardImageSmall": "https://ucontent.prdg.io/img/shop/mgs/mgs7161.jpg?v=1694024877000"
                },
                "merchant_id": 39507,
                "merchant_name": "Thinco",
                "original_cashback": "4",
                "primary_category": "Health & Wellness",
                "rank": 0,
                "reward_delay_days": 47,
                "terms": [
                    {
                        "flat_payout": false,
                        "payout": 0,
                        "term": "Kein Cashback bei Verwendung fremder Gutscheine, auf Steuern und Pauschalen oder Stornierung!"
                    },
                    {
                        "flat_payout": false,
                        "payout": 0,
                        "term": "Please allow up to 32 days from date of purchase for  to credit."
                    }
                ],
                "tier_mappings": [],
                "up_to": false
            },
            {
                "cashback": "1",
                "click_url": "https://api.avemaple.com/?cmd=mp-instore-synd-click&pid=3&tid=3&sid=39464&cid=482549412_18597701ccaf2ef5_64f205&guid=482549412&wuid=482549412&vcp=Points&vcs=Points&vcsh=Points&cr=5VqbZNHtiDH3BnomqBP1oNZemqbVXPlJf9sL%2FwIXrA%3D%3D&affid=186&wid=wd-4479&rt=decimal&timestamp=1754564379450&sig=eeb26566d3e29c21b49cc86647edce79d2d02258ad1d455a4a9990409b322cc1",
                "country_code": "DE",
                "currency": "EUR",
                "description": "Lacoste ist eine ready-to-wear Fashion-Marke für Herren, Damen und Kinder. Zusätzlich zu ihrem ikonischen Polo Shirt, bietet die Marke Lacoste eine breite Auswahl an Bekleidung, Schuhen, Accessoires und Lederwaren.",
                "flat_payout": false,
                "images": {
                    "backgroundImage": "https://ucontent.prdg.io/img/shop/mgbi/mgbi3.jpg?v=1694024789000",
                    "cardImage": "https://ucontent.prdg.io/img/shop/ms/mb39464.jpg?v=1747402915000",
                    "cardImageSmall": "https://ucontent.prdg.io/img/shop/ms/ms39464.jpg?v=1747402915000"
                },
                "merchant_id": 39464,
                "merchant_name": "Lacoste",
                "original_cashback": "1",
                "primary_category": "Clothing & Accessories",
                "rank": 1956,
                "reward_delay_days": 72,
                "terms": [],
                "tier_mappings": [],
                "up_to": false
            }
        ]
    },
    "status": "success",
    "trace_id": "84c40f3d43577c3d8fa0f080565939f9"
}

Relevant Fields

This section should help you learn how to use the API's fields. A more technical description of the endpoint and the response can be found here.

Ideally, you want to use all of the listed fields in your application.

Field Name	Example	Description
`original_cashback`	1	The amount of cashback a user should earn in USD or % is originally.
`cashback`	1	The final amount of cashback a user should earn in USD or %. A bonus can be applied. Compare it with the `original_cashback` field to get the bonus %.
`flat_payout`	false	false: The user earns a % cashback true: A flat amount in USD, e.g. $15
`merchant_id`	123	The ID of the merchant.
`merchant_name`	Ebay	This is the merchant's name.
`click_url`	https://...	The tracking URL that the user needs to click.
`description`	The...	The description of the merchants and the offer.
`currency`	USD	In what currency the shop or merchant operates.
`rank`	1	Dictates the ranking/sorting of the offer.
`images`	-	Includes background image and card image.
`primary_category`	Travel	The primary category of an offer or merchant.
`reward_delay_days`	30	The number of days a user must wait to receive their cashback after purchase.
`terms`	-	Additional terms, if applicable. These can include additional payout information and cashback.