Get Charge Status
curl --request GET \
--url https://api.hel.io/v1/charge/api-key/{token} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.hel.io/v1/charge/api-key/{token}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.hel.io/v1/charge/api-key/{token}', 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/charge/api-key/{token}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.hel.io/v1/charge/api-key/{token}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.hel.io/v1/charge/api-key/{token}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hel.io/v1/charge/api-key/{token}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"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": {
"id": "681389c0ba5dc7557c960901",
"paylinkId": "6813481776c142eb631c14fa",
"quantity": 1,
"createdAt": "2025-09-03T09:22:56.000Z",
"fee": "0",
"paymentType": "PAYLINK",
"claimDetails": {
"tradingView": null,
"discord": null
},
"meta": {
"id": "681389c0ba5dc7557c960902",
"amount": "1000000",
"totalAmount": "1000000",
"transactionSignature": "3xF7k2pVmRjKdQyN8mWcTa5bZE9vHpL4nR6sGtU1wXoA7cY2fD8eJ4gH5iK9lM0nO1pQ3rS6tU",
"recipientPK": "BZx1GkP3tVmRjKdQyN8mWcTa5bZE9vHpL4nR6sGtU1wX",
"senderPK": "7Xy2hN9kL3mP5qR8sT1vW4xZ6bC0dF3gJ7iK2lM4nO",
"splitRevenue": false,
"remainingAccounts": [],
"transactionStatus": "SUCCESS",
"transactionType": "PAYLINK",
"currency": {
"id": "6340313846e4f91b8abc5183",
"name": "USD Coin",
"symbol": "USDC",
"mintAddress": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
"coinMarketCapId": 3408,
"decimals": 6,
"order": 1,
"type": "DIGITAL",
"blockchain": {
"id": "6340313846e4f91b8abc515c",
"name": "SOL",
"symbol": "SOL",
"engine": {
"id": "63b6b1200cfb4b3f6131f2b4",
"type": "SOL"
}
}
}
}
},
"pricingCurrencyRequestAmount": "1000000",
"isSubscriptionRenewal": false,
"redirectUrl": "https://example.com/success",
"shopifyPaymentDetails": null
}CHARGES
Get Charge Status
Poll the status of a charge you created, authenticated with your API key and secret. Returns the same response as Get a Charge by ID, with its own rate limit instead of the shared public per-IP limit.
GET
/
v1
/
charge
/
api-key
/
{token}
Get Charge Status
curl --request GET \
--url https://api.hel.io/v1/charge/api-key/{token} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.hel.io/v1/charge/api-key/{token}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.hel.io/v1/charge/api-key/{token}', 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/charge/api-key/{token}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.hel.io/v1/charge/api-key/{token}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.hel.io/v1/charge/api-key/{token}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hel.io/v1/charge/api-key/{token}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"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": {
"id": "681389c0ba5dc7557c960901",
"paylinkId": "6813481776c142eb631c14fa",
"quantity": 1,
"createdAt": "2025-09-03T09:22:56.000Z",
"fee": "0",
"paymentType": "PAYLINK",
"claimDetails": {
"tradingView": null,
"discord": null
},
"meta": {
"id": "681389c0ba5dc7557c960902",
"amount": "1000000",
"totalAmount": "1000000",
"transactionSignature": "3xF7k2pVmRjKdQyN8mWcTa5bZE9vHpL4nR6sGtU1wXoA7cY2fD8eJ4gH5iK9lM0nO1pQ3rS6tU",
"recipientPK": "BZx1GkP3tVmRjKdQyN8mWcTa5bZE9vHpL4nR6sGtU1wX",
"senderPK": "7Xy2hN9kL3mP5qR8sT1vW4xZ6bC0dF3gJ7iK2lM4nO",
"splitRevenue": false,
"remainingAccounts": [],
"transactionStatus": "SUCCESS",
"transactionType": "PAYLINK",
"currency": {
"id": "6340313846e4f91b8abc5183",
"name": "USD Coin",
"symbol": "USDC",
"mintAddress": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
"coinMarketCapId": 3408,
"decimals": 6,
"order": 1,
"type": "DIGITAL",
"blockchain": {
"id": "6340313846e4f91b8abc515c",
"name": "SOL",
"symbol": "SOL",
"engine": {
"id": "63b6b1200cfb4b3f6131f2b4",
"type": "SOL"
}
}
}
}
},
"pricingCurrencyRequestAmount": "1000000",
"isSubscriptionRenewal": false,
"redirectUrl": "https://example.com/success",
"shopifyPaymentDetails": null
}Use this endpoint, not the public Get a Charge by ID, to poll charge status. See Polling charge status for rate limits and back-off guidance.
Authorizations
Authentication using JWT token
Path Parameters
The charge token (e.g. the segment at the end of https://app.hel.io/charge/{token}).
Query Parameters
Your API key, which can be generated from the Helio Dashboard settings page.
Response
Charge successfully retrieved.
Show child attributes
Show child attributes
The transaction associated with this charge. Null when the charge has not yet been paid.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Shopify payment session details. Only present for charges created via a Shopify integration, null otherwise.
Show child attributes
Show child attributes
ISO 8601 timestamp indicating when the charge expires. May be absent if no expiry was set at creation.
The charge amount denominated in USDC (minimal units). May be absent depending on the payment flow.