Entity Credit Tier

Make payment

This endpoint allows to make payment.

POSThttps://api.questprotocol.xyz/api/payment/pay

Header parameters

Body

application/json

id*string

product*object

cardData*object

info*object

Response

200400500

Successful response

Body

application/json

successboolean

dataobject

Request

JavaScriptCurl

const response = await fetch('https://api.questprotocol.xyz/api/payment/pay', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": "stripe-payment-method-id",
      "product": {},
      "cardData": {},
      "info": {}
    }),
});
const data = await response.json();

Response

{
  "success": true
}

Create payment intent for an entity

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

POSThttps://api.questprotocol.xyz/api/entities/{entityId}/users/{userId}/create-payment-intent

Path parameters

entityId*string

userId*string

Header parameters

Body

application/json

The request body for creating a payment intent.

cardDataobject

intentDataobject

forEntityIdstring

Response

200400401500

Successful response

Body

application/json

successboolean

dataobject

Request

JavaScriptCurl

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/users/{userId}/create-payment-intent', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

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

Approve payment for an entity

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

POSThttps://api.questprotocol.xyz/api/entities/{entityId}/approve-payment

Path parameters

entityId*string

Header parameters

Body

application/json

The request body for approving a payment.

intentId*string

The ID of the payment intent to approve.

Response

200400401500

Successful response

Body

application/json

successboolean

Request

JavaScriptCurl

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/approve-payment', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "intentId": "pi_123456789"
    }),
});
const data = await response.json();

Response

{
  "success": true
}

Get credit tiers for an entity

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

GEThttps://api.questprotocol.xyz/api/entities/{entityId}/credits-tiers

Path parameters

entityId*string

Header parameters

Response

200400401500

Successful response

Body

application/json

successboolean

dataarray of object

Request

JavaScriptCurl

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/credits-tiers', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

Add credit tier for an entity

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

POSThttps://api.questprotocol.xyz/api/entities/{entityId}/credits-tiers

Path parameters

entityId*string

Header parameters

Body

application/json

The data for the new credit tier.

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.

recurringTimePeriodenum

The recurring time period for the credit tier.

MONTHLYYEARLYONETIME

Response

200400500

Successful response

Body

application/json

successboolean

dataobject

Request

JavaScriptCurl

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/credits-tiers', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

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

Update credit tier for an entity

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

PATCHhttps://api.questprotocol.xyz/api/entities/{entityId}/credits-tiers

Path parameters

entityId*string

Header parameters

Body

application/json

The data for updating the credit tier.

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.

recurringTimePeriodenum

The updated recurring time period for the credit tier.

MONTHLYYEARLYONETIME

Response

200400500

Successful response

Body

application/json

successboolean

dataobject

Request

JavaScriptCurl

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/credits-tiers', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

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

get Credit tiers

This endpoint retrieves credit tiers of an entity.

GEThttps://api.questprotocol.xyz/api/entities/{entityId}/credits

Path parameters

entityId*string

Header parameters

Response

200400401500

Successful response

Body

application/json

successboolean

dataEntityUserCreditsMapping (object)

Request

JavaScriptCurl

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/credits', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

Get credit info for a user

Retrieve the credit information for a user.

GEThttps://api.questprotocol.xyz/api/users/{userId}/credits

Path parameters

userId*string

Header parameters

Response

200400401500

Successful response

Body

application/json

successboolean

dataEntityUserCreditsMapping (object)

Request

JavaScriptCurl

const response = await fetch('https://api.questprotocol.xyz/api/users/{userId}/credits', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

Buy credits for a user

Purchase credits for a user in a specific entity.

POSThttps://api.questprotocol.xyz/api/users/{userId}/buy-credits

Path parameters

userId*string

Query parameters

Header parameters

Body

application/json

creditsTierIdstring

intentIdstring

Response

200400401500

Successful response

Body

application/json

successboolean

Request

JavaScriptCurl

const response = await fetch('https://api.questprotocol.xyz/api/users/{userId}/buy-credits', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "success": true
}

Decrement credits for a user

Decrement credits for a user in a specific entity.

POSThttps://api.questprotocol.xyz/api/users/{userId}/decrement-credits

Path parameters

userId*string

Query parameters

Header parameters

Body

application/json

creditsAmountnumber

Response

200400500

Successful response

Body

application/json

successboolean

Request

JavaScriptCurl

const response = await fetch('https://api.questprotocol.xyz/api/users/{userId}/decrement-credits', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "success": true
}

get Credit tiers for user

This endpoint retrieves credit tiers for user of an entity.

GEThttps://api.questprotocol.xyz/api/entities/{entityId}/user-credits

Path parameters

entityId*string

Header parameters

Response

200400401500

Successful response

Body

application/json

successboolean

dataEntityUserCreditsMapping (object)

Request

JavaScriptCurl

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/user-credits', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

Buy credits for an entity

Buy credits for a user in a specific entity.

POSThttps://api.questprotocol.xyz/api/entities/{entityId}/buy-credits

Path parameters

entityId*string

Query parameters

Header parameters

Body

application/json

creditsTierIdstring

intentIdstring

Response

200400500

Successful response

Body

application/json

successboolean

Request

JavaScriptCurl

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/buy-credits', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "success": true
}

Decrement credits for an entity

Decrement credits for a user in a specific entity.

POSThttps://api.questprotocol.xyz/api/entities/{entityId}/decrement-credits

Path parameters

entityId*string

Header parameters

Body

application/json

userIdstring

creditsAmountnumber

Response

200400500

Successful response

Body

application/json

successboolean

Request

JavaScriptCurl

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/decrement-credits', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "success": true
}