TokenOS
Search
K
Comment on page

Codes

Codes are used to credit users with $TOKENs. Each code has two required parameters, a reward amount and total number of times the code can be redeemed.

The code object

This object represents a code. It lets you retrieve information about the code including amount, status, redemptions, and redemptions remaining.

Retrieve code

get
http://localhost:8080/v1
/codes/{codeId}
Get token code status

Redeem code for user

For a more seamless UX, you can instantly credit a user by redeeming a code on their behalf.
post
http://localhost:8080/v1
/codes/redemptions
Redeem a token code for a user