> For the complete documentation index, see [llms.txt](https://docs.cryptoix.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.cryptoix.io/overview.md).

# Overview

### What Is Cryptoix?

**Cryptoix** (cryptoix.io) is a self-hosted cryptocurrency payment processing platform. Merchants can accept crypto payments from customers, monitor blockchain confirmations in real time, automate payouts, issue invoices, manage subscription billing, and interact with the platform programmatically via a REST API.

***

### Getting Started in 5 Steps

<table><thead><tr><th width="84">Step</th><th>Action</th><th>Where</th></tr></thead><tbody><tr><td>1</td><td>Create an account</td><td><code>/register</code></td></tr><tr><td>2</td><td>Wait for admin approval</td><td>Dashboard shows pending notice</td></tr><tr><td>3</td><td>Create a Payment Gateway</td><td><code>/dashboard/gateways/create</code></td></tr><tr><td>4</td><td>Complete KYC (optional but required for higher limits)</td><td><code>/dashboard/kyc</code></td></tr><tr><td>5</td><td>Integrate via API or payment links</td><td><code>/dashboard/developers</code></td></tr></tbody></table>

***

### Account Statuses

<table><thead><tr><th width="128">Status</th><th width="406">Description</th></tr></thead><tbody><tr><td><code>pending</code></td><td>Account created, awaiting admin approval</td></tr><tr><td><code>approved</code></td><td>Full access to the dashboard and APIs</td></tr><tr><td><code>suspended</code></td><td>Account temporarily restricted</td></tr></tbody></table>

> **Note**: Most dashboard features require **approved** status. New accounts registered via Google OAuth are auto-approved.

***

### Dashboard Sections (User)

<table><thead><tr><th width="160">Section</th><th width="235">URL</th><th>Purpose</th></tr></thead><tbody><tr><td>Dashboard</td><td><code>/dashboard</code></td><td>Overview: stats, recent transactions, gateways</td></tr><tr><td>Profile</td><td><code>/dashboard/profile</code></td><td>Update name, email, phone, password</td></tr><tr><td>Security</td><td><code>/dashboard/security</code></td><td>Change password, manage 2FA, view login history</td></tr><tr><td>Gateways</td><td><code>/dashboard/gateways</code></td><td>Payment gateway management &#x26; API credentials</td></tr><tr><td>API Keys</td><td><code>/dashboard/api-keys</code></td><td>Scoped account-level API keys</td></tr><tr><td>Transactions</td><td><code>/dashboard/transactions</code></td><td>Payment transaction history</td></tr><tr><td>Wallets</td><td><code>/dashboard/wallets</code></td><td>Balances, deposits, withdrawals</td></tr><tr><td>Webhooks</td><td><code>/dashboard/webhooks</code></td><td>Webhook delivery log</td></tr><tr><td>Analytics</td><td><code>/dashboard/analytics</code></td><td>Revenue charts &#x26; CSV export</td></tr><tr><td>KYC</td><td><code>/dashboard/kyc</code></td><td>Identity verification</td></tr><tr><td>Payment Links</td><td><code>/dashboard/links</code></td><td>Shareable payment links</td></tr><tr><td>Invoices</td><td><code>/dashboard/billing</code></td><td>Merchant billing invoices</td></tr><tr><td>Subscriptions</td><td><code>/dashboard/subscriptions</code></td><td>Recurring billing plans</td></tr><tr><td>Batch Payouts</td><td><code>/dashboard/payouts</code></td><td>Bulk payment batches</td></tr><tr><td>Payout Rules</td><td><code>/dashboard/payout-rules</code></td><td>Automated conversion/withdrawal rules</td></tr><tr><td>Support</td><td><code>/dashboard/tickets</code></td><td>Support ticket system</td></tr><tr><td>Notifications</td><td><code>/dashboard/notifications</code></td><td>In-app, email, and Telegram alerts</td></tr><tr><td>Developers</td><td><code>/dashboard/developers</code></td><td>Integration guide and sandbox info</td></tr></tbody></table>

***

### Feature Flags

Some features are enabled or disabled per-deployment by an administrator:

<table><thead><tr><th width="258">Flag</th><th width="360">Feature</th></tr></thead><tbody><tr><td><code>analytics_v1</code></td><td>Analytics dashboard</td></tr><tr><td><code>kyc_v1</code></td><td>Identity verification (KYC)</td></tr><tr><td><code>refund_v1</code></td><td>Refund management</td></tr><tr><td><code>subscriptions_v1</code></td><td>Subscription billing</td></tr><tr><td><code>payment_links_v1</code></td><td>Payment links</td></tr><tr><td><code>invoices_v2</code></td><td>Merchant invoices</td></tr><tr><td><code>webhooks_v2</code></td><td>Async webhook replay via cron</td></tr><tr><td><code>batch_payouts_v1</code></td><td>Batch payout operations</td></tr><tr><td><code>sandbox_mode</code></td><td>Global sandbox/test mode</td></tr></tbody></table>

If a feature is not enabled on your instance, the corresponding menu items and API endpoints will return **404**.

***

### Environments: Live vs. Sandbox

Each Payment Gateway has two API keys:

<table><thead><tr><th width="117">Key Prefix</th><th width="115">Mode</th><th width="405">Description</th></tr></thead><tbody><tr><td><code>sk_live_</code></td><td><strong>Live</strong></td><td>Real transactions on the blockchain</td></tr><tr><td><code>sk_test_</code></td><td><strong>Sandbox</strong></td><td>Simulated payments; no real blockchain activity</td></tr></tbody></table>

You can switch between modes by providing the matching key in API calls. Sandbox transactions are visually tagged in the dashboard.

***

### Support & Documentation

<table><thead><tr><th width="249">Resource</th><th width="295">URL</th></tr></thead><tbody><tr><td>Platform documentation</td><td><code>/docs</code></td></tr><tr><td>API reference</td><td><a href="/spaces/URgAQx0pygRApoSKCsEV/pages/XPbc1ISvsJADYxPETx2Y">API reference</a></td></tr><tr><td>Developer hub</td><td><code>/dashboard/developers</code></td></tr><tr><td>Submit a ticket</td><td><code>/dashboard/tickets/create</code></td></tr><tr><td>Contact (public)</td><td><code>/contact</code></td></tr></tbody></table>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.cryptoix.io/overview.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.