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,
    "canPayWithCard": true,
    "allowAffiliate": true,
    "enableCountdown": true,
    "customThemeEnabled": true,
    "disableEmailReceipt": true
  },
  "recipients": [
    {
      "currencyId": "<string>",
      "walletId": "<string>",
      "sourceBlockchainEngine": "<string>"
    }
  ],
  "splitWallets": [
    {
      "address": "<string>",
      "percent": 123
    }
  ],
  "discountCodes": [
    {
      "percent": 123,
      "token": "<string>",
      "prId": "<string>",
      "id": "<string>"
    }
  ],
  "minQuantity": 123,
  "maxQuantity": 123,
  "raffleDetails": {},
  "redirectUrl": "<string>",
  "redirectTimeout": 0,
  "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>",
    "active": true
  },
  "nftCollectionAddress": "<string>",
  "discordAuthDetails": [
    {
      "serverId": "<string>",
      "roleId": "<string>"
    }
  ]
}
'

import requests

url = "https://api.hel.io/v1/paylink/{id}/api-key"

payload = {
    "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,
        "canPayWithCard": True,
        "allowAffiliate": True,
        "enableCountdown": True,
        "customThemeEnabled": True,
        "disableEmailReceipt": True
    },
    "recipients": [
        {
            "currencyId": "<string>",
            "walletId": "<string>",
            "sourceBlockchainEngine": "<string>"
        }
    ],
    "splitWallets": [
        {
            "address": "<string>",
            "percent": 123
        }
    ],
    "discountCodes": [
        {
            "percent": 123,
            "token": "<string>",
            "prId": "<string>",
            "id": "<string>"
        }
    ],
    "minQuantity": 123,
    "maxQuantity": 123,
    "raffleDetails": {},
    "redirectUrl": "<string>",
    "redirectTimeout": 0,
    "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>",
        "active": True
    },
    "nftCollectionAddress": "<string>",
    "discordAuthDetails": [
        {
            "serverId": "<string>",
            "roleId": "<string>"
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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,
      canPayWithCard: true,
      allowAffiliate: true,
      enableCountdown: true,
      customThemeEnabled: true,
      disableEmailReceipt: true
    },
    recipients: [
      {
        currencyId: '<string>',
        walletId: '<string>',
        sourceBlockchainEngine: '<string>'
      }
    ],
    splitWallets: [{address: '<string>', percent: 123}],
    discountCodes: [{percent: 123, token: '<string>', prId: '<string>', id: '<string>'}],
    minQuantity: 123,
    maxQuantity: 123,
    raffleDetails: {},
    redirectUrl: '<string>',
    redirectTimeout: 0,
    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>', active: true},
    nftCollectionAddress: '<string>',
    discordAuthDetails: [{serverId: '<string>', roleId: '<string>'}]
  })
};

