Entity Credit Tier | Quest Protocol

Quest Protocol

Make payment

This endpoint allows to make payment.

post

/payment/pay

Header parameters

apikeystringrequired

The API key for authentication

Example: test

apisecretstring

The secret key for authentication

Example: test-secret

useridstringrequired

The Id of the user performing the request.

Example: dummy-userid

tokenstringrequired

The token for user authentication.

Example: dummy-token

Body

idstringrequired

Example: stripe-payment-method-id

productobjectrequired

cardDataobjectrequired

infoobjectrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/payment/pay' \
  --header 'apikey: test' \
  --header 'userid: dummy-userid' \
  --header 'token: dummy-token' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "stripe-payment-method-id",
    "product": {
      "price": 100
    },
    "cardData": {
      "email": "[email protected]",
      "name": "Jon Doe",
      "country": "India",
      "zip": 12020
    },
    "info": {
      "userId": "u-1202",
      "entityId": "e-0000000000"
    }
  }'

200

400

500

{
  "success": true,
  "data": {}
}

Successful response

Create payment intent for an entity

This endpoint allows users to create a payment intent for an entity.

post

/entities/{entityId}/users/{userId}/create-payment-intent

Path parameters

entityIdstringrequired

userIdstringrequired

Header parameters

apikeystringrequired

The API key for authentication

Example: test

apisecretstring

The secret key for authentication

Example: test-secret

useridstringrequired

The Id of the user performing the request.

Example: dummy-userid

tokenstringrequired

The token for user authentication.

Example: dummy-token

Body

forEntityIdstring

cardDataobject

intentDataobject

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/users/{userId}/create-payment-intent' \
  --header 'apikey: test' \
  --header 'userid: dummy-userid' \
  --header 'token: dummy-token' \
  --header 'Content-Type: application/json' \
  --data '{
    "forEntityId": "text",
    "cardData": {
      "email": "[email protected]",
      "name": "text",
      "address": "text"
    },
    "intentData": {
      "paymentMethodId": "text",
      "amount": 1,
      "currency": "text"
    }
  }'

200

400

401

500

{
  "success": true,
  "data": {
    "clientSecret": "text",
    "intentId": "text"
  }
}

Successful response

Approve payment for an entity

This endpoint allows users to approve a payment for an entity.

post

/entities/{entityId}/approve-payment

Path parameters

entityIdstringrequired

Header parameters

apikeystringrequired

The API key for authentication

Example: test

apisecretstring

The secret key for authentication

Example: test-secret

useridstringrequired

The Id of the user performing the request.

Example: dummy-userid

tokenstringrequired

The token for user authentication.

Example: dummy-token

Body

intentIdstringrequired

The ID of the payment intent to approve.

Example: pi_123456789

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/approve-payment' \
  --header 'apikey: test' \
  --header 'userid: dummy-userid' \
  --header 'token: dummy-token' \
  --header 'Content-Type: application/json' \
  --data '{
    "intentId": "pi_123456789"
  }'

200

400

401

500

{
  "success": true
}

Successful response

Get credit tiers for an entity

This endpoint allows users to retrieve the credit tiers for a specific entity.

get

/entities/{entityId}/credits-tiers

Path parameters

entityIdstringrequired

Header parameters

apikeystringrequired

The API key for authentication

Example: test

apisecretstring

The secret key for authentication

Example: test-secret

useridstringrequired

The Id of the user performing the request.

Example: dummy-userid

tokenstringrequired

The token for user authentication.

Example: dummy-token

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/credits-tiers' \
  --header 'apikey: test' \
  --header 'userid: dummy-userid' \
  --header 'token: dummy-token'

200

400

401

500

{
  "success": true,
  "data": [
    {
      "entityId": "text",
      "creditsTierId": "text",
      "creditsTierName": "text",
      "price": 1,
      "creditsAmount": 1,
      "recurringTimePeriod": "text",
      "extraCreditsAmount": 1
    }
  ]
}

Successful response

Add credit tier for an entity

This endpoint allows the entity owner to add a new credit tier.

post

/entities/{entityId}/credits-tiers

Path parameters

entityIdstringrequired

Header parameters

apikeystringrequired

The API key for authentication

Example: test

apisecretstring

The secret key for authentication

Example: test-secret

tokenstringrequired

The token for user authentication.

