Skip to main content
GET
/
v1
/
charge
/
{chargeId}
Get a Charge by ID
curl --request GET \
  --url https://api.hel.io/v1/charge/{chargeId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "681389bfba5dc7557c9608ec",
  "currencySymbol": "USDC",
  "requestAmount": "1000000",
  "usdcAmount": "1000000",
  "token": "28936112-bcf1-4240-a851-85fb087c282a",
  "prepareRequestBody": {
    "currency": "USDC",
    "amount": "1000000",
    "quantity": 1
  },
  "expiresAt": "2025-09-03T09:52:41.000Z",
  "paylink": {
    "id": "6813481776c142eb631c14fa",
    "platform": "HELIO",
    "template": "LEGACY",
    "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": false,
      "canSwapTokens": false,
      "canPayWithCard": true,
      "nftDropEnabled": false,
      "showDiscountCode": false,
      "isEscrowed": false,
      "requireAllowlist": false,
      "allowAffiliate": false,
      "isEventEnabled": false,
      "enableCountdown": false,
      "requireCaptchaValidation": false,
      "shouldRedirectOnSuccess": false,
      "customThemeEnabled": false,
      "isSubscription": false,
      "hasRedirectQueryParams": false
    },
    "name": "Your paylink name here",
    "discordAuthDetails": [],
    "dynamic": false,
    "affiliateDetails": null,
    "price": "1000000",
    "normalizedPrice": "1000000",
    "redirectQueryParams": [],
    "createdAt": "2025-05-01T10:08:23.829Z",
    "updatedAt": "2025-05-01T10:13:53.682Z",
    "creator": {
      "id": "667c1f9352919e407156128a",
      "userType": "MERCHANT",
      "isDisabled": false,
      "kycVerified": false,
      "platformDetails": {
        "platform": "HELIO"
      },
      "roles": [],
      "wallets": [],
      "payoutWallets": []
    },
    "company": {
      "id": "667c1f9352919e407156128c",
      "name": "Helio",
      "websiteUrl": "",
      "discordUsername": "",
      "escrowFunds": false,
      "twitterConfirmed": false,
      "kycVerified": false,
      "kybVerified": false,
      "logoUrl": "https://helioimages113109-prod.s3.eu-west-1.amazonaws.com/attachments/l6uYjlJX5WGhnJZE2MBbYDEP0UFFonPObmVL1LJo.png?AWSAccessKeyId=AKIAZIDE2VZR6C743GDI&Expires=1746111914&Signature=g23tB1gz15LKEskaJ0rjLmS7j8s%3D"
    },
    "currency": {
      "id": "6340313846e4f91b8abc519b",
      "name": "USD Coin",
      "decimals": 6,
      "order": 1,
      "mintAddress": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
      "coinMarketCapId": 3408,
      "symbol": "USDC",
      "symbolPrefix": "$",
      "type": "DIGITAL",
      "iconUrl": "USDC.svg",
      "features": [
        "PAYMENT_PRICING",
        "PAYMENT_RECIPIENT",
        "SWAP"
      ],
      "blockchain": {
        "id": "6340313846e4f91b8abc515c",
        "name": "SOL",
        "symbol": "SOL",
        "engine": {
          "id": "63b6b1200cfb4b3f6131f2b4",
          "type": "SOL"
        }
      }
    },
    "wallet": {
      "id": "667c1f9352919e4071561294",
      "name": "",
      "publicKey": "7YancRyNQyp9s6G7YNwx9H93UqswoKWqF9GuNJPufyvW",
      "btcProperties": null,
      "type": "EXTENSION",
      "blockchainEngine": {
        "id": "63b6b1200cfb4b3f6131f2b4",
        "type": "SOL"
      }
    },
    "recipients": [
      {
        "currency": {
          "id": "6340313846e4f91b8abc519b",
          "name": "USD Coin",
          "decimals": 6,
          "order": 1,
          "mintAddress": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
          "coinMarketCapId": 3408,
          "symbol": "USDC",
          "symbolPrefix": "$",
          "type": "DIGITAL",
          "iconUrl": "USDC.svg",
          "features": [
            "PAYMENT_PRICING",
            "PAYMENT_RECIPIENT",
            "SWAP"
          ],
          "blockchain": {
            "id": "6340313846e4f91b8abc515c",
            "name": "SOL",
            "symbol": "SOL",
            "engine": {
              "id": "63b6b1200cfb4b3f6131f2b4",
              "type": "SOL"
            }
          }
        },
        "wallet": {
          "id": "667c1f9352919e4071561294",
          "name": "",
          "publicKey": "7YancRyNQyp9s6G7YNwx9H93UqswoKWqF9GuNJPufyvW",
          "btcProperties": null,
          "type": "EXTENSION",
          "blockchainEngine": {
            "id": "63b6b1200cfb4b3f6131f2b4",
            "type": "SOL"
          }
        }
      }
    ],
    "product": null,
    "additionalImageUrls": [],
    "discountCodes": [],
    "pricingCurrency": {
      "id": "6340313846e4f91b8abc519b",
      "name": "USD Coin",
      "decimals": 6,
      "order": 1,
      "mintAddress": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
      "coinMarketCapId": 3408,
      "symbol": "USDC",
      "symbolPrefix": "$",
      "type": "DIGITAL",
      "iconUrl": "USDC.svg",
      "features": [
        "PAYMENT_PRICING",
        "PAYMENT_RECIPIENT",
        "SWAP"
      ],
      "blockchain": {
        "id": "6340313846e4f91b8abc515c",
        "name": "SOL",
        "symbol": "SOL",
        "engine": {
          "id": "63b6b1200cfb4b3f6131f2b4",
          "type": "SOL"
        }
      }
    }
  },
  "paylinkTx": null,
  "pricingCurrencyRequestAmount": "1000000",
  "isSubscriptionRenewal": false
}
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

chargeId
string
required

The unique identifier of the charge to retrieve.

Query Parameters

apiKey
string
required

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

Response

Charge successfully retrieved.

id
string
required
pageUrl
string
required