v1
latestOpenAPI 3.0.02026-07-2656110201.6 KBCreate a Pay Link
Create a new paylink using your API key with full control over pricing, currency, and payout configuration.
Query parameters
API key can be generated on helio dashboard settings page
Request body
Layout or presentation style of the pay link checkout.
Name or title of the pay link product or service.
Price is an int64 represented in base units of the currency, e.g. "1000000" = 1 USDC.
Currency ID used to price the paylink (fiat or crypto). Retrieve this value from the Get Currencies endpoint.
Restricts sales to a transaction count or specific Discord ID.
Minimum quantity a user must purchase.
Maximum quantity a user can purchase.
URL to redirect users after completing the payment.
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.
Indicates whether the pay link was created via private or public API.
Description of the product or service offered.
If true, notifies the sender via email after a successful payment.
If true, notifies the receiver via email after a successful payment.
Automatically assigns a Discord role upon successful payment.
List of Discord role IDs to be assigned.
If true, disables the pay link without deleting it.
Enables dynamic pricing features for the pay link.
Maximum number of transactions allowed for this pay link.
Blockchain address of the NFT collection used in this pay link.