This guide walks you through how to properly commission users that have made purchases via your platform. We’ll specifically cover:
org-xxx) via our Merchants API and Brand commission rates via our Rates API.
Commissioning in a loyalty setting typically comes in the form of a Publisher offering an incentive to a user for shopping at a Brand. This incentive can be cash-back, or another type of currency (e.g. points, miles).
In order for the value proposition to resonate with both you and the user, the commission earned for making a purchase is split between both parties.
Below is an example of how to set up commissioning logic where you pay your users a flat percentage of the commission you receive. Here are the steps to do this:
commerce_organizationfrom the transaction and look up the corresponding User Payout % from your CMS.
amount. This will give you the commission that the user has earned, and you can now give the user that amount in the form of a pending reward.
button_order_id) but with
status=validated, you can now convert the user’s commission from “pending” to “finalized”.
Here is a sample flow for Brand123 (the example Brand in the table below):
Calculate the user's commission rate for Brand123. For this example, the User Payout % is 90%. Multiply the
amount (i.e. the commission amount) by the User Payout %. Then, use the
floor function to round this to a whole number. For example, for Toys, you would take 7% and multiple by 90% to arrive at 6.3%. Then, apply the
floor function to arrive at 6% (e.g.
FLOOR(7% * 90%) = 6%). In this example, the user's commission rates would be:
The user makes a purchase and you receive a webhook - or pull via the Transactions API - and the transaction is in a
pending state (e.g.
status=pending). For example, the user spends $300 total: $100 on Toys, $100 on Clothing, $100 on Electronics.
Once the transaction finalizes, you will receive a webhook – or pull via the Transactions API – notifying you of this update with
status=validated. You can now: