SDK

For a complete list of available methods, types, and configuration options, visit the official packages on NPM:

🧾

Paylinks SDK

💳

Deposits SDK

ℹ️

Refer to the guide here for instructions on generating your API keys.

Import

Import the SDK into your project using ES modules:

/** 
 * npm i @heliofi/sdk
 **/

import {HelioSDK} from '@heliofi/sdk';

Once you've included the script or package, you're ready to initialise the SDK and start integrating with our suite of cryptocurrency payment solutions.

Example Usage

Then, import and initialise the SDK in your project, and immediately begin using it — for example, to create a pay link:

import HelioSDK from '@heliofi/sdk';

const sdk = new HelioSDK({
  apiKey: 'your-public-api-key',
  secretKey: 'your-secret-key',
  network: 'mainnet', // or 'devnet' (optional, mainnet by default)
});

const paylink = await sdk.paylink.create(createPaylinkDto);

Replace the placeholders with your actual API credentials.