πAPI docs
Make your own integration with 3rd party software
API 2.0 methods
Types of cards (notation):
Stamp - ID 0 Cashback - ID 1 Multipass - ID 2 Coupon - ID 3 Discount - ID 4 Gift - ID 5 Membership - ID 6 Reward - ID 7
Add amount to card Applicable to Cashback card (card ID 1)
Add point to card Applies to Discount, Cashback, Certificate cards (card IDs 4, 1, 5)
Add reward to card Applicable to Stamp card (card ID 0)
Add scores to card Applies to Reward cards with the mechanics type βPointsβ, Multipass (card ID 7, 2)
Add stamp to card Applies to Stamp card (card ID 0)
Add visit to card Applies to Multipass card (card ID 2), membership card WITHOUT LIMITS (card ID 6), stamp card (card ID 0) with visit mechanics, rewards card (card ID 7) with visit mechanics.
Add purchase to card (add amount to card) Applies to stamp card (card ID 0) with spend mechanics, reward card (card ID 7) with spend mechanics.
Receive reward (receive reward by client) Applicable to Reward card (card ID 7)
Redeem coupon Applies to Coupon card (card ID 3)
Subtract amount from card Applies to Cashback card (card ID 1)
Subtract point from card Applies to Discount, Cashback, Certificate cards (card IDs 4, 1, 5)
Subtract reward from card Applicable to Stamp card (card ID 0)
Subtract scores from card (Subtract points from card) Applies to Reward cards, Multipass cards (card IDs 7, 2)
Subtract stamp from card Applies to Stamp card (card ID 0)
Subtract visit to card (add visits to card) Applies to Multipass card (card ID 2), Membership card WITH LIMITS (card ID 6)
List of cards - Get list of cards Create card for customer - Issue card for customer Get card - Get information on a certain card by its number. Delete card - Deleting a card by its number GET companies - Get list of company's sub-accounts GET companies/{id} - Get information about a specific sub-account by its ID.
POST Create company - Create a company POST companies/{id}/change-tariff - Change a company's tariff PATCH companies/{id} - Change company information List of customers - Get list of customers GET customers/{id} - Get information about one customer by its ID Create customer - Create a customizer
PATCH customers/{id} - Change the data of a customer DELETE customers/{id} - Delete a customer by its ID List of operations - Get list of operations Get push - Get push by its ID List of pushes - Get list of pushes Send push - Send Push Get tariff - Get information about a reseller's tariff by its ID List of tariffs - Get a list of reseller's tariffs Get template - Get information about the card template by its ID List of templates - Get a list of company card templates
Redeeming Rewards with Cost (Stamp Cards)
In the Scanner App, when redeeming a reward, you can manually enter its cost. This amount is added to the customerβs LTV (Lifetime Value).
You can achieve the same behavior through the API using the Subtract reward from card method.
Example:
{
"rewards": 1,
"comment": "Reward redeemed",
"purchaseSum": 10.5
}rewardsβ number of rewards to subtractcommentβ optional note for the transactionpurchaseSumβ the monetary value of the redeemed reward (included in LTV)
β οΈ Important: The API does not automatically retrieve the predefined reward price from the card settings. You must specify the reward value manually in the purchaseSum field.
At the moment, only the Boomerang API supports passing the reward value this way. Third-party integrations (Zapier, Pabbly, etc.) cannot fetch reward costs directly; they only transmit the data that you configure.
How to find your Api Key
To find your Api key, click on the settings icon. Note for agencies, you need to click on the user icon before clicking on settings
Next click on integrations at the top.
Then copy your Api key.
For subaccounts, you need to click on the settings icon, select integrations at the top, scroll down and copy your Api key.
β Api call rate - request rate is 10 request per second. That's 600 requests per minute.
Last updated
Was this helpful?