Boogi Technologies

Boogi Cashback API Documentation

REST APIs

Status codes

API Authentication

Offers and Rewards

End Users

Transaction Data

Cashback Information

Create Support Ticket

Webhooks

Webhook signature verification

Cashback Events

Content Events

User Events

Boogi SDK

Create a User Session Tokens

Implementation guides

What is Boogi

Setting up your dashboard

Historical data sharing - API approach

Historical data sharing - CSV approach

Implementing end user API's

Full SDK implementation

Offer catalogue API implementation

Handling card transactions

Implementing cashback events

Implementing and handling support tickets

Blank

Boogi Cashback APIs

Production

Sandbox

<p class="slate-p " >Welcome to the Boogi Cashback API Documentation. Our APIs and webhooks are designed to empower developers to connect users with cashback offers efficiently and securely.</p><p class="slate-p " >View the status of our platform <a href="https://status.boogi.io/" target="_blank">here</a></p><p class="slate-p " ></p><h3 class="slate-h3 " >Getting Started</h3><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative">Sign into your dashboard: <a href="https://dashboard.boogi.io" target="_self">https://dashboard.boogi.io</a></div></li><li class="slate-li " ><div style="position:relative">To begin your integration, review our <a href="673374ab6d7d0c0936f9fc1e/66aa888f4ad44e98555ef48c" target="">API Authentication</a> </div></li><li class="slate-li " ><div style="position:relative">Explore and implement our <a href="673374ab6d7d0c0936f9fc1e" target="">REST APIs</a>, <a href="673375296d7d0c0936fa0fe3" target="">Webhooks</a> &amp; <a href="67346e738da61d9b7b9bc5a5" target="">SDK</a></div></li></ol><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

Welcome to the Boogi Cashback API Documentation. Our APIs and webhooks are designed to empower developers to connect users with cashback offers efficiently and securely.

<h4 class="slate-h4 " ><span style="background-color:rgb(255, 255, 255);color:rgb(56, 66, 72)">Use these APIs to handle content, customer data and cashback objects</span></h4><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><h2 class="slate-h2 " >Overview</h2><p class="slate-p " >The Boogi API is designed on the REST architecture, offering a lightweight and flexible interface for managing content, customer data, and cashback objects. The API uses standard HTTP methods like GET, PUT, POST, and DELETE to handle CRUD operations performed on the system.</p><p class="slate-p " >All API interactions are conducted over HTTPs and respond with JSON-formatted data. By leveraging these APIs, you can send customer data, display your cashback program, and manage end-user cashback objects, among other key functionalities.</p><p class="slate-p " ></p><h2 class="slate-h2 " >Topics</h2><div class="published-table"><div class="table-container" style="padding-left: 0px;"><table class="slate-table" style="min-width:100%;"><div class="published-table-header" style="width:100%;min-width:100%;min-height:initial;visibility: hidden;border:initial"><div style="width:319px;">Title</div><div style="width:0px;">Description</div></div><colgroup ><col style="width:319px"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><h4 class="slate-h4 " ><strong class="slate-bold">Topic</strong></h4></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><h4 class="slate-h4 " ><strong class="slate-bold">Description</strong></h4></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><a href="66aa888f4ad44e98555ef489" target="">Status codes</a></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Learn about the status codes with which Boogi responds.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><a href="66aa888f4ad44e98555ef48c" target="">API Authentication</a></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Learn about how Boogi authenticates it&apos;s REST API</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><a href="6733725902d82fbf9db12b2b" target="">Content</a></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Use GET calls to access your program content and to view the entire catalogue across the Boogi network</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><a href="6733702602d82fbf9db100c8" target="">Customer Data</a></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Use GET and POST calls to input transaction data, activate end-user offers, and create end-user sessions for client-side SDK usage. </p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><a href="66aa888f4ad44e98555ef487" target="">Cashback</a></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Use GET calls to access cashback objects generated by your program and view them by a paginated list, by ID or by endUserId</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><a href="66aa888f4ad44e98555ef485" target="">Bank Connections</a></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Use GET, POST &amp; DELETE calls to create and manage end-user bank connections.  </p></td></div></tr></tbody></table></div></div><p class="slate-p " ></p>

Use these APIs to handle content, customer data and cashback objects

The Boogi API is designed on the REST architecture, offering a lightweight and flexible interface for managing content, customer data, and cashback objects. The API uses standard HTTP methods like GET, PUT, POST, and DELETE to handle CRUD operations performed on the system.

All API interactions are conducted over HTTPs and respond with JSON-formatted data. By leveraging these APIs, you can send customer data, display your cashback program, and manage end-user cashback objects, among other key functionalities.

Title

