# API docs

{% hint style="info" %}
If you need any help please feel free to reach out to us via the support chat anytime. 

Please use API v2.0 to make your integrations. 
{% endhint %}

{% embed url="<https://docs.digitalwallet.cards>" %}
API v2.0 docs (follow the link to open the documentation of the open API)
{% endembed %}

### 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)&#x20;

**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

**Promotions endpoints**\
GET /api/v2/promotions – paginated list (filters: templateId, active).\
GET /api/v2/promotions/{id} – single promotion.\
POST /api/v2/promotions – create (201 + created promotion).\
PATCH /api/v2/promotions/{id} – partial update.\
DELETE /api/v2/promotions/{id} – delete.

<br>

### 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:**

```json
{
  "rewards": 1,
  "comment": "Reward redeemed",
  "purchaseSum": 10.5
}
```

* `rewards` → number of rewards to subtract
* `comment` → optional note for the transaction
* `purchaseSum` → 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

<figure><img src="https://lh7-rt.googleusercontent.com/docsz/AD_4nXdCjYUz3-43J83_yc3xCV4vNs7cOc-vt2Ox2ZxJvYnKWX2q3wGRAMevbXpNoaAxKPfse2EXnbg_ipXK5q61uFopAA9QjDwkUnHH3P3LFKwYcpiDTivCURwBmI-Ca2Y8GGGKGOUT?key=9zJxIuYDoSLeJyuZJP0C-5Le" alt=""><figcaption></figcaption></figure>

Next click on integrations at the top.

<figure><img src="https://lh7-rt.googleusercontent.com/docsz/AD_4nXdAPaIfhmJvOVWGiFMiA86DHJoXMHJuVx4A5xk6d-slCVSr5V31LxEr3QIhSZxf3rXDqxD_zRCUiuTIl_VCfvFW2IDno_jzmzGFP5FMyiYfX4_Fi3O1SUinq00YIpcH6zga0jEwFA?key=9zJxIuYDoSLeJyuZJP0C-5Le" alt=""><figcaption></figcaption></figure>

Then copy your Api key.

<figure><img src="https://lh7-rt.googleusercontent.com/docsz/AD_4nXf3GoYBK5CMkA-OaTZ-S2pF6-ynxrdBFGGmIqldoY3-wSysx1Kggzc4y4P5I2Nf0NFynrKaw61U_YppTjNpZzfZsIJD4k1KoBvfxFlEmlpRao6znS81pZr6FaVsRE7U3GLEMWDj?key=9zJxIuYDoSLeJyuZJP0C-5Le" alt=""><figcaption></figcaption></figure>

**For subaccounts**, you need to click on the settings icon, select integrations at the top, scroll down and copy your Api key.

<figure><img src="https://lh7-rt.googleusercontent.com/docsz/AD_4nXciD4iipXno2IY9p4vzkfhU7M01xxiGyZ1mZD_6c2q73v4UkdBIk90pzXqBVPbyh4xDrPbn5ig-gNM14tHZ-UATxbD1JWGrUK0GhVL9JzIVjHkiPvku8g3BwZgfo7XTklDiZAvK9g?key=9zJxIuYDoSLeJyuZJP0C-5Le" alt=""><figcaption></figcaption></figure>

### API Rate Limit and Behavior When Exceeded

Api call rate - request rate is 10 request per second. That's 600 requests per minute.

If a client exceeds this threshold, any additional requests during that period will be rejected with an HTTP 429 “Too Many Requests” response. This indicates that the rate limit has been reached and the client must slow down the request frequency.\
At the moment, the rate limit is fixed and cannot be increased. Developers should implement retry logic or queueing mechanisms to avoid hitting the threshold.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.boomerangme.cards/api/api-docs.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.