Benefits

Here is where all the Benefits are gonna be managed

Create an Benefit

POST/api/v1/benefit

Authorization

JWT

Body

application/json

name*string

Name of the benefit

discountPercentagenumber

Discount percentage multiplied by 100. Therefore, to create a benefit that gives a 10% discount, an input of 1000 is required for this property

givesWhitelistAccess*boolean

If this benefit gives whitelist access

maxUsageLimit*number

The max amount of times this benefit can be used by a user

Response

201

Request

JavaScriptCurl

const response = await fetch('/api/v1/benefit', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "givesWhitelistAccess": false,
      "maxUsageLimit": 0
    }),
});
const data = await response.json();

Get detailed Benefit info

GET/api/v1/benefit/{id}/manage

Authorization

JWT

Path parameters

id*string

Response

200

Request

JavaScriptCurl

const response = await fetch('/api/v1/benefit/{id}/manage', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

List Benefits

GET/api/v1/benefit/manage

Authorization

JWT

Query parameters

Response

200

Request

JavaScriptCurl

const response = await fetch('/api/v1/benefit/manage', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Check if a user has access to your Benefits

POST/api/v1/benefit/check/manage

Authorization

JWT

Body

application/json

userWallets*array of string

Array of wallets that are gonna be checked to see if they have access to a benefit

Response

201

Body

application/json

object

Request

JavaScriptCurl

const response = await fetch('/api/v1/benefit/check/manage', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "userWallets": [
        "text"
      ]
    }),
});
const data = await response.json();

Update an Benefit

PATCH/api/v1/benefit/{id}

Authorization

JWT

Path parameters

id*string

Body

application/json

namestring

Name of the benefit

discountPercentagenumber

Discount percentage multiplied by 100. Therefore, to create a benefit that gives a 10% discount, an input of 1000 is required for this property

givesWhitelistAccess*boolean

If this benefit gives whitelist access

Response

200

Request

JavaScriptCurl

const response = await fetch('/api/v1/benefit/{id}', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "givesWhitelistAccess": false
    }),
});
const data = await response.json();

Remove an Benefit

DELETE/api/v1/benefit/{id}

Authorization

JWT

Path parameters

id*string

Response

200

Request

JavaScriptCurl

const response = await fetch('/api/v1/benefit/{id}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();