Description

<h4 class="slate-h4 " >Boogi provides real-time notifications to inform our publishers of certain events. </h4><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><h3 class="slate-h3 " >Overview</h3><p class="slate-p " >Boogi provides real-time webhooks that send certain events to our publishers. You can use these events to inform your end users of the status of cashback objects, and use the content webhook to ensure the offers you store and display to your users are up-to-date</p><p class="slate-p " ></p><h3 class="slate-h3 " >How to create a webhook</h3><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative">Sign in to your administration dashboard at <a href="http://dashboard.boogi.io/" target="_blank">dashboard.boogi.io</a> with an account that has developer access</div></li><li class="slate-li " ><div style="position:relative">Go to developers &gt; webhook, and you will see a webpage that contains a table of active webhooks for each type of webhook</div></li><li class="slate-li " ><div style="position:relative">Click Add New for the type of webhook you are looking to create</div></li><li class="slate-li " ><div style="position:relative">Provide us with the URL you wish to use for the webhook and select the webhook&apos;s scope. </div></li><li class="slate-li " ><div style="position:relative">Click on the newly created webhook in the dashboard</div></li><li class="slate-li " ><div style="position:relative">In this view, you can see all the recent events that have hit this webhook and also the webhook signature, which is used to validate and identify the endpoint.</div></li></ol><p class="slate-p " ></p><h3 class="slate-h3 " >Topics</h3><div class="published-table"><div class="table-container" style="padding-left: 0px;"><table class="slate-table" style="min-width:100%;"><div class="published-table-header" style="width:100%;min-width:100%;min-height:initial;visibility: hidden;border:initial"><div style="width:549px;">Title</div><div style="width:0px;">Description</div></div><colgroup ><col style="width:549px"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><h4 class="slate-h4 " ><strong class="slate-bold">Topic</strong></h4></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><h4 class="slate-h4 " ><strong class="slate-bold">Description</strong></h4></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><a href="673375296d7d0c0936fa0fe3/673374034dd4025bf9b89a2b" target="">Verifying webhook messages</a></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Learn how to verify and secure webhook events using your webhook secret </p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><a href="673375296d7d0c0936fa0fe3/66aa888f4ad44e98555ef48a" target="">Cashback events</a></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Learn the different events generated for cashback</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><a href="673375296d7d0c0936fa0fe3/66aa8ac9651310b3017e45fe" target="">Content events</a></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Learn the different events generated for content</p></td></div></tr></tbody></table></div></div><p class="slate-p " ></p>

Boogi provides real-time notifications to inform our publishers of certain events. 

Boogi provides real-time webhooks that send certain events to our publishers. You can use these events to inform your end users of the status of cashback objects, and use the content webhook to ensure the offers you store and display to your users are up-to-date

<h4 class="slate-h4 " >The Boogi SDK makes launching your cashback rewards program quick and easy within your application. </h4><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><h3 class="slate-h3 " >Overview</h3><p class="slate-p " >The Boogi SDK is a client-side application that enables you to embed a customisable web view of your program offers into your application, as seen in the demo <a href="https://demo.boogi.io" target="_blank">here</a> </p><p class="slate-p " >To use the SDK, you need to generate an end-user session token on your server-side application, please use the <a href="673374ab6d7d0c0936f9fc1e/6733702602d82fbf9db100c8/6733745202d82fbf9db1b8cb" target=""><code class="slate-code">/end-user/auth/token</code></a> to generate the token. </p><p class="slate-p " ></p><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><h3 class="slate-h3 " >Installation</h3><p class="slate-p " >To install the Boogi JavaScript SDK, use npm:</p><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">Bash</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-bash keep-markup drop-tokens"><div class="slate-code_line">npm install boogi-javascript-sdk</div></code></pre></div><h3 class="slate-h3 " >Usage</h3><h4 class="slate-h4 " >Importing the SDK</h4><p class="slate-p " >After installing the package, import the Boogi SDK into your JavaScript file:</p><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">JavaScript</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-javascript keep-markup drop-tokens"><div class="slate-code_line">import BoogiSDK from &apos;boogi-javascript-sdk&apos;;</div></code></pre></div><h4 class="slate-h4 " >Initialization</h4><p class="slate-p " >To initialize the SDK, create a new instance of the <code class="slate-code">BoogiSDK</code> class. The <code class="slate-code">BoogiSDK</code> instance provides methods for displaying offers, connecting banks, and managing user connections.</p><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">JavaScript</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-javascript keep-markup drop-tokens"><div class="slate-code_line">const boogiSDK = new BoogiSDK();</div></code></pre></div><h4 class="slate-h4 " >Displaying Offers</h4><p class="slate-p " >Use the <code class="slate-code">displayOffers</code> method to present available offers to a user. This can be used in cases where you want to display financial products, deals, or other offers related to Open Banking.</p><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">JavaScript</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-javascript keep-markup drop-tokens"><div class="slate-code_line">boogiSDK.displayOffers(&apos;token&apos;);</div></code></pre></div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Parameters</strong></div></li><li class="slate-li " ><div style="position:relative"><code class="slate-code">token</code>: The authorization token for accessing Boogi services.</div></li></ul><h4 class="slate-h4 " ></h4><p class="slate-p " ></p><h4 class="slate-h4 " ></h4><h2 class="slate-h2 " ></h2><h1 class="slate-h1 " >
</h1><p class="slate-p " ></p>

