Tutorial

The Tikkie Cashback API enables clients to use the Cashback with Tikkie functionality.

App token

An app token is a unique token per API connection. It is used to identify your company. Your Tikkie account can have multiple app tokens for various purposes.

Important: This API is available in a production environment only. See the How to use this API for details on how to get access and how to create an appToken.

appToken has various permission types. The Cashback permission is required to use this API. For more information, see Tikkie API.

Requirements

To use this API in a production environment, you must have the following:

• A Tikkie Cashback contract. For more information, see Tikkie Cashback.
• An app token created in the Tikkie Business Portal with Cashback permission enabled.

How to use this API

This tutorial describes how to use the Tikkie Cashback API in a production environment, along with the APIs functionality.

Step 1 - Get a Tikkie Cashback Contract

1. Go to Apply.
2. Fill in your details and click Send.
3. A member from the Tikkie Service Team will contact you about your request and set up a contract.

Step 2 - Get an API key

1. Register and create an account:
   1. Go to ABN AMRO Developer Portal and click Sign up.
   2. Enter your details, and click Create new account.
   3. Developer Support will send you an activation link by email.
   4. Click the activation link.
2. Request production access:
   1. Log in to your account .
   2. In the left-side navigation click Apps.
   3. Click Request Production Access.
   4. Select the API category that you want to request production access on.

   Note: It is not possible to request production access for multiple API categories in one request.

   1. Fill in the form, and click Submit.
   2. You receive a confirmation email and ticket-ID.
   3. ABN AMRO Developer Support validates the form, and if necessary contacts you.
   4. When the setup is complete, ABN AMRO Developer Support contacts you, and a new App is added in Apps. This new app contains your API key.

Step 3 - Create an appToken

1. Go to the Tikkie Business Portal and sign in.
2. Go to the Settings menu and select API settings
3. Select an existing app or create a new one
4. In the permissions block, enable the Cashback permission.

Step 4 - Create a cashback campaign

A cashback is a refund of part, or all, of a paid amount that is redeemable by a customer. A cashback campaign is a logical component that is used by a brand or product to generate cashbacks.

A cashback campaign is created in coordination with the Tikkie Team. After this has been created you will receive an campaignId.

Step 5 - Retrieve cashback campaign details

To retrieve details of a cashback campaign, using your campaignId, execute: GET Cashback Campaign.

Step 6 - Create a cashback

A cashback is a refund of part, or all, of a paid amount that is redeemable by a customer.

The cashback operation creates a cashback in the specified campaign, and returns a cashbackId which is used to retrieve details.

To create a cashback, execute: POST Cashback

Step 7 - Retrieve cashback details

This operation returns the details of one cashback, specified by a cashbackId.

To retrieve cashback details, execute: GET Cashback.

Step 8 - Set up a cashback subscription

To receive notifications when a cashback is redeemed, set up a subscription using: POST Notification Subscription.

HTTP post requests will be made to the specified url, containing information about cashback in the body of the request.

Step 9 - Cancel a cashback subscription

To cancel a subscription and stop receiving notifications, execute: DELETE Notification Subscription.