Store

Before creating orders and enabling crypto payments, users need to set up their stores via our dashboard. To learn how to set up your store, please follow this link for detailed instructions.

A store represents a business that will create and manage orders

Here are some main Store endpoints you can check:

Get Store

Get Store

GET https://api.cryptum.io/plugins/stores/{id}

Use this endpoint to fetch information about a specific store

Query Parameters

Name	Type	Description
id*	string	Your store id.

200: OK

{
    "name": "Test",
    "email": "[e-mail]",
    "apiKeyId": "b0...9e4",
    "segment": "Art",
    "userId": "7b9...03",
    "wallets": [
        {
            "acceptedTokens": [
                "CELO",
                "cUSD",
                "cREAL"
            ],
            "address": "0x0...d3f1",
            "protocol": "CELO"
        }
    ],
    "xpubKeys": [],
    "storeUrl": "...",
    "storeDiscountPercentage": "0",
    "storeMarkupPercentage": "0",
    "pluginsInstalled": [],
    "createdAt": "202...3Z",
    "webhookSecret": "B2c...a0",
    "id": "55...4"
}

400: Bad Request

Update Store

Update Store

PUT https://api.cryptum.io/plugins/stores/{id}

Use this endpoint to update your store preferences.

Please note that you need to set up a receiving wallet address before proceeding with any sales. You can do it directly via our dashboard (check this link on how to do it). Alternatively, you can configure your receiving wallets by filling out the 'wallets' array below.

Query Parameters

Name	Type	Description
id*	string	Your store id.

Request Body

Name	Type	Description
name	string	Store name.
email	string	Store email.
segment	string	Store segment.
wallets	Array[]	Array of different wallets.
wallets[i]	Object()	Wallet object.
wallets[i].acceptedTokens	Array[]	Array of strings representing accepted tokens. Possible values are: "CELO", "cBRL", "cUSD", "ETH", "USDC", "USD", "XRP", "HTR", "MATIC", "USDC", "BUSD", "BNB", "AVAX", "BITCOIN".
wallets[i].address	string	Address of the specified wallet
wallets[i].protocol	string	Protocol of the wallet. Possible values are: "CELO", "ETHEREUM", "HATHOR", "POLYGON", "AVAXCCHAIN", "BSC", "RIPPLE", "XRPL", "BTC".
xpubKeys	Array[String]	xpubKeys
storeUrl	string	Store URL
storeDiscountPercentage	string	Discount given to users paying in crypto
storeMarkupPercentage	string	Markup given to users paying in crypto

200: OK