The Boogi SDK makes launching your cashback rewards program quick and easy within your application. 

The Boogi SDK is a client-side application that enables you to embed a customisable web view of your program offers into your application, as seen in the demo 

To use the SDK, you need to generate an end-user session token on your server-side application, please use the 

To install the Boogi JavaScript SDK, use npm:

After installing the package, import the Boogi SDK into your JavaScript file:

To initialize the SDK, create a new instance of the 

 instance provides methods for displaying offers, connecting banks, and managing user connections.

 method to present available offers to a user. This can be used in cases where you want to display financial products, deals, or other offers related to Open Banking.

<p class="slate-p " >Welcome to the Boogi Cashback API Implementation Guide! If this is your first time working with our platform, don’t worry—we’ve got you covered. This guide will walk you through everything you need to deploy, configure, and maintain Boogi’s APIs step by step.</p><p class="slate-p " >We’ve designed this guide with you in mind, so whether you’re part of a development team or just diving into this project, you’ll find clear instructions to get up and running quickly. You’ll also learn how to tailor the integration to your company’s specific needs and ensure it operates seamlessly within your environment.</p><p class="slate-p " >If you encounter any issues or have questions along the way, our team is here to assist you. Just reach out—we’re ready to make this as straightforward as possible for you. Let’s get started!</p><div class="published-table"><div class="table-container" style="padding-left: 0px;"><table class="slate-table" style="min-width:100%;"><div class="published-table-header" style="width:100%;min-width:100%;min-height:initial;visibility: hidden;border:initial"><div style="width:469px;">Title</div><div style="width:0px;">Description</div></div><colgroup ><col style="width:469px"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Steps</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Link</strong></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >What is Boogi</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><a href="68c93a09b6552e0055990479/68c93d40b6552e005599172d" target="">What is Boogi - Guide</a></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Setting up your management dashboard for the first time</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><a href="68c95cd09fba40d45f75d7d2" target="">Setting up your dashboard - Guide</a></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Historical data sharing</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >API Approach: <a href="68c975a5b6552e00559c381b" target="">Historical data sharing API - Guide</a>
CSV Approach: <a href="68c96cbcb2854ebbbf1a220b" target="">Historical data sharing CSV - Guide</a></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Implementing end user API&apos;s in your customer onboarding flow</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><a href="68c9748981e8c2d586b8dfd6" target="">Implementing end users - Guide</a></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Implementing your offers catalogue </p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Full SDK Approach: <a href="68c93a09b6552e0055990479/68c93aaab6552e00559907f0" target="">Full SDK implementation - Guide</a>
Custom API Approach: <a href="68d1861a1b9af4d131d32441" target="">Offer catalogue API implementation - Guide</a></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Implementing transaction processing</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Handling transactions for card programs: <a href="68c93a09b6552e0055990479/68d19b95a54e492c91524445" target="">Card transactions - Guide</a></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Handling customer cashback </p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><a href="68c93a09b6552e0055990479/68d1a6d01b9af4d131d3b686" target="">Implementing cashback events - Guide</a></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Setting up support tickets</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><a href="68c93a09b6552e0055990479/68d40d3ffbf1f8ec64acbd4a" target="">Implementing support tickets - Guide</a></p></td></div></tr></tbody></table></div></div><p class="slate-p " ></p>

Welcome to the Boogi Cashback API Implementation Guide! If this is your first time working with our platform, don’t worry—we’ve got you covered. This guide will walk you through everything you need to deploy, configure, and maintain Boogi’s APIs step by step.

We’ve designed this guide with you in mind, so whether you’re part of a development team or just diving into this project, you’ll find clear instructions to get up and running quickly. You’ll also learn how to tailor the integration to your company’s specific needs and ensure it operates seamlessly within your environment.

If you encounter any issues or have questions along the way, our team is here to assist you. Just reach out—we’re ready to make this as straightforward as possible for you. Let’s get started!

Sections