Overview

Introduction

Benji

Benji is your one stop shop to build, manage, and expand all of your Loyalty Partnerships

The Benji Platform

Overview of key components in the Benji Ecosystem

Key Concepts

Key Benji Concepts

An overview of your partnerships statuses, traction and activity

Dashboard

Pilot Dashboard Overview

A granular view of all your campaigns, partnerships and member traction

Analytics

Analytics Page

A view of all your user activity on the Benji Platform, allowing you to drill into a specific member rewards usage across all your connected partners and campaigns

Transactions

A page displaying all your past, upcoming and due Benji invoices information, with the ability to get a per transaction breakdown for each invoice

Finance

Finance Page

A page to set and view your account settings and configurations

Settings

Partner Settings Page

An SDK that simplifies connectivity to reward partners.

Introduction to the Benji Connect SDK

Create a token to initialize an instance of the Benji Connect SDK.

Create Token

Create a token to initialize the SDK

Importing and initializing the SDK to start connecting your users to their loyalty platforms.

Initialization

Initialize the Benji Connect SDK

Overview of supported methods and events in the Benji Connect SDK

Methods & Events

Benji Connect SDK methods and events

Exchange the short lived toke returned from the SDK to a long living access token and refresh token using the Benji Platform API

Exchange Token

Exchange the Connect Token

Authenticating your API requests with the Benji Platform APIs

Authentication

API Authentication

Silently refresh the user access token for a specific user without requiring them to reconnect their account

Refresh Token

Refresh a user access token

Endpoint to retrieve user basic data, as well as their linked partners and merchants

Get User Data

Get User Status Data

Get Campaign

Endpoint to retrieve all campaigns associated with your account

List Campaigns

An overview of the earn reward flow on the Benji Platform.

Earn reward flow overview

Create a token to authenticate the transaction and use in the create transaction API

Authenticate

Create a transaction token

Create a transaction using the [reward transaction authentication token](/api-reference/endpoint/transactions/authenticate) from the previous step.

Create Transaction

Create a transaction

Endpoint to retrieve information regarding a reward transaction

Get Transaction

Get Reward Transaction

Reverse Transaction

Reverse Reward Transaction

An overview of the Benji Platform webhooks, allowing you to receive real time updates on users, campaigns and reward transactions.

Benji Platform Webhooks Overview

Subscribe to a specific event or all entity events on the Benji Platform

Subscribe

Subscribe to a webhook event

Update a webhook subscription for a specific event or all entity events on the Benji Platform

API Documentation

Tokens

Member Status

Campaigns

Transactions

Webhooks

Introduction

Overview

Token Endpoints

Member Status Endpoints

Campaign Endpoints

Transaction Endpoints

Webhooks

API Documentation

Tokens

Member Status

Campaigns

Transactions

Webhooks

​Overview

Token Endpoints

Member Status Endpoints

Campaign Endpoints

Transaction Endpoints

Webhooks

Overview