fetch('https://api.hel.io/v1/paylink/{id}/api-key', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hel.io/v1/paylink/{id}/api-key",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    '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,
        'canPayWithCard' => true,
        'allowAffiliate' => true,
        'enableCountdown' => true,
        'customThemeEnabled' => true,
        'disableEmailReceipt' => true
    ],
    'recipients' => [
        [
                'currencyId' => '<string>',
                'walletId' => '<string>',
                'sourceBlockchainEngine' => '<string>'
        ]
    ],
    'splitWallets' => [
        [
                'address' => '<string>',
                'percent' => 123
        ]
    ],
    'discountCodes' => [
        [
                'percent' => 123,
                'token' => '<string>',
                'prId' => '<string>',
                'id' => '<string>'
        ]
    ],
    'minQuantity' => 123,
    'maxQuantity' => 123,
    'raffleDetails' => [
        
    ],
    'redirectUrl' => '<string>',
    'redirectTimeout' => 0,
    '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>',
        'active' => true
    ],
    'nftCollectionAddress' => '<string>',
    'discordAuthDetails' => [
        [
                'serverId' => '<string>',
                'roleId' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hel.io/v1/paylink/{id}/api-key"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"price\": \"<string>\",\n  \"pricingCurrency\": \"<string>\",\n  \"features\": {\n    \"splitRevenue\": true,\n    \"splitEqually\": true,\n    \"canChangeQuantity\": true,\n    \"requireQuantityLimits\": true,\n    \"canChangePrice\": true,\n    \"isEscrowed\": true,\n    \"showDiscountCode\": true,\n    \"requireAllowlist\": true,\n    \"requireRaffle\": true,\n    \"shouldRedirectOnSuccess\": true,\n    \"requireEmail\": true,\n    \"requireDiscordUsername\": true,\n    \"requireDiscordLogin\": true,\n    \"requireFullName\": true,\n    \"requireTwitterUsername\": true,\n    \"requireTelegramUsername\": true,\n    \"requireCountry\": true,\n    \"requireDeliveryAddress\": true,\n    \"requirePhoneNumber\": true,\n    \"requireProductDetails\": true,\n    \"requireMaxTransactions\": true,\n    \"requireNftGate\": true,\n    \"requireDiscordAuth\": true,\n    \"requireAccessCode\": true,\n    \"requireXFollow\": true,\n    \"canSwapTokens\": true,\n    \"canPayWithCard\": true,\n    \"allowAffiliate\": true,\n    \"enableCountdown\": true,\n    \"customThemeEnabled\": true,\n    \"disableEmailReceipt\": true\n  },\n  \"recipients\": [\n    {\n      \"currencyId\": \"<string>\",\n      \"walletId\": \"<string>\",\n      \"sourceBlockchainEngine\": \"<string>\"\n    }\n  ],\n  \"splitWallets\": [\n    {\n      \"address\": \"<string>\",\n      \"percent\": 123\n    }\n  ],\n  \"discountCodes\": [\n    {\n      \"percent\": 123,\n      \"token\": \"<string>\",\n      \"prId\": \"<string>\",\n      \"id\": \"<string>\"\n    }\n  ],\n  \"minQuantity\": 123,\n  \"maxQuantity\": 123,\n  \"raffleDetails\": {},\n  \"redirectUrl\": \"<string>\",\n  \"redirectTimeout\": 0,\n  \"description\": \"<string>\",\n  \"notifySenderByEmail\": false,\n  \"notifyReceiverByEmail\": false,\n  \"addDiscordRole\": false,\n  \"discordRoleIds\": [\n    \"<string>\"\n  ],\n  \"disabled\": true,\n  \"dynamic\": true,\n  \"content\": {\n    \"text\": \"<string>\",\n    \"mediaUrl\": \"<string>\",\n    \"mediaAttachmentId\": \"<string>\"\n  },\n  \"maxTransactions\": 123,\n  \"product\": {\n    \"name\": \"<string>\",\n    \"description\": \"<string>\",\n    \"active\": true\n  },\n  \"nftCollectionAddress\": \"<string>\",\n  \"discordAuthDetails\": [\n    {\n      \"serverId\": \"<string>\",\n      \"roleId\": \"<string>\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.hel.io/v1/paylink/{id}/api-key")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"price\": \"<string>\",\n  \"pricingCurrency\": \"<string>\",\n  \"features\": {\n    \"splitRevenue\": true,\n    \"splitEqually\": true,\n    \"canChangeQuantity\": true,\n    \"requireQuantityLimits\": true,\n    \"canChangePrice\": true,\n    \"isEscrowed\": true,\n    \"showDiscountCode\": true,\n    \"requireAllowlist\": true,\n    \"requireRaffle\": true,\n    \"shouldRedirectOnSuccess\": true,\n    \"requireEmail\": true,\n    \"requireDiscordUsername\": true,\n    \"requireDiscordLogin\": true,\n    \"requireFullName\": true,\n    \"requireTwitterUsername\": true,\n    \"requireTelegramUsername\": true,\n    \"requireCountry\": true,\n    \"requireDeliveryAddress\": true,\n    \"requirePhoneNumber\": true,\n    \"requireProductDetails\": true,\n    \"requireMaxTransactions\": true,\n    \"requireNftGate\": true,\n    \"requireDiscordAuth\": true,\n    \"requireAccessCode\": true,\n    \"requireXFollow\": true,\n    \"canSwapTokens\": true,\n    \"canPayWithCard\": true,\n    \"allowAffiliate\": true,\n    \"enableCountdown\": true,\n    \"customThemeEnabled\": true,\n    \"disableEmailReceipt\": true\n  },\n  \"recipients\": [\n    {\n      \"currencyId\": \"<string>\",\n      \"walletId\": \"<string>\",\n      \"sourceBlockchainEngine\": \"<string>\"\n    }\n  ],\n  \"splitWallets\": [\n    {\n      \"address\": \"<string>\",\n      \"percent\": 123\n    }\n  ],\n  \"discountCodes\": [\n    {\n      \"percent\": 123,\n      \"token\": \"<string>\",\n      \"prId\": \"<string>\",\n      \"id\": \"<string>\"\n    }\n  ],\n  \"minQuantity\": 123,\n  \"maxQuantity\": 123,\n  \"raffleDetails\": {},\n  \"redirectUrl\": \"<string>\",\n  \"redirectTimeout\": 0,\n  \"description\": \"<string>\",\n  \"notifySenderByEmail\": false,\n  \"notifyReceiverByEmail\": false,\n  \"addDiscordRole\": false,\n  \"discordRoleIds\": [\n    \"<string>\"\n  ],\n  \"disabled\": true,\n  \"dynamic\": true,\n  \"content\": {\n    \"text\": \"<string>\",\n    \"mediaUrl\": \"<string>\",\n    \"mediaAttachmentId\": \"<string>\"\n  },\n  \"maxTransactions\": 123,\n  \"product\": {\n    \"name\": \"<string>\",\n    \"description\": \"<string>\",\n    \"active\": true\n  },\n  \"nftCollectionAddress\": \"<string>\",\n  \"discordAuthDetails\": [\n    {\n      \"serverId\": \"<string>\",\n      \"roleId\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hel.io/v1/paylink/{id}/api-key")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"price\": \"<string>\",\n  \"pricingCurrency\": \"<string>\",\n  \"features\": {\n    \"splitRevenue\": true,\n    \"splitEqually\": true,\n    \"canChangeQuantity\": true,\n    \"requireQuantityLimits\": true,\n    \"canChangePrice\": true,\n    \"isEscrowed\": true,\n    \"showDiscountCode\": true,\n    \"requireAllowlist\": true,\n    \"requireRaffle\": true,\n    \"shouldRedirectOnSuccess\": true,\n    \"requireEmail\": true,\n    \"requireDiscordUsername\": true,\n    \"requireDiscordLogin\": true,\n    \"requireFullName\": true,\n    \"requireTwitterUsername\": true,\n    \"requireTelegramUsername\": true,\n    \"requireCountry\": true,\n    \"requireDeliveryAddress\": true,\n    \"requirePhoneNumber\": true,\n    \"requireProductDetails\": true,\n    \"requireMaxTransactions\": true,\n    \"requireNftGate\": true,\n    \"requireDiscordAuth\": true,\n    \"requireAccessCode\": true,\n    \"requireXFollow\": true,\n    \"canSwapTokens\": true,\n    \"canPayWithCard\": true,\n    \"allowAffiliate\": true,\n    \"enableCountdown\": true,\n    \"customThemeEnabled\": true,\n    \"disableEmailReceipt\": true\n  },\n  \"recipients\": [\n    {\n      \"currencyId\": \"<string>\",\n      \"walletId\": \"<string>\",\n      \"sourceBlockchainEngine\": \"<string>\"\n    }\n  ],\n  \"splitWallets\": [\n    {\n      \"address\": \"<string>\",\n      \"percent\": 123\n    }\n  ],\n  \"discountCodes\": [\n    {\n      \"percent\": 123,\n      \"token\": \"<string>\",\n      \"prId\": \"<string>\",\n      \"id\": \"<string>\"\n    }\n  ],\n  \"minQuantity\": 123,\n  \"maxQuantity\": 123,\n  \"raffleDetails\": {},\n  \"redirectUrl\": \"<string>\",\n  \"redirectTimeout\": 0,\n  \"description\": \"<string>\",\n  \"notifySenderByEmail\": false,\n  \"notifyReceiverByEmail\": false,\n  \"addDiscordRole\": false,\n  \"discordRoleIds\": [\n    \"<string>\"\n  ],\n  \"disabled\": true,\n  \"dynamic\": true,\n  \"content\": {\n    \"text\": \"<string>\",\n    \"mediaUrl\": \"<string>\",\n    \"mediaAttachmentId\": \"<string>\"\n  },\n  \"maxTransactions\": 123,\n  \"product\": {\n    \"name\": \"<string>\",\n    \"description\": \"<string>\",\n    \"active\": true\n  },\n  \"nftCollectionAddress\": \"<string>\",\n  \"discordAuthDetails\": [\n    {\n      \"serverId\": \"<string>\",\n      \"roleId\": \"<string>\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "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"
      }
    }
  }
}

