---
title: Get started with API.
description: Here are the steps to get you started with the API license
---

[Skip to content](https://support.kangaroorewards.com/knowledge/get-started-with-api#main-content)

- [English](https://support.kangaroorewards.com/knowledge/get-started-with-api)
- [Français](https://support.kangaroorewards.com/fr/knowledge/commencez-avec-lapi)

English

Show submenu for translations

[Customer portal](https://support.kangaroorewards.com/tickets-view?hsLang=en)

![Kangaroo-Rewards-App-Icon-BLUE-Oct-01-2025-07-47-23-2450-PM.png\]](https://support.kangaroorewards.com/hs-fs/hubfs/Kangaroo-Rewards-App-Icon-BLUE-Oct-01-2025-07-47-23-2450-PM.png?height=40&name=Kangaroo-Rewards-App-Icon-BLUE-Oct-01-2025-07-47-23-2450-PM.png)

Open main navigation

Close main navigation

- - [English](https://support.kangaroorewards.com/knowledge/get-started-with-api)
    - [Français](https://support.kangaroorewards.com/fr/knowledge/commencez-avec-lapi)

  English
  
  Show submenu for translations
- [Customer portal](https://support.kangaroorewards.com/tickets-view)
- [Visit Our Website](https://loyalty.kangaroorewards.com/)

[Visit Our Website](https://loyalty.kangaroorewards.com/)

 How Can We Help?

- There are no suggestions because the search field is empty.

1. [Help Center](https://support.kangaroorewards.com/knowledge?hsLang=en)
2. [API](https://support.kangaroorewards.com/knowledge/api?hsLang=en)

# Get started with API.

## Here are the steps to get you started with the API license

1. Sign the API agreement and send it to your account manager.
2. [Create a developer's](https://support.kangaroorewards.com/knowledge/how-to-create-a-developers-account?hsLang=en) account from  [https://api.kangaroorewards.com/developers/register](https://api.kangaroorewards.com/developers/register)
3. Provide us with an email address to create a testing account on Kangaroorewards.com.

Once both are created, we will provide you with the App key to link it to the App created on the developer's account in order to be able to start the integration.

 

In addition, here is the [API documentation](https://t.sidekickopen10.com/Ctc/GE+23284/cTP2z04/JkM2-6q7W6N1vHY6lZ3pGW60l-wJ3qDhhmW2DqS2F7zVt77W4JRhYK2GqnFXW8qkl8n5BPhChW6NV41W7FxtnXW1rt0X75hM1PvW4jRJDd1G0YVQW6pQ2WH5-g-8ZW2kwd424165rJW1TTnk45cclg2W1gJ16v3zz_F_W4X08qH6TB1wyW3-pfWn8yhSlGW8nhZMF8MXVlQW1V6p9s74cV5bW7wzgbS3HWxvYMGy_q2_V7YLW7bPb5w5jcnc1W85d9JL3WwbJsW6Gjx823sg94hW2rdhl51yMGHqW4_dS4m8j1Cvtf99rXC404).

 

Using our APIs, you will be able to send the transactions processed on your POS/ERP/Ecommerce to Kangaroo. You will be able to send transactions to Kangaroo and create accounts for customers to earn points. 

 

**1- Sending transactions with the following:** 

a- Customer First Name

b- Customer Last Name

c- Customer phone number or Email Address (these are **the unique identifiers**, you would need each transaction to include either the phone number or the email address. In case you have both, both get sent via API).

d- Amount of transaction

e- Branch Name

[Use endpoint: https://api.kangaroorewards.com/docs/business.html#transactions-transaction-post](https://api.kangaroorewards.com/docs/business.html#transactions-transaction-post) After that, they send the data to the **4- Updating customer profile** endpoint

 

**2-Handling Partial Refund:**

[https://api.kangaroorewards.com/docs/business.html#transactions-transaction-post](https://api.kangaroorewards.com/docs/business.html#transactions-transaction-post) with return intent and the amount is what specifies if it's a full or partial refund

**3- Handling Full Refund:** 

[https://api.kangaroorewards.com/docs/business.html#transactions-transaction-post](https://api.kangaroorewards.com/docs/business.html#transactions-transaction-post) with return intent and the amount is what specifies if it's a full or partial refund

**4- Updating customer profile:**

[https://api.kangaroorewards.com/docs/business.html#customers-customer-resource-put](https://api.kangaroorewards.com/docs/business.html#customers-customer-resource-put) with the desired fields to update

**5- Marketing Consent (SMS and Email):** 

[https://api.kangaroorewards.com/docs/business.html#customer-consents-customer-consent-collection-post](https://api.kangaroorewards.com/docs/business.html#customer-consents-customer-consent-collection-post) to create a customer consent

 

Refer Back to the [API documentation for more information](https://t.sidekickopen10.com/Ctc/GE+23284/cTP2z04/JkM2-6q7W6N1vHY6lZ3pGW60l-wJ3qDhhmW2DqS2F7zVt77W4JRhYK2GqnFXW8qkl8n5BPhChW6NV41W7FxtnXW1rt0X75hM1PvW4jRJDd1G0YVQW6pQ2WH5-g-8ZW2kwd424165rJW1TTnk45cclg2W1gJ16v3zz_F_W4X08qH6TB1wyW3-pfWn8yhSlGW8nhZMF8MXVlQW1V6p9s74cV5bW7wzgbS3HWxvYMGy_q2_V7YLW7bPb5w5jcnc1W85d9JL3WwbJsW6Gjx823sg94hW2rdhl51yMGHqW4_dS4m8j1Cvtf99rXC404)

**Kindly email api.support@kangaroorewards.com for any API-related questions.**

- [Kangaroo Apps](https://support.kangaroorewards.com/knowledge/kangaroo-apps?hsLang=en#main-content)

    - [Amazon - Partner Reward](https://support.kangaroorewards.com/knowledge/kangaroo-apps?hsLang=en#amazon-partner-reward)
    - [Email Apps](https://support.kangaroorewards.com/knowledge/kangaroo-apps?hsLang=en#email-apps)
    - [Shopify](https://support.kangaroorewards.com/knowledge/kangaroo-apps?hsLang=en#shopify)
    - [BigCommerce](https://support.kangaroorewards.com/knowledge/kangaroo-apps?hsLang=en#bigcommerce)
    - [WooCommerce](https://support.kangaroorewards.com/knowledge/kangaroo-apps?hsLang=en#woocommerce)
    - [Magento V2](https://support.kangaroorewards.com/knowledge/kangaroo-apps?hsLang=en#magento-v2)
    - [Lightspeed Ecom](https://support.kangaroorewards.com/knowledge/kangaroo-apps?hsLang=en#lightspeed-ecom)
    - [Ecwid (E-Series)](https://support.kangaroorewards.com/knowledge/kangaroo-apps?hsLang=en#ecwid-e-series)
    - [Lightspeed Retail](https://support.kangaroorewards.com/knowledge/kangaroo-apps?hsLang=en#lightspeed-retail)
    - [Lightspeed X series](https://support.kangaroorewards.com/knowledge/kangaroo-apps?hsLang=en#lightspeed-x-series)
    - [Lightspeed K Series](https://support.kangaroorewards.com/knowledge/kangaroo-apps?hsLang=en#lightspeed-k-series)
    - [Lightspeed L series](https://support.kangaroorewards.com/knowledge/kangaroo-apps?hsLang=en#lightspeed-l-series)
    - [Heartland](https://support.kangaroorewards.com/knowledge/kangaroo-apps?hsLang=en#heartland)
    - [Gorgias](https://support.kangaroorewards.com/knowledge/kangaroo-apps?hsLang=en#gorgias)
    - [Judge.me](https://support.kangaroorewards.com/knowledge/kangaroo-apps?hsLang=en#judge-me)
    - [Ecomz](https://support.kangaroorewards.com/knowledge/kangaroo-apps?hsLang=en#ecomz)
    - [Amazon Business](https://support.kangaroorewards.com/knowledge/kangaroo-apps?hsLang=en#amazon-business)
- [Email/SMS/Push Marketing](https://support.kangaroorewards.com/knowledge/email-sms-push-marketing?hsLang=en#main-content)

    - [Consent](https://support.kangaroorewards.com/knowledge/email-sms-push-marketing?hsLang=en#consent)
    - [Campaign Reporting](https://support.kangaroorewards.com/knowledge/email-sms-push-marketing?hsLang=en#campaign-reporting)
    - [Text - SMS Best Practices](https://support.kangaroorewards.com/knowledge/email-sms-push-marketing?hsLang=en#text-sms-best-practices)
    - [Text - SMS](https://support.kangaroorewards.com/knowledge/email-sms-push-marketing?hsLang=en#text-sms)
    - [Email](https://support.kangaroorewards.com/knowledge/email-sms-push-marketing?hsLang=en#email)
    - [Push](https://support.kangaroorewards.com/knowledge/email-sms-push-marketing?hsLang=en#push)
    - [Schedule Campaign](https://support.kangaroorewards.com/knowledge/email-sms-push-marketing?hsLang=en#schedule-campaign)
    - [Export List](https://support.kangaroorewards.com/knowledge/email-sms-push-marketing?hsLang=en#export-list)
    - [Purchasing Credits](https://support.kangaroorewards.com/knowledge/email-sms-push-marketing?hsLang=en#purchasing-credits)
    - [A/B Testing](https://support.kangaroorewards.com/knowledge/email-sms-push-marketing?hsLang=en#a-b-testing)
- [Workflows](https://support.kangaroorewards.com/knowledge/workflows?hsLang=en#main-content)

    - [Workflows](https://support.kangaroorewards.com/knowledge/workflows?hsLang=en#workflows)
- [Kangaroo Business Portal App](https://support.kangaroorewards.com/knowledge/kangaroo-business-portal-app?hsLang=en#main-content)

    - [Offer business portal app](https://support.kangaroorewards.com/knowledge/kangaroo-business-portal-app?hsLang=en#offer-business-portal-app)
    - [Rewards business portal app](https://support.kangaroorewards.com/knowledge/kangaroo-business-portal-app?hsLang=en#rewards-business-portal-app)
    - [Marketing business portal app](https://support.kangaroorewards.com/knowledge/kangaroo-business-portal-app?hsLang=en#marketing-business-portal-app)
    - [Earning Rule Kangaroo business portal app](https://support.kangaroorewards.com/knowledge/kangaroo-business-portal-app?hsLang=en#earning-rule-kangaroo-business-portal-app)
    - [Insights](https://support.kangaroorewards.com/knowledge/kangaroo-business-portal-app?hsLang=en#insights)
- [Points](https://support.kangaroorewards.com/knowledge/points?hsLang=en#main-content)

    - [Tablet Earning](https://support.kangaroorewards.com/knowledge/points?hsLang=en#tablet-earning)
    - [Earning points in Lightspeed](https://support.kangaroorewards.com/knowledge/points?hsLang=en#earning-points-in-lightspeed)
    - [A La Carte for Integrations (Lightspeed POS, Ecommerce, Shopify POS)](https://support.kangaroorewards.com/knowledge/points?hsLang=en#a-la-carte-for-integrations-lightspeed-pos-ecommerce-shopify-pos)
    - [Tiers](https://support.kangaroorewards.com/knowledge/points?hsLang=en#tiers)
    - [Reviews](https://support.kangaroorewards.com/knowledge/points?hsLang=en#reviews)
- [Redeeming points](https://support.kangaroorewards.com/knowledge/redeeming-points?hsLang=en#main-content)

    - [Tablet Redemption](https://support.kangaroorewards.com/knowledge/redeeming-points?hsLang=en#tablet-redemption)
    - [Redemption On Lightspeed Retail POS](https://support.kangaroorewards.com/knowledge/redeeming-points?hsLang=en#redemption-on-lightspeed-retail-pos)
    - [Redemption For E-Commerce](https://support.kangaroorewards.com/knowledge/redeeming-points?hsLang=en#redemption-for-e-commerce)
    - [Partner Rewards](https://support.kangaroorewards.com/knowledge/redeeming-points?hsLang=en#partner-rewards)
- [Offers](https://support.kangaroorewards.com/knowledge/offers?hsLang=en#main-content)

    - [Offer Settings](https://support.kangaroorewards.com/knowledge/offers?hsLang=en#offer-settings)
    - [Redeeming Offers](https://support.kangaroorewards.com/knowledge/offers?hsLang=en#redeeming-offers)
    - [Lightspeed Conditional Offers](https://support.kangaroorewards.com/knowledge/offers?hsLang=en#lightspeed-conditional-offers)
    - [E-Commerce Offers](https://support.kangaroorewards.com/knowledge/offers?hsLang=en#e-commerce-offers)
- [Tiers](https://support.kangaroorewards.com/knowledge/tiers?hsLang=en#main-content)

    - [Tier Earning Rules](https://support.kangaroorewards.com/knowledge/tiers?hsLang=en#tier-earning-rules)
    - [Override](https://support.kangaroorewards.com/knowledge/tiers?hsLang=en#override)
    - [Tier Calculation](https://support.kangaroorewards.com/knowledge/tiers?hsLang=en#tier-calculation)
- [Referrals](https://support.kangaroorewards.com/knowledge/referrals?hsLang=en#main-content)

    - [Tablet Referrals](https://support.kangaroorewards.com/knowledge/referrals?hsLang=en#tablet-referrals)
    - [Kiosk Tablet Referrals](https://support.kangaroorewards.com/knowledge/referrals?hsLang=en#kiosk-tablet-referrals)
    - [Link Referrals](https://support.kangaroorewards.com/knowledge/referrals?hsLang=en#link-referrals)
    - [E-Commerce Referrals](https://support.kangaroorewards.com/knowledge/referrals?hsLang=en#e-commerce-referrals)
    - [App Referrals](https://support.kangaroorewards.com/knowledge/referrals?hsLang=en#app-referrals)
    - [Branded App Referrals](https://support.kangaroorewards.com/knowledge/referrals?hsLang=en#branded-app-referrals)
- [Branding](https://support.kangaroorewards.com/knowledge/branding?hsLang=en#main-content)

    - [Slideshow](https://support.kangaroorewards.com/knowledge/branding?hsLang=en#slideshow)
    - [App Colors](https://support.kangaroorewards.com/knowledge/branding?hsLang=en#app-colors)
- [Release Notes](https://support.kangaroorewards.com/knowledge/release-notes?hsLang=en)
- [Rules](https://support.kangaroorewards.com/knowledge/rules?hsLang=en#main-content)

    - [E-Commerce Rules](https://support.kangaroorewards.com/knowledge/rules?hsLang=en#e-commerce-rules)
    - [Multi-Factor Authentication (MFA)](https://support.kangaroorewards.com/knowledge/rules?hsLang=en#multi-factor-authentication-mfa)
    - [A La Carte](https://support.kangaroorewards.com/knowledge/rules?hsLang=en#a-la-carte)
- [Customers](https://support.kangaroorewards.com/knowledge/customers?hsLang=en#main-content)

    - [Tags](https://support.kangaroorewards.com/knowledge/customers?hsLang=en#tags)
    - [Customers](https://support.kangaroorewards.com/knowledge/customers?hsLang=en#customers)
- [Gamification](https://support.kangaroorewards.com/knowledge/gamification?hsLang=en#main-content)

    - [Draw](https://support.kangaroorewards.com/knowledge/gamification?hsLang=en#draw)
    - [Spin To Win](https://support.kangaroorewards.com/knowledge/gamification?hsLang=en#spin-to-win)
- [Gift Cards](https://support.kangaroorewards.com/knowledge/gift-cards?hsLang=en#main-content)

    - [Purchasing Gift Cards](https://support.kangaroorewards.com/knowledge/gift-cards?hsLang=en#purchasing-gift-cards)
    - [App Gift Cards](https://support.kangaroorewards.com/knowledge/gift-cards?hsLang=en#app-gift-cards)
- [Analytics](https://support.kangaroorewards.com/knowledge/analytics?hsLang=en#main-content)

    - [Dashboard](https://support.kangaroorewards.com/knowledge/analytics?hsLang=en#dashboard)
    - [Marketing](https://support.kangaroorewards.com/knowledge/analytics?hsLang=en#marketing)
- [Branches](https://support.kangaroorewards.com/knowledge/branches?hsLang=en#main-content)

    - [Employees](https://support.kangaroorewards.com/knowledge/branches?hsLang=en#employees)
- [Kiosk](https://support.kangaroorewards.com/knowledge/kiosk?hsLang=en)
- [Frequent Buyers Program](https://support.kangaroorewards.com/knowledge/frequent-buyers-program?hsLang=en)
- [Surveys](https://support.kangaroorewards.com/knowledge/surveys?hsLang=en)
- [Merchant App](https://support.kangaroorewards.com/knowledge/merchant-app?hsLang=en)
- [White Label App](https://support.kangaroorewards.com/knowledge/white-label-app?hsLang=en#main-content)

    - [QR code Integration](https://support.kangaroorewards.com/knowledge/white-label-app?hsLang=en#qr-code-integration)
- [Business portal](https://support.kangaroorewards.com/knowledge/business-portal?hsLang=en#main-content)

    - [Upload Clients](https://support.kangaroorewards.com/knowledge/business-portal?hsLang=en#upload-clients)
    - [Transaction List](https://support.kangaroorewards.com/knowledge/business-portal?hsLang=en#transaction-list)
    - [Branches](https://support.kangaroorewards.com/knowledge/business-portal?hsLang=en#branches)
- [Subscription](https://support.kangaroorewards.com/knowledge/subscription?hsLang=en)
- [Points Earning](https://support.kangaroorewards.com/knowledge/points-earning?hsLang=en)
- [Members App](https://support.kangaroorewards.com/knowledge/members-app?hsLang=en#main-content)

    - [Web App](https://support.kangaroorewards.com/knowledge/members-app?hsLang=en#web-app)
    - [Mobile App](https://support.kangaroorewards.com/knowledge/members-app?hsLang=en#mobile-app)
- [New Business Portal](https://support.kangaroorewards.com/knowledge/new-business-portal?hsLang=en#main-content)

    - [Marketing](https://support.kangaroorewards.com/knowledge/new-business-portal?hsLang=en#marketing)
- [Business Profile](https://support.kangaroorewards.com/knowledge/business-profile?hsLang=en#main-content)

    - [Branches](https://support.kangaroorewards.com/knowledge/business-profile?hsLang=en#branches)
    - [Social Media](https://support.kangaroorewards.com/knowledge/business-profile?hsLang=en#social-media)
- [Import Transaction](https://support.kangaroorewards.com/knowledge/import-transaction?hsLang=en#main-content)

    - [Import Transactions](https://support.kangaroorewards.com/knowledge/import-transaction?hsLang=en#import-transactions)
- [One-Pagers](https://support.kangaroorewards.com/knowledge/one-pagers?hsLang=en#main-content)

    - [Marketing](https://support.kangaroorewards.com/knowledge/one-pagers?hsLang=en#marketing)
    - [Referral](https://support.kangaroorewards.com/knowledge/one-pagers?hsLang=en#referral)
    - [Integration](https://support.kangaroorewards.com/knowledge/one-pagers?hsLang=en#integration)
    - [Gift Cards](https://support.kangaroorewards.com/knowledge/one-pagers?hsLang=en#gift-cards)
    - [Kiosk Mode](https://support.kangaroorewards.com/knowledge/one-pagers?hsLang=en#kiosk-mode)
    - [App Colors](https://support.kangaroorewards.com/knowledge/one-pagers?hsLang=en#app-colors)
    - [Branches](https://support.kangaroorewards.com/knowledge/one-pagers?hsLang=en#branches)
    - [Products](https://support.kangaroorewards.com/knowledge/one-pagers?hsLang=en#products)
    - [Customer Management](https://support.kangaroorewards.com/knowledge/one-pagers?hsLang=en#customer-management)
    - [Business Portal](https://support.kangaroorewards.com/knowledge/one-pagers?hsLang=en#business-portal)
    - [Rules](https://support.kangaroorewards.com/knowledge/one-pagers?hsLang=en#rules)
    - [E-Commerce](https://support.kangaroorewards.com/knowledge/one-pagers?hsLang=en#e-commerce)
    - [Merchant App](https://support.kangaroorewards.com/knowledge/one-pagers?hsLang=en#merchant-app)
    - [Enrollment](https://support.kangaroorewards.com/knowledge/one-pagers?hsLang=en#enrollment)
    - [Security & Privacy](https://support.kangaroorewards.com/knowledge/one-pagers?hsLang=en#security-privacy)
- [FAQ](https://support.kangaroorewards.com/knowledge/faq?hsLang=en#main-content)

    - [FAQ- Lightspeed R Series](https://support.kangaroorewards.com/knowledge/faq?hsLang=en#faq-lightspeed-r-series)
    - [FAQ- Shopify POS](https://support.kangaroorewards.com/knowledge/faq?hsLang=en#faq-shopify-pos)
    - [FAQ- Shopify ECOM](https://support.kangaroorewards.com/knowledge/faq?hsLang=en#faq-shopify-ecom)
    - [FAQ- Lightspeed ECOM](https://support.kangaroorewards.com/knowledge/faq?hsLang=en#faq-lightspeed-ecom)
    - [FAQ - WooCommerce](https://support.kangaroorewards.com/knowledge/faq?hsLang=en#faq-woocommerce)
    - [FAQ - Standalone](https://support.kangaroorewards.com/knowledge/faq?hsLang=en#faq-standalone)
    - [FAQ - BigCommerce](https://support.kangaroorewards.com/knowledge/faq?hsLang=en#faq-bigcommerce)
    - [FAQ - Magento](https://support.kangaroorewards.com/knowledge/faq?hsLang=en#faq-magento)
    - [Kangaroo Booking](https://support.kangaroorewards.com/knowledge/faq?hsLang=en#kangaroo-booking)
    - [FAQ-Heartland](https://support.kangaroorewards.com/knowledge/faq?hsLang=en#faq-heartland)
    - [FAQ - Judge.me](https://support.kangaroorewards.com/knowledge/faq?hsLang=en#faq-judge-me)
    - [FAQ- Lightspeed X Series](https://support.kangaroorewards.com/knowledge/faq?hsLang=en#faq-lightspeed-x-series)
    - [FAQ- Lightspeed K Series](https://support.kangaroorewards.com/knowledge/faq?hsLang=en#faq-lightspeed-k-series)
    - [FAQ- Lightspeed L Series](https://support.kangaroorewards.com/knowledge/faq?hsLang=en#faq-lightspeed-l-series)
    - [FAQ - Lightspeed E Series (Ecwid)](https://support.kangaroorewards.com/knowledge/faq?hsLang=en#faq-lightspeed-e-series-ecwid)
    - [FAQ - MindBody POS](https://support.kangaroorewards.com/knowledge/faq?hsLang=en#faq-mindbody-pos)
- [API](https://support.kangaroorewards.com/knowledge/api?hsLang=en)
- [Kangaroo Reviews](https://support.kangaroorewards.com/knowledge/kangaroo-reviews?hsLang=en#main-content)

    - [General Settings](https://support.kangaroorewards.com/knowledge/kangaroo-reviews?hsLang=en#general-settings)
    - [Reviews Widget](https://support.kangaroorewards.com/knowledge/kangaroo-reviews?hsLang=en#reviews-widget)
    - [Reviews Carousel](https://support.kangaroorewards.com/knowledge/kangaroo-reviews?hsLang=en#reviews-carousel)
    - [Manage Reviews](https://support.kangaroorewards.com/knowledge/kangaroo-reviews?hsLang=en#manage-reviews)
- [Live Geo-Tracking](https://support.kangaroorewards.com/knowledge/live-geo-tracking?hsLang=en#main-content)

    - [Live - Geo](https://support.kangaroorewards.com/knowledge/live-geo-tracking?hsLang=en#live-geo)
- [Receipt Scanning](https://support.kangaroorewards.com/knowledge/receipt-scanning?hsLang=en)

[![Chill listening crop-3](https://support.kangaroorewards.com/hs-fs/hubfs/Kangaroo-Rewards-App-Icon-BLUE-Oct-01-2025-07-44-40-4707-PM.png?width=24&height=24&name=Kangaroo-Rewards-App-Icon-BLUE-Oct-01-2025-07-44-40-4707-PM.png "Chill listening crop-3")](http://www.kangaroorewards.com)

www.kangaroorewards.com Help Center

<https://www.facebook.com/KangarooRewards/> <https://www.instagram.com/kangaroorewards> <https://www.youtube.com/@kangaroorewards> <https://www.linkedin.com/company/kangaroorewards>

Copyright © 2026, © Kangaroo Rewards