🗳️Wallet Allowlist

Update a wallet allowlist via API

You can gate access to a Helio Pay Link or your embedded Checkout Widget using a wallet allowlist and dynamically update the allowlist via our API.

Pre-requisites

• Log in to Helio and click CREATE PAYMENT to set up a Pay Link.

• In the Advanced options section of step 3 during the Pay Link setup, select Access Control to enable the wallet allowlist and upload a wallet allowlist. See here for an example.

Updating the wallet allowlist via API

NOTE: When using the production environment (app.hel.io), set your API endpoint to api.hel.io/v1 and generate API keys there. For the development environment, use api.dev.hel.io/v1 and generate API keys from app.dev.hel.io.

You can then use the endpoint below to update the allowlist via API:

• API Endpoint: https://api.hel.io/v1/allowlist/add

• HTTP Method: PATCH

• Required Query Parameters: ?apiKey={{Your public key here}}

• Required Headers: Authorization: Bearer {{Your API Token here}}

Required request body:

{
  "prId": "64f6214821420532ec1dfd57",
  "prType": "PAYLINK",
  "wallets": [
{
  "publicKey": "publicKey",
  "maxAllowedQuantity": 3
}
  ]
}

Example query:

curl -X PATCH "https://api.hel.io/v1/allowlist/add?apiKey={{PUBLIC_KEY}}" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer {{PRIVATE_KEY}}" \
-d '{
  "prId": "string",
  "prType": "string",
  "wallets": [
    {
      "publicKey": "string",
      "maxAllowedQuantity": 3
    }
  ]
}'

You can send 1 or more wallets per request. The successful response has the following type

{  "id": "string",
  "prId": "string",
  "prType": "string",
  "wallets": [
    {
      "publicKey": "string",
      "maxAllowedQuantity": 3
    }
  ]
}

Swagger docs:

Swagger UI