Create a Merchant Account via API

Programmatically Create a Merchant Account on Helio

You can create a Merchant Account on Helio via API to generate payment links, accept crypto, and manage transactions. This is ideal for B2B platforms embedding crypto payments, enabling seamless user onboarding.

Apply for Platform-Level API Access

This feature is not publicly available. To access it and receive your platform API keys, please email hi@hel.io to express your interest in a partnership.

Create the merchant account and provide the required details such as ID, name, email, wallets, etc.

NOTE: When using the production environment (app.hel.io), set your API endpoint to api.hel.io/v1. For the development environment, use api.dev.hel.io/v1.

API Endpoint: https://api.hel.io/v1/auth/external/sign-up
HTTP Method: POST
Required Query Parameters: ?apiKey={{Your public key here}}
Required Headers: Authorization: Bearer {{Your API Token here}}

Example Request Body:

{
  "id": "c81aede4-c247-431f-84b8-16629c983abe", // Set your own unique identifier for the account
  "company": {
    "name": "Test Company", // Name of the merchant's company
    "email": "test@test.com", // Company contact email
    "phoneNumber": "+1234567890", // Company contact phone number
    "discordUsername": "test-discord-username", // Discord username
    "websiteUrl": "https://test.com", // Company's website URL
    "kycVerified": true // Indicates whether the company has passed KYC verification
  },
  "user": {
    "name": "Test", // Name of the primary user or account owner
    "email": "test@test.com" // Email of the user associated with the merchant account
  },
  "wallets": [
    {
      "name": "Test Wallet", // Wallet name
      "address": "DsUFWNpve7hVQdhWDAfUTGq78SpZZ3tVLdnJiRa54QBU" // Wallet address
    }
  ]
}

Keep the "id", as it will be required to sign back into the account.

Example Response Body:

{
    "user": {
        "id": "67e29a194f62619a3cb8d672",
        "email": "test@test.com",
        "userType": null,
        "name": "Test",
        "payoutWallets": [
            {
                "id": "67e29a194f62619a3cb8d67e",
                "publicKey": "DsUFWNpve7hVQdhWDAfUTGq78SpZZ3tVLdnJiRa54QBU",
                "name": "Test Wallet"
            }
        ]
    },
    "company": {
        "id": "67e29a194f62619a3cb8d674",
        "name": "Test Company",
        "email": "test@test.com",
        "websiteUrl": "https://test.com",
        "discordUsername": "test-discord-username",
        "phoneNumber": "+1234567890",
        "kycVerified": true
    },
    "redirectUrl": "https://app.hel.io/auth/external-login?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY3ZTI5YTE5NGY2MjYxOWEzY2I4ZDY3MiIsImlhdCI6MTc0MjkwMzgzMywiZXhwIjoxNzQyOTAzOTUzfQ.uxM1RlRcgiEbKk1NZYOAbCZdzxxkmKuJ5kH8bt87DFM"
}

You will receive a redirect URL containing the link to the Helio dashboard, allowing access to the newly created account.

This endpoint is used to sign back into your previously created account.

NOTE: When using the production environment (app.hel.io), set your API endpoint to api.hel.io/v1. For the development environment, use api.dev.hel.io/v1.

API Endpoint: https://api.hel.io/v1/auth/external/sign-up
HTTP Method: POST
Required Query Parameters: ?apiKey={{Your public key here}}

Example Request Body:

{
    "id": "c81aede4-c247-431f-84b8-16629c983abe"
}

Use the "id" you used to sign up to sign back into the account.

Example Response Body:

{
    "user": {
        "id": "67e29a194f62619a3cb8d672",
        "email": "test@test.com",
        "userType": null,
        "name": "Test",
        "payoutWallets": [
            {
                "id": "67e29a194f62619a3cb8d67e",
                "publicKey": "DsUFWNpve7hVQdhWDAfUTGq78SpZZ3tVLdnJiRa54QBU",
                "name": "Test Wallet"
            }
        ]
    },
    "company": {
        "id": "67e29a194f62619a3cb8d674",
        "name": "Test Company",
        "email": "test@test.com",
        "websiteUrl": "https://test.com",
        "discordUsername": "test-discord-username",
        "phoneNumber": "+1234567890",
        "kycVerified": true
    },
    "redirectUrl": "https://app.dev.hel.io/auth/external-login?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY3ZTI5YTE5NGY2MjYxOWEzY2I4ZDY3MiIsImlhdCI6MTc0Mjk4NTYwNCwiZXhwIjoxNzQyOTg1NzI0fQ.2er7MIr4Z6nd3FXLQUAnrhwo6S2W69dJX7m4rFzmW4g"
}
```

You will receive this request body containing all the details you provided during sign-up, along with a redirect URL to access the Helio dashboard again.

PreviousQuery Subscriptions via API NextRedirect URL with Query Params

Last updated 1 month ago

Apply for Platform-Level API Access

User Sign Up

User Sign In