v1

latestOpenAPI 3.0.02026-07-2656110201.6 KB
Charge

Get a Charge by ID

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.

get/v1/charge/{chargeId}

Path parameters

chargeIdstring required

The unique identifier of the charge to retrieve.

Query parameters

apiKeystring required

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

Response

Charge successfully retrieved.

pricingCurrencyRequestAmountstring required
isSubscriptionRenewalboolean required
idstring required
requestAmountstring required
tokenstring required
currencySymbolstring required
redirectUrlstring required
expiresAtstring

ISO 8601 timestamp indicating when the charge expires. May be absent if no expiry was set at creation.

usdcAmountstring

The charge amount denominated in USDC (minimal units). May be absent depending on the payment flow.