{
  "message": "API key or token is invalid",
  "code": 401
}

PATCH

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,
    "canPayWithCard": true,
    "allowAffiliate": true,
    "enableCountdown": true,
    "customThemeEnabled": true,
    "disableEmailReceipt": true
  },
  "recipients": [
    {
      "currencyId": "<string>",
      "walletId": "<string>",
      "sourceBlockchainEngine": "<string>"
    }
  ],
  "splitWallets": [
    {
      "address": "<string>",
      "percent": 123
    }
  ],
  "discountCodes": [
    {
      "percent": 123,
      "token": "<string>",
      "prId": "<string>",
      "id": "<string>"
    }
  ],
  "minQuantity": 123,
  "maxQuantity": 123,
  "raffleDetails": {},
  "redirectUrl": "<string>",
  "redirectTimeout": 0,
  "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>",
    "active": true
  },
  "nftCollectionAddress": "<string>",
  "discordAuthDetails": [
    {
      "serverId": "<string>",
      "roleId": "<string>"
    }
  ]
}
'

import requests

url = "https://api.hel.io/v1/paylink/{id}/api-key"

payload = {
    "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,
        "canPayWithCard": True,
        "allowAffiliate": True,
        "enableCountdown": True,
        "customThemeEnabled": True,
        "disableEmailReceipt": True
    },
    "recipients": [
        {
            "currencyId": "<string>",
            "walletId": "<string>",
            "sourceBlockchainEngine": "<string>"
        }
    ],
    "splitWallets": [
        {
            "address": "<string>",
            "percent": 123
        }
    ],
    "discountCodes": [
        {
            "percent": 123,
            "token": "<string>",
            "prId": "<string>",
            "id": "<string>"
        }
    ],
    "minQuantity": 123,
    "maxQuantity": 123,
    "raffleDetails": {},
    "redirectUrl": "<string>",
    "redirectTimeout": 0,
    "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>",
        "active": True
    },
    "nftCollectionAddress": "<string>",
    "discordAuthDetails": [
        {
            "serverId": "<string>",
            "roleId": "<string>"
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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,
      canPayWithCard: true,
      allowAffiliate: true,
      enableCountdown: true,
      customThemeEnabled: true,
      disableEmailReceipt: true
    },
    recipients: [
      {
        currencyId: '<string>',
        walletId: '<string>',
        sourceBlockchainEngine: '<string>'
      }
    ],
    splitWallets: [{address: '<string>', percent: 123}],
    discountCodes: [{percent: 123, token: '<string>', prId: '<string>', id: '<string>'}],
    minQuantity: 123,
    maxQuantity: 123,
    raffleDetails: {},
    redirectUrl: '<string>',
    redirectTimeout: 0,
    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>', active: true},
    nftCollectionAddress: '<string>',
    discordAuthDetails: [{serverId: '<string>', roleId: '<string>'}]
  })
};