Example: dummy-token

Body

creditsAmountnumber

The amount of credits in the tier.

extraCreditsAmountnumber

The amount of extra bonus credits.

pricenumber

The price of the credit tier.

creditsTierIdstring

The ID of the credit tier.

creditsTierNamestring

The name of the credit tier.

recurringTimePeriodstring · enum · default: ONETIME

The recurring time period for the credit tier.

Options: MONTHLY, YEARLY, ONETIME

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/credits-tiers' \
  --header 'apikey: test' \
  --header 'token: dummy-token' \
  --header 'Content-Type: application/json' \
  --data '{
    "creditsAmount": 1,
    "extraCreditsAmount": 1,
    "price": 1,
    "creditsTierId": "text",
    "creditsTierName": "text",
    "recurringTimePeriod": "ONETIME"
  }'

200

400

500

{
  "success": true,
  "data": {
    "creditsTierId": "text",
    "creditsTierName": "text"
  }
}

Successful response

Update credit tier for an entity

This endpoint allows the entity owner to update an existing credit tier.

patch

/entities/{entityId}/credits-tiers

Path parameters

entityIdstringrequired

Header parameters

apikeystringrequired

The API key for authentication

Example: test

apisecretstring

The secret key for authentication

Example: test-secret

tokenstringrequired

The token for user authentication.

Example: dummy-token

Body

creditsAmountnumber

The updated amount of credits in the tier.

extraCreditsAmountnumber

The updated amount of extra bonus credits.

pricenumber

The updated price of the credit tier.

creditsTierIdstring

The ID of the credit tier to update.

creditsTierNamestring

The updated name of the credit tier.

recurringTimePeriodstring · enum

The updated recurring time period for the credit tier.

Options: MONTHLY, YEARLY, ONETIME

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/credits-tiers' \
  --header 'apikey: test' \
  --header 'token: dummy-token' \
  --header 'Content-Type: application/json' \
  --data '{
    "creditsAmount": 1,
    "extraCreditsAmount": 1,
    "price": 1,
    "creditsTierId": "text",
    "creditsTierName": "text",
    "recurringTimePeriod": "MONTHLY"
  }'

200

400

500

{
  "success": true,
  "data": {
    "creditsTierId": "text",
    "creditsTierName": "text",
    "creditsAmount": 1,
    "price": 1,
    "extraCreditsAmount": 1,
    "recurringTimePeriod": "text"
  }
}

Successful response

get Credit tiers

This endpoint retrieves credit tiers of an entity.

get

/entities/{entityId}/credits

Path parameters

entityIdstringrequired

Header parameters

apikeystringrequired

The API key for authentication

Example: test

apisecretstring

The secret key for authentication

Example: test-secret

useridstringrequired

The Id of the user performing the request.

Example: dummy-userid

tokenstringrequired

The token for user authentication.

Example: dummy-token

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/credits' \
  --header 'apikey: test' \
  --header 'userid: dummy-userid' \
  --header 'token: dummy-token'

200

400

401

500

{
  "success": true,
  "data": {
    "entityId": "abc123",
    "userId": "user1",
    "creditsAmount": 100,
    "history": [
      {
        "creditsAmount": 50,
        "createdAt": "2023-07-21T12:34:56Z",
        "reason": "Purchase of product XYZ",
        "type": "BOUGHT"
      }
    ]
  }
}

Successful response

Get credit info for a user

Retrieve the credit information for a user.

get

/users/{userId}/credits

Path parameters

userIdstringrequired

Header parameters

apikeystringrequired

The API key for authentication

Example: test

apisecretstring

The secret key for authentication

Example: test-secret

useridstringrequired

The Id of the user performing the request.

Example: dummy-userid

tokenstringrequired

The token for user authentication.

Example: dummy-token

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.questprotocol.xyz/api/users/{userId}/credits' \
  --header 'apikey: test' \
  --header 'userid: dummy-userid' \
  --header 'token: dummy-token'

200

400

401

500

{
  "success": true,
  "data": {
    "entityId": "abc123",
    "userId": "user1",
    "creditsAmount": 100,
    "history": [
      {
        "creditsAmount": 50,
        "createdAt": "2023-07-21T12:34:56Z",
        "reason": "Purchase of product XYZ",
        "type": "BOUGHT"
      }
    ]
  }
}

