---
title: "Get a Charge by ID"
method: GET
path: "/v1/charge/{chargeId}"
tags: ["Charge"]
---

# Get a Charge by ID

`GET /v1/charge/{chargeId}`

Retrieve a one-time charge using its unique identifier, `chargeId` (e.g., 28936112-bcf1-4240-a851-85fb087c282a). This ID can be found at the end of the URL when the charge is created.
If the charge has been paid, transaction details will appear under the `paylinkTx` field in the response. If no transaction has occurred yet, the field will be returned as `"paylinkTx": null`.

## Path parameters

- `chargeId` string, required

## Query parameters

- `apiKey` string, required

## Response `200`

Charge successfully retrieved.

- EnrichedCharge
  - `pricingCurrencyRequestAmount` string, required
  - `paylink` Paylink, required
    - `id` string, required
    - `name` string, required
    - `template` 'PRODUCT' | 'SUBSCRIPTION' | 'PRE_SALE' | 'SINGLE_NFT' | 'VIDEO' | 'DISCORD_MEMBERSHIP' | 'TELEGRAM_MEMBERSHIP' | 'INVOICE' | 'EMBEDDED' | 'LINK_OR_FILE' | 'TRADING_VIEW' | 'EVENT' | 'WOO_COMMERCE' | 'OTHER' | 'LEGACY' | 'RAFFLE' | 'SHOPIFY' | 'BLINK' | 'PAYLINK_V2' | 'EMBEDDED_V2' | 'SUBSCRIPTION_V2', required
    - `description` string
    - `price` string, required
    - `normalizedPrice` string
    - `platform` 'HELIO' | 'MAGIC_EDEN', required
    - `disabled` boolean
    - `inactive` boolean
    - `dynamic` boolean
    - `createdAt` string
    - `updatedAt` string
    - `notifySenderByEmail` boolean, required
    - `notifyReceiverByEmail` boolean, required
    - `addDiscordRole` boolean, required
    - `image` string
    - `imageUrl` string
    - `additionalImages` string[]
    - `additionalImageUrls` string[]
    - `maxTransactions` number
    - `redirectUrl` string
    - `redirectTimeout` number
    - `redirectQueryParams` RedirectQueryParamDto[]
      - `queryParamType` 'WALLET_ADDRESS', required — The type of dynamic query parameter to append to the redirect URL.
      - `value` string — Optional custom value for the query parameter.
    - `nftCollectionAddress` string
    - `discordAuthDetails` object[]
    - `affiliateDetails` object, nullable
    - `features` LinkFeatures, required
      - `requireEmail` boolean
      - `requireDiscordUsername` boolean
      - `requireDiscordLogin` boolean
      - `requireFullName` boolean
      - `requireTwitterUsername` boolean
      - `requireTelegramUsername` boolean
      - `requireCountry` boolean
      - `requireDeliveryAddress` boolean
      - `requirePhoneNumber` boolean
      - `requireProductDetails` boolean
      - `requireMaxTransactions` boolean
      - `splitRevenue` boolean
      - `splitEqually` boolean
      - `requireNftGate` boolean
      - `requireDiscordAuth` boolean
      - `requireAccessCode` boolean
      - `requireXFollow` boolean
      - `canSwapTokens` boolean
      - `canPayWithCard` boolean
      - `nftDropEnabled` boolean
      - `showDiscountCode` boolean
      - `allowAffiliate` boolean
      - `isEventEnabled` boolean
      - `enableCountdown` boolean
      - `shouldRedirectOnSuccess` boolean
      - `customThemeEnabled` boolean
      - `hasRedirectQueryParams` boolean
      - `isHelioPlay` boolean
      - `canChangePrice` boolean
      - `requireQuantityLimits` boolean
      - `canChangeQuantity` boolean
      - `isEscrowed` boolean
      - `requireAllowlist` boolean
      - `requireAirdrop` boolean
      - `requireRaffle` boolean
      - `requireCaptchaValidation` boolean
      - `isSubscription` boolean
      - `hasStripeApiKey` boolean
      - `disableEmailReceipt` boolean
    - `minQuantity` number
    - `maxQuantity` number
    - `airdropConfigured` boolean
    - `creator` User, required
      - `id` string, required
      - `userType` 'MERCHANT' | 'BUYER', nullable, required
      - `name` string
      - `email` string
      - `discordUsername` string
      - `twitterUsername` string
      - `isDisabled` boolean
      - `kycVerified` boolean
      - `helioVerified` boolean — undefined = pending helio verification Only set to true/false once approved/denied.
      - `platformDetails` PlatformDetailsBase
        - `platform` 'HELIO' | 'MAGIC_EDEN', required
      - `affiliateCodes` UserAffiliateCode[]
        - `affiliateCode` string, required
    - `company` BaseCompany, required
      - `id` string, required
      - `name` string
      - `email` string
      - `logoUrl` string
      - `websiteUrl` string
      - `twitterUsername` string
      - `discordUsername` string
      - `address` string
      - `phoneNumber` string
      - `twitterConfirmed` boolean
      - `escrowFunds` boolean
      - `kycVerified` boolean
      - `kybVerified` boolean
      - `helioVerified` boolean — undefined = pending helio verification Only set to true/false once approved/denied.
    - `currency` Currency, required
      - `blockchain` Blockchain, required
        - `engine` BlockchainEngine, required
          - `id` string, required
          - `type` 'EVM' | 'SOL' | 'BTC', required
        - `id` string, required
        - `name` string, required
        - `symbol` 'SOL' | 'ETH' | 'POLYGON' | 'BASE' | 'BITCOIN', required
      - `id` string, required
      - `symbol` string, required
      - `name` string, required
      - `mintAddress` string, required
      - `coinMarketCapId` number, required
      - `decimals` number, required
      - `minDecimals` number
      - `symbolPrefix` string
      - `order` number, required
      - `type` 'FIAT' | 'DIGITAL'
      - `features` string[]
      - `iconUrl` string
    - `wallet` Wallet, required
      - `blockchain` Blockchain
        - `engine` BlockchainEngine, required
          - `id` string, required
          - `type` 'EVM' | 'SOL' | 'BTC', required
        - `id` string, required
        - `name` string, required
        - `symbol` 'SOL' | 'ETH' | 'POLYGON' | 'BASE' | 'BITCOIN', required
      - `blockchainEngine` BlockchainEngine, required
        - `id` string, required
        - `type` 'EVM' | 'SOL' | 'BTC', required
      - `id` string, required
      - `publicKey` string, required
      - `name` string
      - `btcProperties` BTCProperties
      - `type` 'EXTENSION' | 'WEB3AUTH'
    - `product` Product
      - `name` string, required
      - `description` string, required
      - `type` string, required
      - `active` boolean, required
      - `optional` boolean, required
    - `pricingCurrency` Currency, required
      - `blockchain` Blockchain, required
        - `engine` BlockchainEngine, required
          - `id` string, required
          - `type` 'EVM' | 'SOL' | 'BTC', required
        - `id` string, required
        - `name` string, required
        - `symbol` 'SOL' | 'ETH' | 'POLYGON' | 'BASE' | 'BITCOIN', required
      - `id` string, required
      - `symbol` string, required
      - `name` string, required
      - `mintAddress` string, required
      - `coinMarketCapId` number, required
      - `decimals` number, required
      - `minDecimals` number
      - `symbolPrefix` string
      - `order` number, required
      - `type` 'FIAT' | 'DIGITAL'
      - `features` string[]
      - `iconUrl` string
    - `recipients` Recipient[]
      - `currency` Currency, required
        - `blockchain` Blockchain, required
          - `engine` BlockchainEngine, required
            - `id` string, required
            - `type` 'EVM' | 'SOL' | 'BTC', required
          - `id` string, required
          - `name` string, required
          - `symbol` 'SOL' | 'ETH' | 'POLYGON' | 'BASE' | 'BITCOIN', required
        - `id` string, required
        - `symbol` string, required
        - `name` string, required
        - `mintAddress` string, required
        - `coinMarketCapId` number, required
        - `decimals` number, required
        - `minDecimals` number
        - `symbolPrefix` string
        - `order` number, required
        - `type` 'FIAT' | 'DIGITAL'
        - `features` string[]
        - `iconUrl` string
      - `wallet` object, required
    - `splitWallets` SplitWallet[]
      - `address` string, required
      - `percent` number
    - `discountCodes` DiscountCode[]
      - `id` string
      - `token` string
      - `percent` number, required
      - `tokenType` string, required
  - `paylinkTx` PaylinkTxWithPublicMeta, required
    - `id` string, required
    - `paylinkId` string
    - `quantity` number, required
    - `createdAt` string, required
    - `fee` string
    - `paymentType` 'PAYLINK' | 'PAYSTREAM' | 'INVOICE' | 'DEPOSIT', required
    - `claimDetails` ClaimDetails, required
      - `tradingView` object
        - `username` string
      - `discord` object
        - `username` string
    - `meta` PublicTransactionMeta, required
      - `id` string, required
      - `amount` string, required
      - `totalAmount` string, required
      - `affiliateAmount` string
      - `transactionSignature` string, required
      - `recipientPK` string, required
      - `senderPK` string, required
      - `splitRevenue` boolean, required
      - `remainingAccounts` SplitAccount[], required
        - `amount` string, required
        - `recipient` string, required
      - `transactionStatus` 'INITIATED' | 'PENDING' | 'SUCCESS' | 'FAILED' | 'CANCELED' | 'SETTLED'
      - `transactionDataHash` string
      - `transactionType` 'REFUND' | 'PAYLINK' | 'BLINK' | 'HELIO_WALLET' | 'SWAP' | 'DEPOSIT'
      - `affiliateCode` string
      - `affiliatePublicKey` string
      - `tokenQuote` object
      - `currency` Currency, required
        - `blockchain` Blockchain, required
          - `engine` BlockchainEngine, required
            - `id` string, required
            - `type` 'EVM' | 'SOL' | 'BTC', required
          - `id` string, required
          - `name` string, required
          - `symbol` 'SOL' | 'ETH' | 'POLYGON' | 'BASE' | 'BITCOIN', required
        - `id` string, required
        - `symbol` string, required
        - `name` string, required
        - `mintAddress` string, required
        - `coinMarketCapId` number, required
        - `decimals` number, required
        - `minDecimals` number
        - `symbolPrefix` string
        - `order` number, required
        - `type` 'FIAT' | 'DIGITAL'
        - `features` string[]
        - `iconUrl` string
  - `isSubscriptionRenewal` boolean, required
  - `id` string, required
  - `prepareRequestBody` PrepareRequestBodyFromCharge, required
    - `currency` string, required
    - `amount` string
    - `quantity` number
    - `pricingCurrencyRateToken` string
  - `requestAmount` string, required
  - `token` string, required
  - `currencySymbol` string, required
  - `redirectUrl` string, required
  - `shopifyPaymentDetails` ShopifyPaymentDetails
    - `shopifyPaymentId` string, required
    - `shopifyPaymentGid` string, required
  - `expiresAt` string — ISO 8601 timestamp indicating when the charge expires. May be absent if no expiry was set at creation.
  - `usdcAmount` string — The charge amount denominated in USDC (minimal units). May be absent depending on the payment flow.

## Other responses

- `401` — API key is missing or invalid.

---

[API](https://skmtc.net/hel/apis/helio-open-api.md) · [All operations](https://skmtc.net/hel/apis/helio-open-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/hel/helio-open-api/revisions/5732beb2d39f/schema)