# Documentation - MineStoreCMS

## Docs

- [Overview](https://docs.minestorecms.com/backend/overview.md): Learn more about MineStoreCMS Backend and Operating Services.
- [Adding Cloudflare Rule](https://docs.minestorecms.com/extra/cloudflare-rule.md): Learn how to add a Cloudflare rule to avoid rate limiting & IP blocking issues from your Minecraft Server.
- [How to Accept Paysafecard?](https://docs.minestorecms.com/faq/how-accept-paysafecard.md): Learn which payment gateways are accepting Paysafecard.
- [Editing Discord Messages](https://docs.minestorecms.com/faq/how-to-change-discord-message.md): Learn how to edit a Discord message about new purchases.
- [Changing Domain](https://docs.minestorecms.com/faq/how-to-change-domain.md): Learn how to change the domain of your MineStoreCMS Instance.
- [How to Enable Debug Mode?](https://docs.minestorecms.com/faq/how-to-enable-debug-mode.md): Learn how to enable debug mode in MineStoreCMS to troubleshoot issues and errors.
- [Migration on Other Server](https://docs.minestorecms.com/faq/how-to-migrate-on-other-server.md): Learn how to migrate MineStoreCMS on another server with saving data.
- [Receiving SSL Certificate](https://docs.minestorecms.com/faq/how-to-receive-ssl.md): Learn how to receive SSL for your domain using Lets Encrypt.
- [Changing Header Image](https://docs.minestorecms.com/faq/how-to-update-header.md): Learn how to change the header image on your MineStoreCMS Default Theme. Follow the steps to update the header image.
- [Images Aren't Updating](https://docs.minestorecms.com/faq/my-logo-is-not-updating.md): Learn how to fix the issue when your logo and other images are not updating on your MineStoreCMS webstore. Follow issue solutions step by step.
- [Upgrading from 3.2.5 to 3.3.0](https://docs.minestorecms.com/faq/upgrade-from-325-to-330.md): Learn how to upgrade your MineStoreCMS from version 3.2.1 to 3.3.0.
- [Upgrading from 3.4.5 to 3.5.0](https://docs.minestorecms.com/faq/upgrade-from-345-to-350.md): Learn how to upgrade your MineStoreCMS from version 3.4.5 to 3.5.0.
- [Admin Profile](https://docs.minestorecms.com/features/admin-profile.md): Learn how to protect your admin profile with a password and two-factor authentication.
- [Announcements](https://docs.minestorecms.com/features/announcement.md): You can create and manage announcements to inform your users about important updates, promotions, or events.
- [Categories](https://docs.minestorecms.com/features/categories.md): Categories are used to organize your packages into different sections. You can create categories for different types of packages like ranks, items, or permissions. You can also create subcategories to further organize your packages.
- [Account Authorization](https://docs.minestorecms.com/features/classic-auth.md): You can enable the "Classic Auth" feature to ensure that the player has created an account on the webstore or your Minecraft server.
- [Cumulative Packages](https://docs.minestorecms.com/features/cumulative-categories.md): You can enable the "Cumulative Packages" feature to offer discounts to users based on the packages they have previously purchased.
- [Custom Pages](https://docs.minestorecms.com/features/custom-pages.md): You can create custom pages to display additional information on your webstore such as Terms of Service, Privacy Policy, or Contact Us.
- [Banlist](https://docs.minestorecms.com/features/customers/banlist.md): Banlist is a feature that allows you to ban a customer from your store.
- [Whitelist](https://docs.minestorecms.com/features/customers/whitelist.md): Whitelist is a feature that allows you to whitelist a customer in your store.
- [Discord Bot](https://docs.minestorecms.com/features/discord-bot.md): Sync your Discord server with your webstore to manage roles and permissions.
- [Coupons](https://docs.minestorecms.com/features/discounts/coupons.md): Create and manage coupons to offer discounts to your customers.
- [Gift Cards](https://docs.minestorecms.com/features/discounts/giftcards.md): Create and manage gift cards to offer discounts to your customers in the form of a gift card.
- [Sales](https://docs.minestorecms.com/features/discounts/sales.md): Create and manage sales to offer global and automatic discounts for specific packages or categories.
- [Donation Goals](https://docs.minestorecms.com/features/donation-goals.md): You can create and manage donation goals to set targets and encourage donations from your customers.
- [Featured Deals](https://docs.minestorecms.com/features/featured-deals.md): You can create and manage featured deals to showcase packages on the home page.
- [Chargeback Prevention](https://docs.minestorecms.com/features/fraud/chargeback-prevention.md): Learn how to prevent chargebacks by setting up trigger blocks and preventing potentially fraudulent transactions.
- [Chargebacks](https://docs.minestorecms.com/features/fraud/chargebacks.md): Learn how to manage chargebacks and increase your chances of winning disputes.
- [IP Checking](https://docs.minestorecms.com/features/fraud/ip-checking.md): Learn how to enable the IP Checking module to prevent fraud by checking the IP address of the buyer.
- [Spending Limit](https://docs.minestorecms.com/features/fraud/spending-limit.md): Set up spending limits for your customers to prevent fraud for anomalous big transactions.
- [Global Commands](https://docs.minestorecms.com/features/global-commands.md): Global Commands is the way how you can run same command everytime when purchase is made.
- [In-Game Auth Verification](https://docs.minestorecms.com/features/in-game-auth.md): You can enable the "In-Game Auth Verification" feature to verify the player's identity before logging in to the webstore.
- [Links](https://docs.minestorecms.com/features/links.md): You can easily create links to external websites or internal pages. This feature is useful for directing users to specific pages or resources.
- [Migration Tools](https://docs.minestorecms.com/features/migration-tools.md): Easily migrate from other platforms to MineStoreCMS with the new migration tools. This feature allows you to import your packages, categories, and packages.
- [Multiple Languages](https://docs.minestorecms.com/features/multiple-languages.md): You can add multiple languages to your webstore to reach a wider audience.
- [Package's Commands](https://docs.minestorecms.com/features/packages/commands.md): This article explains how to add commands to the package that will be executed when the package is purchased or any other event happened.
- [Discord Roles](https://docs.minestorecms.com/features/packages/discord-role.md): Learn how to attach Discord roles to packages.
- [Giftcard Package](https://docs.minestorecms.com/features/packages/giftcard-package.md): Gift card packages are a type of package that you can sell on your webstore. When a customer purchases a gift card, they receive a code that can be redeemed on the webstore. You can set the value of the gift card and the duration of the code.
- [Hybrid Package](https://docs.minestorecms.com/features/packages/hybrid-package.md): Hybrid Packages are a combination of Gift card and Minecraft Commands packages. Learn how to create a Hybrid Package in the Admin Panel.
- [Packages](https://docs.minestorecms.com/features/packages/packages.md): Packages are the products that you can sell on your webstore. They can be digital products like ranks, items, or permissions. You can also sell gift cards at your webstore. To have a better understanding of packages, you can refer to the documentation below.
- [Pay What You Want](https://docs.minestorecms.com/features/packages/pay-what-you-want.md): You can let customers pay for packages using the "Pay What You Want" feature. You can set the minimum price of the package and let customers pay more than the minimum price.
- [Allow to Select Server](https://docs.minestorecms.com/features/packages/select-server.md): This article will guide you on how to allow customers to select the server when purchasing a package.
- [Subscription Package](https://docs.minestorecms.com/features/packages/subscription-package.md): You can also make a subscription package that allows customers to pay for the package periodically. You can set the period of charging the customer and the duration of the package.
- [Virtual Currency](https://docs.minestorecms.com/features/packages/virtual-currency-package.md): You can let customers pay for packages using virtual currency. You can set the price of the package in virtual currency and specify the server to charge the virtual currency.
- [Patrons](https://docs.minestorecms.com/features/patrons.md): Patrons Module allows you to make a page for your patrons to display their names and avatars.
- [CashFree (India)](https://docs.minestorecms.com/features/payment-gateways/cashfree.md): Accept payments in India with CashFree. This payment method is perfect for Indian countries.
- [Coinbase](https://docs.minestorecms.com/features/payment-gateways/coinbase.md): Accept cryptocurrency payments with Coinbase Commerce.
- [CoinPayments](https://docs.minestorecms.com/features/payment-gateways/coinpayments.md): Accept cryptocurrency payments with CoinPayments.
- [Cordarium](https://docs.minestorecms.com/features/payment-gateways/cordarium.md): Cordarium is a business-free payment gateway that allows you to accept crypto payments in the easiest way possible.
- [Enot.io](https://docs.minestorecms.com/features/payment-gateways/enot.md): Accept payments in Russia and CIS countries with Enot.io. This payment method is perfect for Russian and CIS countries.
- [Free-Kassa](https://docs.minestorecms.com/features/payment-gateways/freekassa.md): Accept payments in Russia and CIS countries with Free-Kassa. This payment method is perfect for Russian and CIS countries.
- [GoPay](https://docs.minestorecms.com/features/payment-gateways/gopay.md): Accept payments across the Europe with GoPay. This payment method is perfect for Czech Republic countries.
- [HotPay (Poland)](https://docs.minestorecms.com/features/payment-gateways/hotpay.md): Accept payments in Poland with HotPay.
- [Interkassa](https://docs.minestorecms.com/features/payment-gateways/interkassa.md): Accept payments in Ukraine and CIS countries with Interkassa. This payment method is perfect for Ukrainian and CIS countries.
- [MercadoPago](https://docs.minestorecms.com/features/payment-gateways/mercadopago.md): Accept payments all across Latin America and South America with MercadoPago. This payment method is perfect for Latin American and South American countries.
- [Midtrans (Indonesia)](https://docs.minestorecms.com/features/payment-gateways/midtrans.md): Accept payments in Indonesia with Midtrans.
- [Mollie](https://docs.minestorecms.com/features/payment-gateways/mollie.md): Accept payments all across Europe with Mollie. This payment method is perfect for European countries.
- [PayPal IPN](https://docs.minestorecms.com/features/payment-gateways/paypal-ipn.md): You can configure the PayPal IPN settings to receive instant payment notifications for successful transactions.
- [PayPal Legacy](https://docs.minestorecms.com/features/payment-gateways/paypal-legacy.md): We do not recommend using this payment gateway. Please use the PayPal IPN payment gateway for better security and reliability.
- [PayTM (India)](https://docs.minestorecms.com/features/payment-gateways/paytm.md): Accept payments in India with PayTM. This payment method is perfect for Indian countries.
- [PayTR (Turkey)](https://docs.minestorecms.com/features/payment-gateways/paytr.md): Accept payments in Turkey with PayTR. This payment method is perfect for Turkey
- [PayU (Europe)](https://docs.minestorecms.com/features/payment-gateways/payu-europe.md): Accept payments across the Europe with PayU. This payment method is perfect for European countries.
- [PayU (India)](https://docs.minestorecms.com/features/payment-gateways/payu-india.md): Accept payments in India with PayU. This payment method is perfect for Indian countries.
- [Qiwi](https://docs.minestorecms.com/features/payment-gateways/qiwi.md): Accept payments in Russia and CIS countries with Qiwi. This payment method is perfect for Russian and CIS countries.
- [Razorpay (India)](https://docs.minestorecms.com/features/payment-gateways/razorpay.md): Accept payments in India with Razorpay. This payment method is perfect for Indian countries.
- [Skrill (Paysafecard)](https://docs.minestorecms.com/features/payment-gateways/skrill.md): Accept payments with Skrill Quick Checkout. This payment gateway also supports Paysafecard payment method.
- [Stripe](https://docs.minestorecms.com/features/payment-gateways/stripe.md): Stripe is a popular payment gateway that allows you to accept credit card payments on your webstore.
- [Terminal3 (Paymentwall)](https://docs.minestorecms.com/features/payment-gateways/terminal3.md): Accept multiple worldwide and local payment methods with Terminal3. This payment method is perfect for Asian countries.
- [Unitpay](https://docs.minestorecms.com/features/payment-gateways/unitpay.md): Accept payments in Russia and CIS countries with Unitpay. This payment method is perfect for Russian and CIS countries.
- [PayNow FAQ](https://docs.minestorecms.com/features/paynow/faq.md): Frequently asked questions about PayNow Checkout integration with MineStoreCMS.
- [Onboarding Guide](https://docs.minestorecms.com/features/paynow/onboarding.md): Learn how to integrate PayNow Checkout that provides a seamless payment experience for your customers and chargeback protection for your business.
- [Technical Issues](https://docs.minestorecms.com/features/paynow/technical.md): Frequently asked questions about PayNow Checkout & MineStoreCMS technical aspect integration.
- [User Profiles](https://docs.minestorecms.com/features/profiles.md): You can enable user profiles to display information about clients on your webstore. Profiles will show the users avatar, username, amount spent, recent purchases, and more.
- [Promoted Packages](https://docs.minestorecms.com/features/promoted-packages.md): You can choose packages to promote during the checkout process with special discounts to increase sales and revenue.
- [Player Referrals](https://docs.minestorecms.com/features/referral-system.md): Track and manage player referrals to your webstore.
- [Currency Management](https://docs.minestorecms.com/features/settings/currency-management.md): Manage the primary and additional currencies for your webstore to make your customers experience more convenient.
- [Discord Settings](https://docs.minestorecms.com/features/settings/discord-settings.md): Manage your Discord settings to integrate your webstore with Discord.
- [Maintenance Mode](https://docs.minestorecms.com/features/settings/maintenance-mode.md): Prevent access to view your webstore packages and categories while you perform maintenance tasks.
- [General Settings](https://docs.minestorecms.com/features/settings/settings.md): Configure your webstore settings, including the store name, logo, and favicon.
- [Email Settings](https://docs.minestorecms.com/features/settings/smtp-settings.md): Configure your SMTP settings to send emails to your customers about purchases or gift cards.
- [Staff Page](https://docs.minestorecms.com/features/staff-page.md): You can make a public staff page to display information about your staff team members on your webstore.
- [Taxes](https://docs.minestorecms.com/features/taxes.md): Create and collect taxes from your customers based on their location.
- [Teams](https://docs.minestorecms.com/features/teams.md): Create and manage your team members and assign them to specific tasks.
- [Edit Theme](https://docs.minestorecms.com/features/themes/editing-theme.md): You can edit your theme settings to customize the appearance of your webstore.
- [File Manager](https://docs.minestorecms.com/features/themes/file-manager.md): You can easily edit the theme files and upload new files using the File Manager.
- [Third-Party Templates](https://docs.minestorecms.com/features/themes/install-theme.md): You can install third-party templates to customize the appearance of your webstore after purchasing them from the marketplace.
- [Recolor Theme](https://docs.minestorecms.com/features/themes/recolor-theme.md): You can recolor your default theme to match your webstore branding and style in seconds.
- [Collecting Data](https://docs.minestorecms.com/features/transactions/collecting-data.md): Learn how to enable the Collecting Data module to collect additional information during checkout.
- [Commands History](https://docs.minestorecms.com/features/transactions/commands-history.md): Commands History displays information and status of commands attached to the transaction.
- [Manual Payments](https://docs.minestorecms.com/features/transactions/manual-payment.md): Create Manual Payments for your customers to pay for their orders.
- [Overview](https://docs.minestorecms.com/features/transactions/overview.md): Learn about the key features of the Transactions module.
- [Variables](https://docs.minestorecms.com/features/variables.md): Variables are used to attach dynamic data to your packages. You can allow your customers to customize their packages by setting up variables like player name, color, or size.
- [Virtual Currency](https://docs.minestorecms.com/features/virtual-currency.md): You can let your customers purchase items using virtual currency that they earned on your Minecraft server.
- [API Reference](https://docs.minestorecms.com/frontend/api-reference.md): Learn more about MineStoreCMS REST API Endpoints and how to use them.
- [Default Template](https://docs.minestorecms.com/frontend/default-template.md): Learn more about MineStoreCMS Default Template.
- [Overview](https://docs.minestorecms.com/frontend/overview.md): Learn more about MineStoreCMS Frontend Application.
- [Webstore Setup](https://docs.minestorecms.com/installation/configuration.md): Configure your webstore by following the steps in the documentation after installation.
- [Pointing Domain to VPS](https://docs.minestorecms.com/installation/configuring-dns.md): After you purchased a VPS, you need to configure the DNS settings to point your domain to the VPS IP address.
- [Installation](https://docs.minestorecms.com/installation/installation.md): MineStoreCMS provides an easy-to-use installer that allows you to install webstore on your server with a few simple commands.
- [Installation Issues](https://docs.minestorecms.com/installation/installation-issues.md): Check most common installation issues and how to resolve them.
- [Adding Minecraft Server](https://docs.minestorecms.com/installation/minecraft-server.md): Learn how to connect your Minecraft servers to MineStoreCMS.
- [Requirements](https://docs.minestorecms.com/installation/requirements.md): Before you start installing MineStoreCMS, make sure your Virtual Server (VPS) meets the following requirements.
- [Introduction](https://docs.minestorecms.com/introduction.md): Welcome to MineStoreCMS Documentation. Here you will find all the information you need to get started with MineStoreCMS starting from installation to customization.
- [Overview](https://docs.minestorecms.com/plugin/overview.md): Learn more about the Official MineStoreCMS Minecraft Plugin.
- [Authorization](https://docs.minestorecms.com/rest-api/endpoint/auth/username.md): Validate the provided username and return an authentication token if valid.
- [Apply Coupon & Giftcard](https://docs.minestorecms.com/rest-api/endpoint/cart/apply-discount.md): Validates and applies a coupon or gift card to the user's cart if eligible. Provides appropriate messages based on the coupon or gift card status.
- [Coupon Data](https://docs.minestorecms.com/rest-api/endpoint/cart/coupon/get.md): Returns details about the coupon currently applied to the user's cart, including type and discount amount or percentage.
- [Remove Coupon](https://docs.minestorecms.com/rest-api/endpoint/cart/coupon/remove.md): Removes the coupon from the user's cart and updates the cart items' prices accordingly.
- [Cart Data](https://docs.minestorecms.com/rest-api/endpoint/cart/get.md): Fetches the user's cart and items, including any associated promotions, coupons, gifts, and referral codes.
- [Promoted Packages](https://docs.minestorecms.com/rest-api/endpoint/cart/get-promoted-packages.md): Fetches a list of promoted items available in the cart along with their details such as price, availability, and quantity limits.
- [Selecting Servers List](https://docs.minestorecms.com/rest-api/endpoint/cart/get-select-servers.md): Fetches the list of selectable servers associated with items in the user's cart. Only items that allow server selection and are of type 'CMD_SERVER' are included.
- [Gift Card Balance](https://docs.minestorecms.com/rest-api/endpoint/cart/giftcard/get.md): Retrieves details of a gift card based on the gift card name provided. The response includes the starting balance, ending balance, and currency.  Returns an error message if the gift card is not found or has an empty balance.
- [Remove Giftcard](https://docs.minestorecms.com/rest-api/endpoint/cart/giftcard/remove.md): Removes the gift card from the user's cart and updates the gift card's balance accordingly.
- [Add Package](https://docs.minestorecms.com/rest-api/endpoint/cart/packages/add.md): Adds an item to the user's cart with optional promotion and payment type.
- [Change Price](https://docs.minestorecms.com/rest-api/endpoint/cart/packages/change-price.md): Allows updating the custom price for a specific item in the user's cart. The item must allow custom pricing, and the new price must not be less than the item's initial price.
- [Update Quantity](https://docs.minestorecms.com/rest-api/endpoint/cart/packages/reload.md): Updates the quantity of a specific item in the user's cart based on the item ID and provided count.
- [Remove Package](https://docs.minestorecms.com/rest-api/endpoint/cart/packages/remove.md): Removes an item from the user's cart based on the item ID.
- [Set Selected Server](https://docs.minestorecms.com/rest-api/endpoint/cart/packages/set-selected-server.md): Associates a selected server with a specific item in the user's cart. Ensures the selected server is valid for the item.
- [Set Variable](https://docs.minestorecms.com/rest-api/endpoint/cart/packages/set-variable.md): Updates the variable value for a specific item in the user's cart. It handles variable pricing based on item configuration and user selection.
- [Remove Referral](https://docs.minestorecms.com/rest-api/endpoint/cart/remove-referral.md): Removes any existing referral code from the user's cart. If no referral code is set, an appropriate message is returned.
- [Set Referral](https://docs.minestorecms.com/rest-api/endpoint/cart/set-referral.md): Applies a referral code to the user's cart if the referral code exists and is valid.
- [Categories List](https://docs.minestorecms.com/rest-api/endpoint/categories/get.md): Retrieves a hierarchical list of categories along with their subcategories.  The list is filtered to include only categories that are not deleted and are enabled. Each category includes its image URL, description, and URL, as well as a nested list of its active subcategories.
- [Get Discord OAuth URL](https://docs.minestorecms.com/rest-api/endpoint/discord-oauth/auth-url.md): Generates a Discord OAuth URL for user authentication. Requires Discord integration to be enabled and configured. You should setCookie for the discord_username, discord_id, discord_linked after successful auth callback (example available in our default template).
- [Check Authorization](https://docs.minestorecms.com/rest-api/endpoint/game_auth/check_auth.md)
- [Initiate Authorization](https://docs.minestorecms.com/rest-api/endpoint/game_auth/init_auth.md)
- [Announcements](https://docs.minestorecms.com/rest-api/endpoint/get-announcement.md): Fetch the latest announcement that is marked as an index announcement.
- [Custom Page](https://docs.minestorecms.com/rest-api/endpoint/get-pages.md): Fetch a page using the provided URL. Returns the page data if found.
- [Patrons Page](https://docs.minestorecms.com/rest-api/endpoint/get-patrons.md): Retrieves the list of patrons based on their contributions.
- [Webstore Settings](https://docs.minestorecms.com/rest-api/endpoint/get-settings.md): Fetch the current configuration settings of the website, including header, footer, recent donators, top player, donation goals, and more.
- [Staff Page](https://docs.minestorecms.com/rest-api/endpoint/get-staff.md): Retrieve staff information grouped by player group for staff page.
- [Category Packages](https://docs.minestorecms.com/rest-api/endpoint/packages/get.md): This endpoint retrieves details of a specific category, including its items and subcategories. It also handles limits, discounts, and custom price options for the items.
- [Featured Deals](https://docs.minestorecms.com/rest-api/endpoint/packages/get-featured-deals.md): Returns a list of featured deals, with item details, prices, discounts, and availability. The result depends on the user's authorization status. - If the user is not logged in, the response will include featured items without user-specific limits. - If the user is logged in, the response will includ…
- [Get Item (Guest)](https://docs.minestorecms.com/rest-api/endpoint/packages/get-guest-items.md): Fetch details of a specific item for guests, including price, discount, availability, and limits.
- [Get Item (Authorized)](https://docs.minestorecms.com/rest-api/endpoint/packages/get-items.md): Get detailed information about a specific item, including price adjustments, limits, and promotional prices.
- [Check Status](https://docs.minestorecms.com/rest-api/endpoint/payments/checkStatus.md): Retrieves the current status of a payment. Rate limited to 18 requests per minute per IP address.
- [Create Payment](https://docs.minestorecms.com/rest-api/endpoint/payments/create.md): Handles the payment creation process, including validation, checking for sales, handling virtual currency, and processing payments through various methods.
- [Available Methods](https://docs.minestorecms.com/rest-api/endpoint/payments/get.md): Fetches a list of payment methods available based on the cart's content and subscription status.
- [Profile Page](https://docs.minestorecms.com/rest-api/endpoint/profile/profile.md): Retrieve detailed profile information for a specific user by username.
- [Check Accessibility](https://docs.minestorecms.com/rest-api/endpoint/user/check-accessibility.md): Checks if the site is under maintenance, verifies if the user's IP is allowed, and checks if the country of the user's IP is banned. Also tracks visits to the site.
- [Get User](https://docs.minestorecms.com/rest-api/endpoint/user/get.md): Get user details including virtual currency balance if applicable.
- [Introduction](https://docs.minestorecms.com/rest-api/introduction.md): Learn more about MineStoreCMS REST API Endpoints and how to use them.

## OpenAPI Specs

- [rest-api](https://docs.minestorecms.com/api-reference/rest-api.json)

## Optional

- [Official Website](https://minestorecms.com/)
- [Legacy Docs (2.x)](https://legacy-docs.minestorecms.com/)