POST /codes
campaign_id
values.value
- value of points the code is worthcampaign_id
- all the IDs for your campaigns will be provided by uslength
- optional. Length of the code to generate.9
9
email
- optional. If an email is passed we will also send the user an email with the code generated. You can choose a template or make a new one. Defaults to null
. The email will be validated, failing which, it returns a 400. To send out emails via qiibee, please write to us at [email protected].language
- optional. Language for the email. Defaults to en
reference_id
- optional. type: string
. HTTP 201
and the code:HTTP 400
HTTP 409
when reference_id
was already usedPOST /nfts
GET /nfts
user_auth_id
: (mandatory) the auth_id of the user who owns the NFTs.status
: (optional) the status of the NFT. If not sent, it will query the NFTs irrespective of their status. The status can only be one of [null, "pending", "approved", "rejected"]
.GET /rewards/:reward
transaction
, used_at
, anduser_id
if it has already been sent to a user. erc20
is a regular tokenerc721
is an NFT tokenAAA represents that the token is operational worldwide.
HTTP 200
with data in the following format:HTTP 404
with error messagePUT /rewards/:reward
| PATCH /rewards/:reward
used_at
property to the UTC time of the request.erc20
is a regular tokenerc721
is an NFT tokenAAA represents that the token is operational worldwide.
HTTP 200
with data in the following format:HTTP 409
HTTP 404
with error messagePOST /transactions
points_to_rewards
- redeem points for a reward like a discount coupon400
.amount
can be an integer or string.HTTP 202
HTTP 400
HTTP 404
with error messageGET /transactions
limit
: (optional) sets the required limit of transaction history to be requested.100
100
offset
: (optional) number of transactions to offset when getting the remaining transactions.0
user_auth_id
: (optional) Use this parameter to query transactions for a particular user of your brand. If not passed returns all the transactions for your brand. Can be used along with limit
and offset.
types
: (optional) Use this parameter to query transactions for specific loyalty event types. The events must be sent in a list.token_id
: (optional) This will let you query the transactions for a specific token ID.erc20
is a regular tokenerc721
is an NFT tokenAAA
represents that the token is operational worldwide.HTTP 200
with data in the following format:transactions
list will be returned. total_tx_count
is the total number of transactions available for the given params.HTTP 404
with error message