fetch('https://api.hel.io/v1/paylink/{id}/api-key', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hel.io/v1/paylink/{id}/api-key",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    '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,
        'canPayWithCard' => true,
        'allowAffiliate' => true,
        'enableCountdown' => true,
        'customThemeEnabled' => true,
        'disableEmailReceipt' => true
    ],
    'recipients' => [
        [
                'currencyId' => '<string>',
                'walletId' => '<string>',
                'sourceBlockchainEngine' => '<string>'
        ]
    ],
    'splitWallets' => [
        [
                'address' => '<string>',
                'percent' => 123
        ]
    ],
    'discountCodes' => [
        [
                'percent' => 123,
                'token' => '<string>',
                'prId' => '<string>',
                'id' => '<string>'
        ]
    ],
    'minQuantity' => 123,
    'maxQuantity' => 123,
    'raffleDetails' => [
        
    ],
    'redirectUrl' => '<string>',
    'redirectTimeout' => 0,
    '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>',
        'active' => true
    ],
    'nftCollectionAddress' => '<string>',
    'discordAuthDetails' => [
        [
                'serverId' => '<string>',
                'roleId' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hel.io/v1/paylink/{id}/api-key"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"price\": \"<string>\",\n  \"pricingCurrency\": \"<string>\",\n  \"features\": {\n    \"splitRevenue\": true,\n    \"splitEqually\": true,\n    \"canChangeQuantity\": true,\n    \"requireQuantityLimits\": true,\n    \"canChangePrice\": true,\n    \"isEscrowed\": true,\n    \"showDiscountCode\": true,\n    \"requireAllowlist\": true,\n    \"requireRaffle\": true,\n    \"shouldRedirectOnSuccess\": true,\n    \"requireEmail\": true,\n    \"requireDiscordUsername\": true,\n    \"requireDiscordLogin\": true,\n    \"requireFullName\": true,\n    \"requireTwitterUsername\": true,\n    \"requireTelegramUsername\": true,\n    \"requireCountry\": true,\n    \"requireDeliveryAddress\": true,\n    \"requirePhoneNumber\": true,\n    \"requireProductDetails\": true,\n    \"requireMaxTransactions\": true,\n    \"requireNftGate\": true,\n    \"requireDiscordAuth\": true,\n    \"requireAccessCode\": true,\n    \"requireXFollow\": true,\n    \"canSwapTokens\": true,\n    \"canPayWithCard\": true,\n    \"allowAffiliate\": true,\n    \"enableCountdown\": true,\n    \"customThemeEnabled\": true,\n    \"disableEmailReceipt\": true\n  },\n  \"recipients\": [\n    {\n      \"currencyId\": \"<string>\",\n      \"walletId\": \"<string>\",\n      \"sourceBlockchainEngine\": \"<string>\"\n    }\n  ],\n  \"splitWallets\": [\n    {\n      \"address\": \"<string>\",\n      \"percent\": 123\n    }\n  ],\n  \"discountCodes\": [\n    {\n      \"percent\": 123,\n      \"token\": \"<string>\",\n      \"prId\": \"<string>\",\n      \"id\": \"<string>\"\n    }\n  ],\n  \"minQuantity\": 123,\n  \"maxQuantity\": 123,\n  \"raffleDetails\": {},\n  \"redirectUrl\": \"<string>\",\n  \"redirectTimeout\": 0,\n  \"description\": \"<string>\",\n  \"notifySenderByEmail\": false,\n  \"notifyReceiverByEmail\": false,\n  \"addDiscordRole\": false,\n  \"discordRoleIds\": [\n    \"<string>\"\n  ],\n  \"disabled\": true,\n  \"dynamic\": true,\n  \"content\": {\n    \"text\": \"<string>\",\n    \"mediaUrl\": \"<string>\",\n    \"mediaAttachmentId\": \"<string>\"\n  },\n  \"maxTransactions\": 123,\n  \"product\": {\n    \"name\": \"<string>\",\n    \"description\": \"<string>\",\n    \"active\": true\n  },\n  \"nftCollectionAddress\": \"<string>\",\n  \"discordAuthDetails\": [\n    {\n      \"serverId\": \"<string>\",\n      \"roleId\": \"<string>\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.hel.io/v1/paylink/{id}/api-key")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"price\": \"<string>\",\n  \"pricingCurrency\": \"<string>\",\n  \"features\": {\n    \"splitRevenue\": true,\n    \"splitEqually\": true,\n    \"canChangeQuantity\": true,\n    \"requireQuantityLimits\": true,\n    \"canChangePrice\": true,\n    \"isEscrowed\": true,\n    \"showDiscountCode\": true,\n    \"requireAllowlist\": true,\n    \"requireRaffle\": true,\n    \"shouldRedirectOnSuccess\": true,\n    \"requireEmail\": true,\n    \"requireDiscordUsername\": true,\n    \"requireDiscordLogin\": true,\n    \"requireFullName\": true,\n    \"requireTwitterUsername\": true,\n    \"requireTelegramUsername\": true,\n    \"requireCountry\": true,\n    \"requireDeliveryAddress\": true,\n    \"requirePhoneNumber\": true,\n    \"requireProductDetails\": true,\n    \"requireMaxTransactions\": true,\n    \"requireNftGate\": true,\n    \"requireDiscordAuth\": true,\n    \"requireAccessCode\": true,\n    \"requireXFollow\": true,\n    \"canSwapTokens\": true,\n    \"canPayWithCard\": true,\n    \"allowAffiliate\": true,\n    \"enableCountdown\": true,\n    \"customThemeEnabled\": true,\n    \"disableEmailReceipt\": true\n  },\n  \"recipients\": [\n    {\n      \"currencyId\": \"<string>\",\n      \"walletId\": \"<string>\",\n      \"sourceBlockchainEngine\": \"<string>\"\n    }\n  ],\n  \"splitWallets\": [\n    {\n      \"address\": \"<string>\",\n      \"percent\": 123\n    }\n  ],\n  \"discountCodes\": [\n    {\n      \"percent\": 123,\n      \"token\": \"<string>\",\n      \"prId\": \"<string>\",\n      \"id\": \"<string>\"\n    }\n  ],\n  \"minQuantity\": 123,\n  \"maxQuantity\": 123,\n  \"raffleDetails\": {},\n  \"redirectUrl\": \"<string>\",\n  \"redirectTimeout\": 0,\n  \"description\": \"<string>\",\n  \"notifySenderByEmail\": false,\n  \"notifyReceiverByEmail\": false,\n  \"addDiscordRole\": false,\n  \"discordRoleIds\": [\n    \"<string>\"\n  ],\n  \"disabled\": true,\n  \"dynamic\": true,\n  \"content\": {\n    \"text\": \"<string>\",\n    \"mediaUrl\": \"<string>\",\n    \"mediaAttachmentId\": \"<string>\"\n  },\n  \"maxTransactions\": 123,\n  \"product\": {\n    \"name\": \"<string>\",\n    \"description\": \"<string>\",\n    \"active\": true\n  },\n  \"nftCollectionAddress\": \"<string>\",\n  \"discordAuthDetails\": [\n    {\n      \"serverId\": \"<string>\",\n      \"roleId\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hel.io/v1/paylink/{id}/api-key")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"price\": \"<string>\",\n  \"pricingCurrency\": \"<string>\",\n  \"features\": {\n    \"splitRevenue\": true,\n    \"splitEqually\": true,\n    \"canChangeQuantity\": true,\n    \"requireQuantityLimits\": true,\n    \"canChangePrice\": true,\n    \"isEscrowed\": true,\n    \"showDiscountCode\": true,\n    \"requireAllowlist\": true,\n    \"requireRaffle\": true,\n    \"shouldRedirectOnSuccess\": true,\n    \"requireEmail\": true,\n    \"requireDiscordUsername\": true,\n    \"requireDiscordLogin\": true,\n    \"requireFullName\": true,\n    \"requireTwitterUsername\": true,\n    \"requireTelegramUsername\": true,\n    \"requireCountry\": true,\n    \"requireDeliveryAddress\": true,\n    \"requirePhoneNumber\": true,\n    \"requireProductDetails\": true,\n    \"requireMaxTransactions\": true,\n    \"requireNftGate\": true,\n    \"requireDiscordAuth\": true,\n    \"requireAccessCode\": true,\n    \"requireXFollow\": true,\n    \"canSwapTokens\": true,\n    \"canPayWithCard\": true,\n    \"allowAffiliate\": true,\n    \"enableCountdown\": true,\n    \"customThemeEnabled\": true,\n    \"disableEmailReceipt\": true\n  },\n  \"recipients\": [\n    {\n      \"currencyId\": \"<string>\",\n      \"walletId\": \"<string>\",\n      \"sourceBlockchainEngine\": \"<string>\"\n    }\n  ],\n  \"splitWallets\": [\n    {\n      \"address\": \"<string>\",\n      \"percent\": 123\n    }\n  ],\n  \"discountCodes\": [\n    {\n      \"percent\": 123,\n      \"token\": \"<string>\",\n      \"prId\": \"<string>\",\n      \"id\": \"<string>\"\n    }\n  ],\n  \"minQuantity\": 123,\n  \"maxQuantity\": 123,\n  \"raffleDetails\": {},\n  \"redirectUrl\": \"<string>\",\n  \"redirectTimeout\": 0,\n  \"description\": \"<string>\",\n  \"notifySenderByEmail\": false,\n  \"notifyReceiverByEmail\": false,\n  \"addDiscordRole\": false,\n  \"discordRoleIds\": [\n    \"<string>\"\n  ],\n  \"disabled\": true,\n  \"dynamic\": true,\n  \"content\": {\n    \"text\": \"<string>\",\n    \"mediaUrl\": \"<string>\",\n    \"mediaAttachmentId\": \"<string>\"\n  },\n  \"maxTransactions\": 123,\n  \"product\": {\n    \"name\": \"<string>\",\n    \"description\": \"<string>\",\n    \"active\": true\n  },\n  \"nftCollectionAddress\": \"<string>\",\n  \"discordAuthDetails\": [\n    {\n      \"serverId\": \"<string>\",\n      \"roleId\": \"<string>\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "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"
      }
    }
  }
}

