Skip to main content
PATCH
/
v1
/
paylink
/
{id}
/
api-key
Update a Pay Link
curl --request PATCH \
  --url https://api.hel.io/v1/paylink/{id}/api-key \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "price": "<string>",
  "pricingCurrency": "<string>",
  "features": {
    "splitRevenue": true,
    "splitEqually": true,
    "canChangeQuantity": true,
    "requireQuantityLimits": true,
    "canChangePrice": true,
    "isEscrowed": true,
    "showDiscountCode": true,
    "requireAllowlist": true,
    "requireRaffle": true,
    "shouldRedirectOnSuccess": true,
    "requireEmail": true,
    "requireDiscordUsername": true,
    "requireDiscordLogin": true,
    "requireFullName": true,
    "requireTwitterUsername": true,
    "requireTelegramUsername": true,
    "requireCountry": true,
    "requireDeliveryAddress": true,
    "requirePhoneNumber": true,
    "requireProductDetails": true,
    "requireMaxTransactions": true,
    "requireNftGate": true,
    "requireDiscordAuth": true,
    "requireAccessCode": true,
    "requireXFollow": true,
    "canSwapTokens": true,
    "allowAffiliate": true,
    "enableCountdown": true,
    "customThemeEnabled": true
  },
  "recipients": [
    {
      "currencyId": "<string>",
      "walletId": "<string>",
      "sourceBlockchainEngine": "<string>"
    }
  ],
  "splitWallets": [
    {
      "address": "<string>",
      "percent": 123
    }
  ],
  "discountCodes": [
    {
      "percent": 123,
      "token": "<string>",
      "tokenType": "CODE",
      "prId": "<string>",
      "id": "<string>"
    }
  ],
  "limitSaleType": "transaction",
  "minQuantity": 123,
  "maxQuantity": 123,
  "affiliateDetails": {
    "bps": 123
  },
  "raffleDetails": {},
  "redirectUrl": "<string>",
  "redirectTimeout": 0,
  "creationSource": "PRIVATE_API",
  "subscriptionDetails": {
    "renewalReminders": 123,
    "gracePeriod": 123,
    "annualDiscountBps": 123,
    "interval": "MONTH",
    "isAnonymous": true
  },
  "description": "<string>",
  "notifySenderByEmail": false,
  "notifyReceiverByEmail": false,
  "addDiscordRole": false,
  "discordRoleIds": [
    "<string>"
  ],
  "disabled": true,
  "dynamic": true,
  "content": {
    "text": "<string>",
    "mediaUrl": "<string>",
    "mediaAttachmentId": "<string>"
  },
  "maxTransactions": 123,
  "product": {
    "name": "<string>",
    "description": "<string>",
    "type": "TEXT",
    "active": true
  },
  "nftCollectionAddress": "<string>",
  "discordAuthDetails": [
    {
      "serverId": "<string>",
      "roleId": "<string>"
    }
  ],
  "accessCodeAuthProperties": {
    "accessCode": "<string>"
  },
  "eventDetails": {
    "datetime": "2023-11-07T05:31:56Z",
    "location": "<string>",
    "timezoneLocation": "<string>"
  },
  "countdownDetails": {
    "startDatetime": "2023-11-07T05:31:56Z",
    "endDatetime": "2023-11-07T05:31:56Z",
    "timezoneLocation": "<string>"
  },
  "customTheme": {
    "primaryColor": "<string>",
    "neutralColor": "<string>",
    "textColorOnButton": "WHITE",
    "themeMode": "LIGHT",
    "backgroundColor": "<string>"
  }
}
'
{
  "id": "paylink_id",
  "platform": "HELIO",
  "description": "",
  "template": "OTHER",
  "disabled": false,
  "inactive": false,
  "notifySenderByEmail": false,
  "notifyReceiverByEmail": false,
  "addDiscordRole": false,
  "addTelegramGroup": false,
  "features": {
    "canChangeQuantity": false,
    "canChangePrice": false,
    "requireQuantityLimits": false,
    "requireCountry": false,
    "requireEmail": false,
    "requireDeliveryAddress": false,
    "requireDiscordUsername": false,
    "requireDiscordLogin": false,
    "requireFullName": false,
    "requirePhoneNumber": false,
    "requireTwitterUsername": false,
    "requireTelegramUsername": false,
    "requireProductDetails": false,
    "requireMaxTransactions": false,
    "requireNftGate": false,
    "requireDiscordAuth": false,
    "requireAccessCode": false,
    "requireXFollow": false,
    "requireRaffle": false,
    "splitRevenue": false,
    "splitEqually": true,
    "canSwapTokens": true,
    "canPayWithCard": true,
    "nftDropEnabled": false,
    "showDiscountCode": true,
    "isEscrowed": false,
    "requireAllowlist": false,
    "allowAffiliate": false,
    "isEventEnabled": false,
    "enableCountdown": false,
    "requireCaptchaValidation": false,
    "shouldRedirectOnSuccess": false,
    "customThemeEnabled": false,
    "isSubscription": false,
    "showDetailsForCharge": false,
    "hasRedirectQueryParams": false
  },
  "maxTransactions": 1,
  "name": "Test Paylink",
  "nftCollectionAddress": "",
  "discordAuthDetails": [],
  "dynamic": false,
  "affiliateDetails": null,
  "price": "1000",
  "normalizedPrice": "1000",
  "redirectUrl": "",
  "redirectQueryParams": [],
  "customTheme": {
    "primaryColor": "#F76C1B",
    "neutralColor": "#5A6578",
    "themeMode": "LIGHT",
    "textColorOnButton": "BLACK",
    "backgroundColor": "#F9F9F9"
  },
  "createdAt": "2025-01-01T00:00:00.000Z",
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "creator": {
    "id": "creator_id_123",
    "userType": "MERCHANT",
    "email": "user@example.com",
    "name": "Example User",
    "isDisabled": false,
    "kycVerified": false,
    "platformDetails": {
      "platform": "HELIO"
    },
    "roles": [],
    "wallets": [
      {
        "id": "wallet_id_123",
        "name": "Primary Wallet",
        "btcProperties": null,
        "blockchainEngine": null
      }
    ],
    "payoutWallets": []
  },
  "company": {
    "id": "company_id_123",
    "name": "Example Company",
    "email": "contact@example.com",
    "websiteUrl": "",
    "discordUsername": "",
    "address": "",
    "phoneNumber": "",
    "escrowFunds": false,
    "twitterConfirmed": false,
    "kycVerified": false,
    "kybVerified": false,
    "logoUrl": "attachments/example_logo.png"
  },
  "currency": {
    "id": "currency_id_123",
    "name": "USD Coin",
    "decimals": 6,
    "order": 100,
    "mintAddress": "USDC_mint_address",
    "coinMarketCapId": 3408,
    "symbol": "USDC",
    "symbolPrefix": "$",
    "type": "DIGITAL",
    "iconUrl": "USDC.svg",
    "features": [
      "PAYMENT_PRICING",
      "PAYMENT_RECIPIENT",
      "SWAP"
    ],
    "orderingType": "NUMERIC",
    "blockchain": {
      "id": "blockchain_id_123",
      "name": "SOL",
      "symbol": "SOL",
      "engine": {
        "id": "engine_id_123",
        "type": "SOL"
      }
    }
  },
  "wallet": {
    "id": "wallet_id_123",
    "name": "Primary Wallet",
    "publicKey": "ExamplePublicKey1234567890",
    "btcProperties": null,
    "type": "EXTENSION",
    "blockchainEngine": {
      "id": "engine_id_123",
      "type": "SOL"
    }
  },
  "recipients": [
    {
      "currency": {
        "id": "currency_id_123",
        "name": "USD Coin",
        "decimals": 6,
        "order": 100,
        "mintAddress": "USDC_mint_address",
        "coinMarketCapId": 3408,
        "symbol": "USDC",
        "symbolPrefix": "$",
        "type": "DIGITAL",
        "iconUrl": "USDC.svg",
        "features": [
          "PAYMENT_PRICING",
          "PAYMENT_RECIPIENT",
          "SWAP"
        ],
        "orderingType": "NUMERIC",
        "blockchain": {
          "id": "blockchain_id_123",
          "name": "SOL",
          "symbol": "SOL",
          "engine": {
            "id": "engine_id_123",
            "type": "SOL"
          }
        }
      },
      "wallet": {
        "id": "wallet_id_123",
        "name": "Recipient Wallet",
        "publicKey": "RecipientPublicKey1234567890",
        "btcProperties": null,
        "type": "EXTENSION",
        "blockchainEngine": {
          "id": "engine_id_123",
          "type": "SOL"
        }
      }
    }
  ],
  "product": null,
  "discountCodes": [],
  "pricingCurrency": {
    "id": "currency_id_123",
    "name": "USD Coin",
    "decimals": 6,
    "order": 100,
    "mintAddress": "USDC_mint_address",
    "coinMarketCapId": 3408,
    "symbol": "USDC",
    "symbolPrefix": "$",
    "type": "DIGITAL",
    "iconUrl": "USDC.svg",
    "features": [
      "PAYMENT_PRICING",
      "PAYMENT_RECIPIENT",
      "SWAP"
    ],
    "orderingType": "NUMERIC",
    "blockchain": {
      "id": "blockchain_id_123",
      "name": "SOL",
      "symbol": "SOL",
      "engine": {
        "id": "engine_id_123",
        "type": "SOL"
      }
    }
  }
}
Note: When using the production environment at moonpay.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 moonpay.dev.hel.io.

