> 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/how-to-guides-1.md). # How to Guides ### Create Your First Payment Link Payment links are a quick and easy way to request a one-time payment from a customer for a specific amount. **Scenario:** A freelance graphic designer needs to bill a client for a completed logo design. **Prerequisites:** * A Cryptoix merchant account. * At least one cryptocurrency gateway configured in your account. **Steps:** 1. Log in to your Cryptoix merchant dashboard. 2. Navigate to the **Payment Links** section. 3. Click the **Create New Link** button. 4. Enter the **Amount** you wish to charge (e.g., `500`). 5. Select the **Currency** for the payment (e.g., `USD`). 6. (Optional) Add a **Description** for the payment (e.g., "Logo Design - Project Alpha"). 7. (Optional) Set an **Expiration Date** for the link. 8. Click **Create Link**. **Expected Result:** A unique payment link will be generated. You can copy this link and send it to your customer via email or message. When the customer clicks the link, they will be taken to a secure payment page to complete the transaction using their preferred cryptocurrency. **What to do if it fails:** * Ensure you have a valid cryptocurrency gateway configured in your dashboard. * Check that you have selected a supported currency. * If you continue to experience issues, contact support. *** ### Send an Invoice Invoices allow you to formally bill your customers for goods or services, with clear details and due dates. **Scenario:** A small consulting firm needs to send a formal invoice to a client for monthly retainer services. **Prerequisites:** * A Cryptoix merchant account. * At least one cryptocurrency gateway configured. **Steps:** 1. Log in to your Cryptoix merchant dashboard. 2. Navigate to the **Invoices** section. 3. Click the **Create New Invoice** button. 4. Enter the **Customer's Email Address**. 5. Add an **Invoice Title** (e.g., "Monthly Retainer - October"). 6. Enter the **Amount** and select the **Currency** (e.g., `1500` `USD`). 7. Set a **Due Date** for the invoice. 8. (Optional) Add **Line Items** with descriptions and prices for specific services or products. 9. (Optional) Add **Notes** for the customer. 10. Click **Create Invoice**. **Expected Result:** The invoice will be created and, if your email service is configured, sent to the customer's email address. The invoice will also appear in your **Invoices** list in the dashboard. The customer can click a link in the email to view and pay the invoice using cryptocurrency. **What to do if it fails:** * Verify the customer's email address is correct. * Ensure your gateway and currency settings are properly set up. * If the invoice doesn't appear or send correctly, check your email service configuration and delivery logs in your Cryptoix dashboard. Contact support if issues persist. *** ### Create a Subscription Set up recurring payments for your customers, ideal for memberships, SaaS, or regular service fees. Cryptoix will generate invoices on a schedule for the customer to pay. **Scenario:** A SaaS provider wants to offer a monthly subscription plan for their software. **Prerequisites:** * A Cryptoix merchant account. * At least one cryptocurrency gateway configured. * Your platform's cron job for generating subscription invoices must be configured and running. * Your email service (SMTP) must be configured for sending invoices. **Steps:** 1. Log in to your Cryptoix merchant dashboard. 2. Navigate to the **Subscriptions** section. 3. Click the **Create New Subscription** button. 4. Enter the **Customer's Email Address**. 5. Define the **Subscription Name** (e.g., "Pro Plan - Monthly"). 6. Set the **Amount** and **Currency** for each billing cycle (e.g., `99` `USD`). 7. Choose the **Billing Interval** (e.g., `Monthly`). 8. Set the **Start Date** for the subscription. 9. (Optional) Set an **End Date** or the total number of billing cycles. 10. Click **Create Subscription**. **Expected Result:** A subscription plan will be created. Cryptoix will generate an invoice for the customer based on the interval you set, and if your email service is configured, it will be sent. The customer will need to pay this invoice via the provided link. You can view and manage all your subscriptions from the **Subscriptions** page. **What to do if it fails:** * Ensure the customer's email is valid. * Confirm your gateway and currency settings are correct. * If invoices are not being generated, verify that the subscription invoice generation cron job (`cron/generate_subscription_invoices.php`) is set up and running correctly on your server. * If invoices are generated but not sent, check your email service (SMTP) configuration in your Cryptoix settings and review email delivery logs. * Contact support if you need further assistance. *** ### Refund a Payment Process refunds for transactions directly from your Cryptoix dashboard. **Scenario:** A customer accidentally paid twice for an order, and the merchant needs to refund one of the payments. **Prerequisites:** * A Cryptoix merchant account. * A completed transaction that you wish to refund. * The **Refunds** feature may need to be enabled for your account or the platform. **Steps:** 1. Log in to your Cryptoix merchant dashboard. 2. Navigate to the **Transactions** section. 3. Find the transaction you want to refund and click on it to view details. 4. On the transaction details page, click the **Refund** button. 5. Enter the **Refund Amount**. You can refund the full amount or a partial amount. 6. Select the **Currency** for the refund. 7. (Optional) Add a **Reason** for the refund (e.g., "Duplicate payment"). 8. Click **Confirm Refund**. **Expected Result:** The refund will be initiated. The customer will be notified, and the refunded amount will be processed. The transaction status will be updated to reflect the refund. Depending on the refund type (balance-backed or external), your available balance may be adjusted. **What to do if it fails:** * Ensure the transaction is eligible for a refund (e.g., not too old, not already fully refunded). * Check that you have sufficient balance in your Cryptoix account to cover the refund if it's balance-backed. * Refunds may require specific permissions or manual approval depending on your account setup. * If the refund fails, contact support with the transaction ID. *** ### Request a Withdrawal Transfer your earned cryptocurrency from your Cryptoix account to your external wallet. **Scenario:** A merchant has accumulated a balance in their Cryptoix account and wants to move the funds to their personal hardware wallet. **Prerequisites:** * A Cryptoix merchant account with a positive balance. * Completed KYC verification, if required for your account. * A verified cryptocurrency wallet address where you want to receive funds. * Sufficient balance to cover the withdrawal amount and any associated fees. * Your account must be within any applicable withdrawal limits. **Steps:** 1. Log in to your Cryptoix merchant dashboard. 2. Navigate to the **Wallets** section. 3. Select the cryptocurrency **Balance** you wish to withdraw. 4. Click the **Withdraw** button. 5. Enter the **Amount** you want to withdraw. 6. Select the **Destination Wallet Address** from your saved addresses, or add a new one. 7. Review the withdrawal **Fee**. 8. Click **Request Withdrawal**. **Expected Result:** Your withdrawal request will be submitted for processing. You will receive a confirmation, and the funds will be sent to your specified wallet address after verification and processing. The status of your withdrawal can be tracked in the **Withdrawals** history. **What to do if it fails:** * Ensure your balance is sufficient to cover the withdrawal amount and fees. * Double-check that the destination wallet address is correct and belongs to you. * Verify that your account meets any KYC requirements or withdrawal limits. * If you encounter persistent issues, contact support. *** ### Install an Ecommerce Plugin Integrate Cryptoix with your online store using our pre-built plugins. This guide provides general steps; refer to specific plugin documentation for detailed instructions. **Scenario:** An online retailer using WooCommerce wants to offer cryptocurrency as a payment option at their store's checkout. **Prerequisites:** * A Cryptoix merchant account. * An active e-commerce store using one of the supported platforms: WooCommerce, Easy Digital Downloads, Magento 2, OpenCart, PrestaShop, Shopify, or WHMCS. * Admin access to your e-commerce store's backend. **Steps:** 1. **Download the Plugin:** Visit the Cryptoix website or your dashboard to download the plugin for your specific e-commerce platform. 2. **Install the Plugin:** * **For platforms like WooCommerce/WordPress:** Navigate to your WordPress admin panel, go to **Plugins** > **Add New** > **Upload Plugin**. Choose the downloaded ZIP file and click **Install Now**. * **For other platforms:** Follow their specific instructions for installing third-party extensions or apps. 3. **Activate the Plugin:** Once installed, activate the Cryptoix plugin from your e-commerce platform's plugin or app management area. 4. **Configure the Plugin:** * In your e-commerce store's admin panel, find the Cryptoix settings (often under **Settings** or **Payments**). * You will need to enter the **API key or gateway credentials** required by the specific plugin. This is typically found in your Cryptoix merchant dashboard's API Keys section or Gateway settings. * Configure other settings as required by the plugin, such as selecting the payment gateway, setting a webhook/callback URL, or entering a secret key. Refer to the platform-specific plugin documentation for details. 5. **Save Changes:** Save your configuration settings. **Expected Result:** Cryptoix will be integrated as a payment option on your e-commerce store's checkout page. Customers can now select Cryptoix to pay for their orders using cryptocurrency. Transactions will appear in your Cryptoix dashboard. **What to do if it fails:** * Ensure you have downloaded the correct plugin version for your platform. * Verify that your API key or gateway credentials are entered correctly. * Check your e-commerce platform's error logs for specific issues. * Consult the detailed documentation for your specific e-commerce platform's plugin. * Contact Cryptoix support if you need further assistance. *** ### Create an API Key for a Developer API keys allow developers to integrate Cryptoix services into your applications programmatically. **Scenario:** A merchant's development team needs to build a custom integration to automatically create payment links for their internal tools. **Prerequisites:** * A Cryptoix merchant account. **Steps:** 1. Log in to your Cryptoix merchant dashboard. 2. Navigate to the **API Keys** section within your account settings or security area. 3. Click the **Create New API Key** button. 4. Provide a **Label** for the key (e.g., "Internal Tool Integration"). This helps you identify its purpose. 5. Select the **Permissions** (scopes) you want to grant to this API key. Be mindful of granting only necessary permissions. 6. Click **Generate Key**. **Expected Result:** Your API Key will be generated. **Treat your API Key like a password and keep it secure.** You will typically use this key in your application's code to authenticate requests to the Cryptoix API. You can view and revoke existing API keys from this page. **What to do if it fails:** * Ensure you are logged in to your merchant account. * If you cannot find the API Keys section, check your account permissions or contact support. * For detailed API usage, please refer to the [Developer API Documentation](broken://pages/cf45ffbeffbe9b6c20574da768909f8046aa15fe). *** ### Check a Webhook Delivery Webhooks allow Cryptoix to send automated notifications to your server when specific events occur (e.g., a payment is confirmed). This guide helps you check if these notifications are being delivered successfully. **Scenario:** A merchant's integration isn't receiving payment confirmation notifications, and they need to troubleshoot why. **Prerequisites:** * A Cryptoix merchant account. * A webhook endpoint configured in your Cryptoix dashboard (usually under **Settings** > **Webhooks**). **Steps:** 1. Log in to your Cryptoix merchant dashboard. 2. Navigate to the **Webhooks** section. 3. Find the webhook configuration you are interested in. 4. Click on the **Delivery Log** or **History** associated with that webhook. **Expected Result:** You will see a list of recent webhook delivery attempts. Each entry should show: * The **Event** that triggered the webhook. * The **Timestamp** of the delivery attempt. * The **URL** of your configured endpoint. * The **Status** (e.g., "Success", "Failed"). * The **Response Code** from your server (e.g., `200 OK`). If a delivery shows "Success" with a `2xx` status code, Cryptoix successfully sent the notification and your server acknowledged it. If it shows "Failed" or a non-`2xx` status code, there might be an issue with your server's configuration or accessibility. **What to do if it fails:** * **Check your server's logs:** Examine your server's application logs for incoming requests from Cryptoix at the specified webhook URL. * **Verify your webhook URL:** Ensure the URL is correct and publicly accessible from the internet. * **Check firewall rules:** Make sure your server's firewall is not blocking incoming requests from your Cryptoix server's outbound IP addresses. * **Review your server-side code:** Ensure your endpoint is correctly processing the incoming data and returning a success status code (e.g., `200 OK`). * **Retry Delivery:** If available, use the "Retry" option in the delivery log for failed attempts. * Contact support if you continue to have delivery issues. *** ### Export or Review Transactions Access and download your transaction history for accounting, auditing, or record-keeping purposes. **Scenario:** An accounting team needs to reconcile monthly sales figures and requires a detailed report of all transactions. **Prerequisites:** * A Cryptoix merchant account. **Steps:** 1. Log in to your Cryptoix merchant dashboard. 2. Navigate to the **Transactions** section. 3. You can review transactions directly on the page. Use the filters (Date Range, Status, Currency) to narrow down your search. 4. To export your transaction history: * Apply any desired filters (e.g., a specific date range like "Last Month"). * Click the **Export** or **Download CSV** button. **Expected Result:** Your transaction history will be displayed on the screen, allowing you to review details like date, amount, currency, status, and customer information. An exported file (usually in CSV format) will be downloaded to your computer, containing all filtered transaction data. **What to do if it fails:** * Ensure you have selected the correct date range or filters for your desired data. * If the export button is not visible or doesn't work, check your browser's console for errors or contact support. * If the downloaded CSV file is empty or corrupted, try exporting again with fewer filters or a smaller date range. --- # 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/how-to-guides-1.md?ask=&goal= ``` `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.