Promotions guide
What this resource is for
Promotions are the active offers on brands. They can include enhanced commission, increased cashback or time-limited deals. For gift card publishers, each promotion carries the promotion-id you use to buy a card.
When to use it
- Show current offers to customers.
- Find the
promotion-idneeded for a gift card purchase. - Filter offers by date window.
Important implementation notes
- Promotion availability can change independently of brand availability.
- Refresh regularly, and do not build screens from a stale copy.
- Results are paginated at 100 per page. Follow the next link.
- The
promotion-idis the value to send aspromo_idinpaymentLinkandgiftCardRequestApi.
Bash
curl "https://staging-api.spendstream.io/v2/getPromotionsList?page=1" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "User-Agent: YourApp/1.0"
Common mistakes
- Using the
brand-idwhere apromotion-idis required. - Using the older
getPromotionsendpoint. It is deprecated and has no v2 route, so usegetPromotionsList. - Forgetting that an offer may have expired since you last fetched it.
Related resources
- Brands
- Gift Cards
- Payments
- Cashback
Endpoint reference
The v2 endpoint for this resource is getPromotionsList. Exact parameters, schemas and responses are in the API reference.
Was this section helpful?
On this page
- Promotions guide