Authorizations

​
Authorization
string
header
required

Authentication using JWT token

Path Parameters

​
id
string
required

The unique ID of the pay link you want to update.

Query Parameters

​
apiKey
string
required

Your API key can be generated from the Helio Dashboard settings.

Body

application/json
​
name
string

Name or title of the pay link product or service.

​
price
string

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

​
pricingCurrency
string

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

​
features
object

Feature flags and behavioral options for the pay link.

​
recipients
object[]

List of recipient wallets and currencies.

​
splitWallets
object[]

List of wallets to distribute the payment among.

​
discountCodes
object[]

Array of discount codes applicable to the pay link.

​
limitSaleType
enum<string>

Restricts sales to a transaction count or specific Discord ID.

Available options:
transaction,
discordId
​
minQuantity
number

Minimum quantity a user must purchase.

​
maxQuantity
number

Maximum quantity a user can purchase.

​
affiliateDetails
object

Settings for affiliate tracking and revenue sharing.

​
raffleDetails
object

Configuration for raffle-based sales.

​
redirectUrl
string

URL to redirect users after completing the payment.

​
redirectTimeout
enum<integer>
default: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.

Available options:
0,
3
Example:

0

​
creationSource
enum<string>

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

Available options:
PRIVATE_API,
PUBLIC_API
​
subscriptionDetails
object

Subscription settings for recurring payments.

​
description
string

Description of the product or service offered.

​
notifySenderByEmail
boolean
default:false

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

​
notifyReceiverByEmail
boolean
default:false

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

​
addDiscordRole
boolean
default:false

Automatically assigns a Discord role upon successful payment.

​
discordRoleIds
string[]

List of Discord role IDs to be assigned.

​
disabled
boolean

If true, disables the pay link without deleting it.

​
dynamic
boolean

Enables dynamic pricing features for the pay link.

​
content
object

Additional content like files or links associated with the pay link.

​
maxTransactions
number

Maximum number of transactions allowed for this pay link.

​
product
object

Optional product object associated with the pay link.

​
nftCollectionAddress
string

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

​
discordAuthDetails
object[]

Details for Discord authentication and role assignment.

​
accessCodeAuthProperties
object

Access code configuration for gated content or purchases.

​
eventDetails
object

Event-related configuration like dates and venues.

​
countdownDetails
object

Countdown timer settings for scheduled launches.

​
customTheme
object

Applies a custom color scheme to the paylink.

Response

Paylink successfully updated.