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
Authorizations
OAuth2clientCredentialsRequired
Token URL:
Path parameters
codeIdstringRequired
Responses
200
Ok
application/json
get
/codes/{codeId}GET /v1/codes/{codeId} HTTP/1.1
Host: localhost:8080
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
200
Ok
{
"status": "ACTIVE",
"redemptions": 1,
"reward": 1,
"number": 1
}Redeem code for user
For a more seamless UX, you can instantly credit a user by redeeming a code on their behalf.
Authorizations
OAuth2clientCredentialsRequired
Token URL:
Body
userany ofRequired
or
or
codeIdstringRequired
Responses
200
Ok
No content
post
/codes/redemptionsPOST /v1/codes/redemptions HTTP/1.1
Host: localhost:8080
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 51
{
"user": {
"email": "name@gmail.com"
},
"codeId": "text"
}200
Ok
No content
Last updated