💻API

Use the Helio API to create payments and track transactions

Full API Specification:

End-to-End Code Examples of a Demo Helio App (API, Webhooks and Checkout Widget):

Pre-requisites

NOTE: When using the production environment (app.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 app.dev.hel.io.

In order to perform actions using the Helio API, you need to complete the following steps.

1. Create Helio Account & get API keys

Go to Helio and log in.
Under Settings -> API, check Enable to generate your Public and Secret API Keys.
Save these securely, as the Secret API Key won’t be retrievable later (you can regenerate both if needed).

IMPORTANT: If you use the Solana Pay plug-in for Shopify, you must first "link" a wallet in Settings -> Manage Wallets before you can generate an API key

2. Prepare request payload

Specify the recipient wallet, payment currency, and accepted recipient currencies:
Under Settings -> Manage Wallets, click the three dots next to your wallet and select Copy Helio ID (note: this is different from your Public Key).

Retrieving all supported currencies

You can retrieve all supported currencies on Helio using the following API request:

API Endpoint: https://api.hel.io/v1/currency/all
HTTP Method: GET

For example here is a SOL currency object returned from this endpoint:

{
  id: '6340313846e4f91b8abc519b', // Copy this id
  name: 'USD Coin',
  decimals: 6,
  order: 1,
  mintAddress: 'EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v',
  coinMarketCapId: 3408,
  symbol: 'USDC',
  symbolPrefix: '$',
  type: 'DIGITAL',
  iconUrl: 'USDC.svg',
  features: ['PAYMENT_PRICING', 'PAYMENT_RECIPIENT'],
  blockchain: {
    id: '6340313846e4f91b8abc515c',
    name: 'SOL',
    symbol: 'SOL',
    engine: { id: '63b6b1200cfb4b3f6131f2b4', type: 'SOL' },
  }
}

You should now have the following information:

Public API Key, Secret API Key, Helio ID, Currency ID

Further Documentation

Create Pay Links via API

Query Transactions via API

Create Subscriptions via API

Query Subscriptions via API

PreviousCheckout Widget NextCreate Pay Links via API

Last updated 6 days ago

{ id: '6340313846e4f91b8abc519b', // Copy this id name: 'USD Coin', decimals: 6, order: 1, mintAddress: 'EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v', coinMarketCapId: 3408, symbol: 'USDC', symbolPrefix: '$', type: 'DIGITAL', iconUrl: 'USDC.svg', features: ['PAYMENT_PRICING', 'PAYMENT_RECIPIENT'], blockchain: { id: '6340313846e4f91b8abc515c', name: 'SOL', symbol: 'SOL', engine: { id: '63b6b1200cfb4b3f6131f2b4', type: 'SOL' }, } }