Successful response

Buy credits for a user

Purchase credits for a user in a specific entity.

post

/users/{userId}/buy-credits

Path parameters

userIdstringrequired

Query parameters

entityIdstringrequired

Header parameters

apikeystringrequired

The API key for authentication

Example: test

apisecretstring

The secret key for authentication

Example: test-secret

useridstringrequired

The Id of the user performing the request.

Example: dummy-userid

tokenstringrequired

The token for user authentication.

Example: dummy-token

Body

creditsTierIdstring

intentIdstring

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/users/{userId}/buy-credits?entityId=text' \
  --header 'apikey: test' \
  --header 'userid: dummy-userid' \
  --header 'token: dummy-token' \
  --header 'Content-Type: application/json' \
  --data '{
    "creditsTierId": "text",
    "intentId": "text"
  }'

200

400

401

500

{
  "success": true
}

Successful response

Decrement credits for a user

Decrement credits for a user in a specific entity.

post

/users/{userId}/decrement-credits

Path parameters

userIdstringrequired

Query parameters

entityIdstringrequired

Header parameters

apikeystringrequired

The API key for authentication

Example: test

apisecretstring

The secret key for authentication

Example: test-secret

useridstringrequired

The Id of the user performing the request.

Example: dummy-userid

tokenstringrequired

The token for user authentication.

Example: dummy-token

Body

creditsAmountnumber

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/users/{userId}/decrement-credits?entityId=text' \
  --header 'apikey: test' \
  --header 'userid: dummy-userid' \
  --header 'token: dummy-token' \
  --header 'Content-Type: application/json' \
  --data '{
    "creditsAmount": 1
  }'

200

400

500

{
  "success": true
}

Successful response

get Credit tiers for user

This endpoint retrieves credit tiers for user of an entity.

get

/entities/{entityId}/user-credits

Path parameters

entityIdstringrequired

Header parameters

apikeystringrequired

The API key for authentication

Example: test

apisecretstring

The secret key for authentication

Example: test-secret

useridstringrequired

The Id of the user performing the request.

Example: dummy-userid

tokenstringrequired

The token for user authentication.

Example: dummy-token

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/user-credits' \
  --header 'apikey: test' \
  --header 'userid: dummy-userid' \
  --header 'token: dummy-token'

200

400

401

500

{
  "success": true,
  "data": {
    "entityId": "abc123",
    "userId": "user1",
    "creditsAmount": 100,
    "history": [
      {
        "creditsAmount": 50,
        "createdAt": "2023-07-21T12:34:56Z",
        "reason": "Purchase of product XYZ",
        "type": "BOUGHT"
      }
    ]
  }
}

Successful response

Buy credits for an entity

Buy credits for a user in a specific entity.

post

/entities/{entityId}/buy-credits

Path parameters

entityIdstringrequired

Query parameters

userIdstringrequired

Header parameters

apikeystringrequired

The API key for authentication

Example: test

apisecretstring

The secret key for authentication

Example: test-secret

useridstringrequired

The Id of the user performing the request.

Example: dummy-userid

tokenstringrequired

The token for user authentication.

Example: dummy-token

Body

creditsTierIdstring

intentIdstring

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/buy-credits?userId=text' \
  --header 'apikey: test' \
  --header 'userid: dummy-userid' \
  --header 'token: dummy-token' \
  --header 'Content-Type: application/json' \
  --data '{
    "creditsTierId": "text",
    "intentId": "text"
  }'

200

400

500

{
  "success": true
}

Successful response

Decrement credits for an entity

Decrement credits for a user in a specific entity.

post

/entities/{entityId}/decrement-credits

Path parameters

entityIdstringrequired

Header parameters

apikeystringrequired

The API key for authentication

Example: test

apisecretstring

The secret key for authentication

Example: test-secret

useridstringrequired

The Id of the user performing the request.

Example: dummy-userid

tokenstringrequired

The token for user authentication.

Example: dummy-token

Body

userIdstring

creditsAmountnumber

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/decrement-credits' \
  --header 'apikey: test' \
  --header 'userid: dummy-userid' \
  --header 'token: dummy-token' \
  --header 'Content-Type: application/json' \
  --data '{
    "userId": "text",
    "creditsAmount": 1
  }'

200

400

500

{
  "success": true
}

Successful response