Spendstream

Spendstream's REST API V2

Authentication

Exchange API credentials for a bearer token valid for 10 hours.

Users

List users registered against the calling publisher.

Register a new end-user against the calling publisher.

Update attributes on an existing user record.

Record a user activity log entry against a token.

Set a user's email-reminder opt-in preference.

Brands

List the brand catalogue available to the calling publisher.

Promotions

List active promotions (flat, minimal) — deprecated.

List active promotions with embedded brand detail.

Cashback

List active affiliate commission offers (primary variant).

List brand categories.

Transactions

List transactions attributable to the calling publisher's users.

Get a user's aggregated transaction summary.

Flag an affiliate transaction as paid to the end-user.

Gift Cards

Process a gift card fulfilment from a pre-existing order in the publisher's database.

Issue a gift card directly via the API (self-contained request).

Check the remaining balance on an issued gift card.

Balances

Check the calling publisher's prepaid float balance.

Payments

Generate a hosted payment gateway URL for a gift card purchase.

Webhooks

{$request.body#/webhook_url}

Default

V2.01 Spendstream API & Developer Hub

Production

Staging

**Callback:** transactionUpdated

**Expression:** `{$request.body#/webhook_url}`



Payload of a `TRANSACTION_UPDATED` webhook. The envelope differs by publisher type —
Gift Card publishers receive the gift-card variant with `gift-card-url` and
`free-entries`; Affiliate publishers receive the affiliate variant with commission
breakdown and `status`.

**Float-mode balance field (PR #361/#363, commits 6e10f1a→3f3ffe6):** gift-card webhooks for
*float*-funded purchases by payment-gateway publishers may carry an additional
`available-balance` field — the publisher's remaining prepaid float after the purchase. It is
emitted only when the post-purchase float is positive; confirm on your first delivery.

**Note on encoding:** the canonical Webhooks Definitions doc shows the inner
`transaction` value as a stringified JSON. Check your first delivery to confirm
whether it arrives as a nested object or a stringified object; if stringified,
`JSON.parse()` before processing.


oneOf

X-Webhook-Event

X-Webhook-Signature

Unique identifier for this webhook delivery

X-Webhook-ID

The callback URL expression that receives this request

X-Callback-URL

Authorization

Set to `true` to confirm receipt. Optional — any 2xx response is treated as success.

received

eventType

transaction

Sections

{$request.body#/webhook_url}

Header Parameters

Body Parameters

Response

Response Attributes

Response

Sections

{$request.body#/webhook_url}

Header Parameters

Body ParametersExpand all

Response

Response Attributes

Response

Ask an AI

Code with AI

Body Parameters