{
  "message": "API key or token is invalid",
  "code": 401
}

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

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.

Show child attributes

recipients

object[]

List of recipient wallets and currencies.

Show child attributes

splitWallets

object[]

List of wallets to distribute the payment among.

Show child attributes

discountCodes

object[]

Array of discount codes applicable to the pay link.

Show child attributes

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.

Show child attributes

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.

Show child attributes

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.

Show child attributes

maxTransactions

number

Maximum number of transactions allowed for this pay link.

product

object | null

Optional product object associated with the pay link.

Show child attributes

nftCollectionAddress

string

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

discordAuthDetails

object[]

Details for Discord authentication and role assignment.

Show child attributes

accessCodeAuthProperties

object

Access code configuration for gated content or purchases.

Show child attributes

eventDetails

object

Event-related configuration like dates and venues.

Show child attributes

countdownDetails

object

Countdown timer settings for scheduled launches.

Show child attributes

customTheme

object

Applies a custom color scheme to the paylink.

Show child attributes

Response

Paylink successfully updated.

Create a Pay Link Disable a Pay Link

⌘I

API

WALLET

CURRENCY

PAY LINKS

TRANSACTIONS

SUBSCRIPTIONS

CHARGES

DEPOSITS

WITHDRAWALS

WEBHOOKS

HEADLESS PAYMENTS

ALLOW LIST

PLATFORM

EXPORTS

Update a Pay Link

Authorizations

Path Parameters

Query Parameters

Body

Response