HEhel
Paylink

Create a Pay Link

Changed on

Create a new paylink using your API key with full control over pricing, currency, and payout configuration.

post/v1/paylink/create/api-key

Request

  • Base URL
    https://api.hel.io
  • URL
    https://api.hel.io/v1/paylink/create/api-key
  • Auth
    HTTP bearer

Query parameters

apiKeystring required

API key can be generated on helio dashboard settings page

Request body

template'PRODUCT' | 'SUBSCRIPTION' | 'PRE_SALE' | 'SINGLE_NFT' | 'VIDEO' | 'DISCORD_MEMBERSHIP' | 'INVOICE' | 'EMBEDDED' | 'LINK_OR_FILE' | 'TRADING_VIEW' | 'EVENT' | 'WOO_COMMERCE' | 'OTHER' | 'LEGACY' | 'RAFFLE' | 'SHOPIFY' | 'BLINK'

Layout or presentation style of the pay link checkout.

namestring required

Name or title of the pay link product or service.

pricestring required

Price is an int64 represented in base units of the currency, e.g. "1000000" = 1 USDC.

pricingCurrencystring required

Currency ID used to price the paylink (fiat or crypto). Retrieve this value from the Get Currencies endpoint.

limitSaleType'transaction' | 'discordId'

Restricts sales to a transaction count or specific Discord ID.

minQuantitynumber

Minimum quantity a user must purchase.

maxQuantitynumber

Maximum quantity a user can purchase.

raffleDetailsRaffleDetailsDto
redirectUrlstring

URL to redirect users after completing the payment.

redirectTimeout0 | 3

Delay (in seconds) before redirecting the user to redirectUrl after a successful payment. Use 0 for an instant redirect, or 3 to show the confirmation screen for 3 seconds before redirecting.

creationSource'PRIVATE_API' | 'PUBLIC_API'

Indicates whether the pay link was created via private or public API.

descriptionstring

Description of the product or service offered.

notifySenderByEmailboolean

If true, notifies the sender via email after a successful payment.

notifyReceiverByEmailboolean

If true, notifies the receiver via email after a successful payment.

addDiscordRoleboolean

Automatically assigns a Discord role upon successful payment.

discordRoleIdsstring[]

List of Discord role IDs to be assigned.

disabledboolean

If true, disables the pay link without deleting it.

dynamicboolean

Enables dynamic pricing features for the pay link.

maxTransactionsnumber

Maximum number of transactions allowed for this pay link.

nftCollectionAddressstring

Blockchain address of the NFT collection used in this pay link.

themeIdstring

Optional ID of a saved theme to apply to this paylink. A saved theme carries full light and dark palettes plus design tokens and is the recommended way to style hosted pages. Takes precedence over the dashboard default theme. For a one-off inline color scheme, use customTheme.

Response

contentContentResponse required
limitSaleType'transaction' | 'discordId'
minQuantitynumber
maxQuantitynumber
redirectUrlstring

Changes