Report a reward used at your checkout

Send once the order is paid. Oyster counts the use, and the reward is marked redeemed when
it has no uses left. Enforce the terms and usage limit in your checkout before taking
payment: this records a use, it does not approve one.

Safe to retry. The same reward_id and order_id return the original receipt, so never
send a new order_id to retry the same payment. A paid use can be reported after the
reward expires, or after you unregister.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
uuid
required

From the wheel.reward_won event.

string
required
length ≤ 191

Your order reference. One use per order.

number
required
0 to 100000000

What the reward took off the order, in major units of currency.

string
required
length between 3 and 3
date-time
required

When payment completed. Not in the future.

Responses

401

Unauthenticated

403

The key is not granted wheel:rewards

404

No reward with this id was issued for your checkout

422

Invalid payload, a currency other than the reward's, or no uses left

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json