Cashback guide
What this resource is for
Cashback is the affiliate offer catalogue. Offers can include the customer-facing cashback rate, your client-commission, customer-facing terms, tracking links, and brand and category information.
When to use it
- Build an affiliate offers page for an Affiliate publisher.
- Show customers the rate they can earn at each retailer.
- Retrieve tracking links to send customers to a retailer.
Important implementation notes
- This endpoint lists offers. It does not return per-user transactions. Use the transactions resource for that.
- Transactions are not usually confirmed immediately. They move through pending, approved, declined or amended states.
- Results are paginated at 50 per page. Follow the next link.
- Rates and terms change, so refresh regularly and do not hard-code them.
Bash
curl "https://staging-api.spendstream.io/v2/getCashback?page=1" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "User-Agent: YourApp/1.0"
Common mistakes
- Showing a pending amount as if it were final.
- Treating a customer’s return to your site as a confirmed sale. Rely on
TRANSACTION_UPDATEDinstead. - Sending customers to a link without their user identifier attached, which breaks attribution.
Related resources
- Brands
- Categories
- Transactions
- Affiliate offers and cashback
Endpoint reference
The v2 endpoints for this resource are getCashback and voucherCodes. Exact parameters, schemas and responses are in the API reference.
Was this section helpful?
On this page
- Cashback guide