Skip to main content
POST
Redeem Credits

Authorizations

Authorization
string
header
required

A consumer access token, issued to a single person in the browser or app. Not a client access token - never send a client token from a consumer device.

Body

data
object
required

What to redeem and what to redeem it for.

event_name
enum<string>
required

Always redeem_rewards. This event is what the reward bank listens for.

Available options:
redeem_rewards

Response

Success

Acceptance of the event, not the result of the redemption. A redemption that cannot go through - too little balance, a reward no longer redeemable - still answers here and fails afterwards.

id
string
required

Identifier of the redeem event. The outcome is published as a signal named success or error against reward-, and an error signal carries the reason in its data.message. The browser library renames this field to event_id, so a caller reading the raw response reads id.