🗳️Wallet Allowlist

Update a wallet allowlist via our API

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

Steps: 1. Log in to Helio and hit CREATE PAYMENT to set up a Pay link

2. In step 3 Advanced options -> select Access control to enable & upload a Wallet allowlist. Here’s an example of the format

3. You can then use the endpoint below to update that allow list in real-time via API key (generate key from the dashboard) Endpoint: https://api.hel.io/v1/allowlist/add?apiKey={{API_KEY}}

Headers: Authorization: ‘Bearer {{API_TOKEN}}’

Example Payload:

{
  "prId": "64f6214821420532ec1dfd57",
  "prType": "PAYLINK",
  "wallets": [
{
  "publicKey": "publicKey",
  "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