# Table of Contents - [Welcome to OxaPay | OxaPay Docs](#welcome-to-oxapay-oxapay-docs) - [Payment Link | OxaPay Docs](#payment-link-oxapay-docs) - [Integrations | OxaPay Docs](#integrations-oxapay-docs) - [Payout Service | OxaPay Docs](#payout-service-oxapay-docs) - [Swap Service | OxaPay Docs](#swap-service-oxapay-docs) - [Merchant Service | OxaPay Docs](#merchant-service-oxapay-docs) - [Donation Service | OxaPay Docs](#donation-service-oxapay-docs) - [Plugins | OxaPay Docs](#plugins-oxapay-docs) - [Clientexec | OxaPay Docs](#clientexec-oxapay-docs) - [PrestaShop | OxaPay Docs](#prestashop-oxapay-docs) - [WISECP | OxaPay Docs](#wisecp-oxapay-docs) - [Blesta | OxaPay Docs](#blesta-oxapay-docs) - [Revoking Static Address | OxaPay Docs](#revoking-static-address-oxapay-docs) - [OpenCart | OxaPay Docs](#opencart-oxapay-docs) - [VirtueMart | OxaPay Docs](#virtuemart-oxapay-docs) - [Payout Status Table | OxaPay Docs](#payout-status-table-oxapay-docs) - [Generate Static Address | OxaPay Docs](#generate-static-address-oxapay-docs) - [WHMCS | OxaPay Docs](#whmcs-oxapay-docs) - [Static Address List | OxaPay Docs](#static-address-list-oxapay-docs) - [WooCommerce | OxaPay Docs](#woocommerce-oxapay-docs) - [Payout Information | OxaPay Docs](#payout-information-oxapay-docs) - [Integrations | Legacy | OxaPay Docs](#integrations-legacy-oxapay-docs) - [Getting Started | Legacy | OxaPay Docs](#getting-started-legacy-oxapay-docs) - [Generate Payout | OxaPay Docs](#generate-payout-oxapay-docs) - [Introduction | Legacy | OxaPay Docs](#introduction-legacy-oxapay-docs) - [Generate White Label | OxaPay Docs](#generate-white-label-oxapay-docs) - [Error | OxaPay Docs](#error-oxapay-docs) - [Payout History | OxaPay Docs](#payout-history-oxapay-docs) - [Swap Rate | OxaPay Docs](#swap-rate-oxapay-docs) - [Swap Request | OxaPay Docs](#swap-request-oxapay-docs) - [Swap Pairs | OxaPay Docs](#swap-pairs-oxapay-docs) - [WordPress | OxaPay Docs](#wordpress-oxapay-docs) - [Gravity Forms | OxaPay Docs](#gravity-forms-oxapay-docs) - [Easy Digital Downloads | OxaPay Docs](#easy-digital-downloads-oxapay-docs) - [Generate Invoice | OxaPay Docs](#generate-invoice-oxapay-docs) - [Payment Information | OxaPay Docs](#payment-information-oxapay-docs) - [Accepted Currencies | OxaPay Docs](#accepted-currencies-oxapay-docs) - [Swap History | OxaPay Docs](#swap-history-oxapay-docs) - [Common | OxaPay Docs](#common-oxapay-docs) - [Restrict Content Pro | OxaPay Docs](#restrict-content-pro-oxapay-docs) - [Swap | OxaPay Docs](#swap-oxapay-docs) - [System Status | OxaPay Docs](#system-status-oxapay-docs) - [Payout | OxaPay Docs](#payout-oxapay-docs) - [Supported Networks | OxaPay Docs](#supported-networks-oxapay-docs) - [Payment Status Table | OxaPay Docs](#payment-status-table-oxapay-docs) - [Merchant and Payout Service with API | Legacy | OxaPay Docs](#merchant-and-payout-service-with-api-legacy-oxapay-docs) - [Webhook | OxaPay Docs](#webhook-oxapay-docs) - [Use Cases | OxaPay Docs](#use-cases-oxapay-docs) - [Account Balance | OxaPay Docs](#account-balance-oxapay-docs) - [Prices | OxaPay Docs](#prices-oxapay-docs) - [Swap Calculate | OxaPay Docs](#swap-calculate-oxapay-docs) - [Donations | Legacy | OxaPay Docs](#donations-legacy-oxapay-docs) - [Troubleshooting | Legacy | OxaPay Docs](#troubleshooting-legacy-oxapay-docs) - [Payment | OxaPay Docs](#payment-oxapay-docs) - [Supported Currencies | OxaPay Docs](#supported-currencies-oxapay-docs) - [Paid Memberships Pro | OxaPay Docs](#paid-memberships-pro-oxapay-docs) - [Supported Fiat Currencies | OxaPay Docs](#supported-fiat-currencies-oxapay-docs) - [Payment History | OxaPay Docs](#payment-history-oxapay-docs) - [Payment Links | Legacy | OxaPay Docs](#payment-links-legacy-oxapay-docs) - [Merchant API | Legacy | OxaPay Docs](#merchant-api-legacy-oxapay-docs) - [Payout API | Legacy | OxaPay Docs](#payout-api-legacy-oxapay-docs) - [Use Cases | Legacy | OxaPay Docs](#use-cases-legacy-oxapay-docs) - [Blesta | Legacy | OxaPay Docs](#blesta-legacy-oxapay-docs) - [WooCommerce | Legacy | OxaPay Docs](#woocommerce-legacy-oxapay-docs) - [VirtueMart | Legacy | OxaPay Docs](#virtuemart-legacy-oxapay-docs) - [OpenCart | Legacy | OxaPay Docs](#opencart-legacy-oxapay-docs) - [Easy Digital Downloads | Legacy | OxaPay Docs](#easy-digital-downloads-legacy-oxapay-docs) - [Paid Memberships Pro | Legacy | OxaPay Docs](#paid-memberships-pro-legacy-oxapay-docs) - [Gravity Forms | Legacy | OxaPay Docs](#gravity-forms-legacy-oxapay-docs) - [PrestaShop | Legacy | OxaPay Docs](#prestashop-legacy-oxapay-docs) - [WHMCS | Legacy | OxaPay Docs](#whmcs-legacy-oxapay-docs) - [WISECP | Legacy | OxaPay Docs](#wisecp-legacy-oxapay-docs) - [Clientexec | Legacy | OxaPay Docs](#clientexec-legacy-oxapay-docs) - [Restrict Content Pro | Legacy | OxaPay Docs](#restrict-content-pro-legacy-oxapay-docs) - [API Reference | Legacy | OxaPay Docs](#api-reference-legacy-oxapay-docs) - [Payout Information | Legacy | OxaPay Docs](#payout-information-legacy-oxapay-docs) - [Price | Legacy | OxaPay Docs](#price-legacy-oxapay-docs) - [Static Wallets List | Legacy | OxaPay Docs](#static-wallets-list-legacy-oxapay-docs) - [Payment Information | Legacy | OxaPay Docs](#payment-information-legacy-oxapay-docs) - [Plugins | Legacy | OxaPay Docs](#plugins-legacy-oxapay-docs) - [System Status | Legacy | OxaPay Docs](#system-status-legacy-oxapay-docs) - [Webhook | Legacy | OxaPay Docs](#webhook-legacy-oxapay-docs) - [Revoking Static Wallet | Legacy | OxaPay Docs](#revoking-static-wallet-legacy-oxapay-docs) - [Creating Static Wallet | Legacy | OxaPay Docs](#creating-static-wallet-legacy-oxapay-docs) - [Supported Fiat Currencies | Legacy | OxaPay Docs](#supported-fiat-currencies-legacy-oxapay-docs) - [Accepted Coins | Legacy | OxaPay Docs](#accepted-coins-legacy-oxapay-docs) - [Payout status table | Legacy | OxaPay Docs](#payout-status-table-legacy-oxapay-docs) - [Merchant status table | Legacy | OxaPay Docs](#merchant-status-table-legacy-oxapay-docs) - [Exchange Calculate | Legacy | OxaPay Docs](#exchange-calculate-legacy-oxapay-docs) - [Exchange Request | Legacy | OxaPay Docs](#exchange-request-legacy-oxapay-docs) - [Exchange Pairs | Legacy | OxaPay Docs](#exchange-pairs-legacy-oxapay-docs) - [Exchange Rate | Legacy | OxaPay Docs](#exchange-rate-legacy-oxapay-docs) - [Account Balance | Legacy | OxaPay Docs](#account-balance-legacy-oxapay-docs) - [Creating an Invoice | Legacy | OxaPay Docs](#creating-an-invoice-legacy-oxapay-docs) - [Supported Networks | Legacy | OxaPay Docs](#supported-networks-legacy-oxapay-docs) - [Payout History | Legacy | OxaPay Docs](#payout-history-legacy-oxapay-docs) - [Creating Payout | Legacy | OxaPay Docs](#creating-payout-legacy-oxapay-docs) - [Result code table | Legacy | OxaPay Docs](#result-code-table-legacy-oxapay-docs) - [Exchange History | Legacy | OxaPay Docs](#exchange-history-legacy-oxapay-docs) - [Payment History | Legacy | OxaPay Docs](#payment-history-legacy-oxapay-docs) - [Creating White-Label Payment | Legacy | OxaPay Docs](#creating-white-label-payment-legacy-oxapay-docs) - [Supported Currencies | Legacy | OxaPay Docs](#supported-currencies-legacy-oxapay-docs) - [Email Protection | Cloudflare](#email-protection-cloudflare) - [Swap Request2 | OxaPay Docs](#swap-request2-oxapay-docs) - [Generate Invoice2 | OxaPay Docs](#generate-invoice2-oxapay-docs) - [Generate Payout2 | OxaPay Docs](#generate-payout2-oxapay-docs) - [Generate Static Address2 | OxaPay Docs](#generate-static-address2-oxapay-docs) - [Generate White Label2 | OxaPay Docs](#generate-white-label2-oxapay-docs) - [Swap Pairs2 | OxaPay Docs](#swap-pairs2-oxapay-docs) - [Supported Currencies2 | OxaPay Docs](#supported-currencies2-oxapay-docs) - [Supported Fiat Currencies2 | OxaPay Docs](#supported-fiat-currencies2-oxapay-docs) - [Supported Networks2 | OxaPay Docs](#supported-networks2-oxapay-docs) --- # Welcome to OxaPay | OxaPay Docs Welcome to the OxaPay Crypto Payment Gateway documentation. OxaPay provides a robust and secure platform for processing cryptocurrency payments, allowing businesses and developers to easily integrate cryptocurrency payments into their applications and websites. ### [](https://docs.oxapay.com/#what-is-oxapay) What is OxaPay? OxaPay is a leading crypto payment gateway that enables businesses to accept payments in various cryptocurrencies securely. With OxaPay, merchants can expand their customer base by offering a convenient and efficient payment method that leverages the benefits of blockchain technology. ### [](https://docs.oxapay.com/#what-is-the-oxapay-api) What is the OxaPay API? The OxaPay API is a powerful RESTful interface that allows developers to interact with their OxaPay accounts programmatically. It provides a comprehensive set of endpoints and methods to facilitate the creation and management of invoices, retrieval of real-time rate information, and processing of payments. The OxaPay API enables seamless integration of crypto payments into applications, e-commerce platforms, and websites. ### [](https://docs.oxapay.com/#who-is-this-documentation-for) Who is this documentation for? This documentation is designed for developers, merchants, and businesses who wish to integrate OxaPay's crypto payment gateway into their applications or websites. It provides comprehensive information about the OxaPay API, including endpoint descriptions, request and response examples, and use cases. Whether you are a developer looking to implement crypto payments or a merchant seeking to enhance your payment options, this documentation will guide you through the process of integrating and leveraging OxaPay's powerful crypto payment solutions. Now that you have an overview of OxaPay and the purpose of this documentation, let's get started by creating an account and generating an API key. [NextIntegrations](https://docs.oxapay.com/welcome-to-oxapay/integrations) Last updated 2 months ago --- # Payment Link | OxaPay Docs Create crypto payment invoices effortlessly, without any coding knowledge and just a few clicks. Suitable for any type of business, these links are particularly advantageous for those without a website. Simply share the payment links with customers, get real-time updates on payment status, and receive payments efficiently. Streamline your transactions with reliability and ease. Customers can then make payments conveniently by clicking on the provided link. This integration simplifies the payment process and enhances the customer experience. #### [](https://docs.oxapay.com/welcome-to-oxapay/integrations/payment-link#follow-these-steps-to-generate-payment-link) Follow these steps to generate Payment Link: 1. Log in to your OxaPay account. 2. Navigate to the Payment Link page. 3. Fill in the form, then click on the "Generate Payment Link" button. #### [](https://docs.oxapay.com/welcome-to-oxapay/integrations/payment-link#watch-the-video-below-for-a-step-by-step-walkthrough-of-the-process) Watch the video below for a step-by-step walkthrough of the process: [![Logo](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2Fapp.oxapay.com%2Fmedia%2Flogos%2Ffavicon.ico&width=20&dpr=4&quality=100&sign=26d13ef6&sv=2)OxaPayapp.oxapay.com](https://app.oxapay.com/payment-link) [PreviousIntegrations](https://docs.oxapay.com/welcome-to-oxapay/integrations) [NextDonation Service](https://docs.oxapay.com/welcome-to-oxapay/integrations/donation-service) Last updated 2 months ago --- # Integrations | OxaPay Docs You need an OxaPay account for managing and saving your crypto assets. You can create your OxaPay account for free at this link (you just need an email, and you can sign up in less than one minute). [https://app.oxapay.com/signinapp.oxapay.com](https://app.oxapay.com/signin) [PreviousWelcome to OxaPay](https://docs.oxapay.com/) [NextPayment Link](https://docs.oxapay.com/welcome-to-oxapay/integrations/payment-link) Last updated 2 months ago --- # Payout Service | OxaPay Docs OxaPay's Payout service allows businesses to automate and streamline cryptocurrency payouts, enabling efficient mass transfers to multiple recipients. This tool boosts operational efficiency, cuts costs, and ensures accurate payments, making it perfect for webmasters and businesses with frequent payouts. Ideal for rapid, secure fund distribution. [![Logo](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2Fapp.oxapay.com%2Fmedia%2Flogos%2Ffavicon.ico&width=20&dpr=4&quality=100&sign=26d13ef6&sv=2)OxaPayapp.oxapay.com](https://app.oxapay.com/payout-service) [PreviousMerchant Service](https://docs.oxapay.com/welcome-to-oxapay/integrations/merchant-service) [NextSwap Service](https://docs.oxapay.com/welcome-to-oxapay/integrations/swap-service) Last updated 4 months ago --- # Swap Service | OxaPay Docs You can streamline your asset swaps using OxaPay's API. Our platform provides various tools and endpoints to help you identify swap pairs, assess swap rates, and calculate amounts. Begin by obtaining a General API key from your dashboard. With this key, access the swap request endpoint to execute swaps efficiently. This feature is designed to automate and enhance your trading processes, making it easier to manage digital assets directly through API integration. [![Logo](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2Fapp.oxapay.com%2Fmedia%2Flogos%2Ffavicon.ico&width=20&dpr=4&quality=100&sign=26d13ef6&sv=2)OxaPayapp.oxapay.com](https://app.oxapay.com/swap) [PreviousPayout Service](https://docs.oxapay.com/welcome-to-oxapay/integrations/payout-service) [NextPlugins](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins) Last updated 4 months ago --- # Merchant Service | OxaPay Docs OxaPay Merchant Services streamlines the integration of cryptocurrency payments for businesses. Offering tools like crypto invoicing, white label solutions, and static addresses, these services cater to a variety of merchant needs. Begin by obtaining a Merchant API key, which enables secure, efficient crypto transactions. [![Logo](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2Fapp.oxapay.com%2Fmedia%2Flogos%2Ffavicon.ico&width=20&dpr=4&quality=100&sign=26d13ef6&sv=2)OxaPayapp.oxapay.com](https://app.oxapay.com/merchant-service) [PreviousDonation Service](https://docs.oxapay.com/welcome-to-oxapay/integrations/donation-service) [NextPayout Service](https://docs.oxapay.com/welcome-to-oxapay/integrations/payout-service) Last updated 4 months ago --- # Donation Service | OxaPay Docs Create a donation link to let visitors easily support your cause with cryptocurrencies like Bitcoin and Ethereum. With OxaPay, you can start receiving crypto donations in minutes, no technical skills required. Simply add a donation button to your website and share it on social networks like X and Instagram to expand your reach. OxaPay ensures a safe and swift process, making it easy for anyone around the world to support your cause. #### [](https://docs.oxapay.com/welcome-to-oxapay/integrations/donation-service#follow-these-steps-to-generate-donation-link) Follow these steps to generate Donation Link: 1. Log in to your OxaPay account. 2. Navigate to the Donation Link page. 3. Fill in the form, then click on the "Generate Donation Link" button. #### [](https://docs.oxapay.com/welcome-to-oxapay/integrations/donation-service#watch-the-video-below-for-a-step-by-step-walkthrough-of-the-process) Watch the video below for a step-by-step walkthrough of the process: [![Logo](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2Fapp.oxapay.com%2Fmedia%2Flogos%2Ffavicon.ico&width=20&dpr=4&quality=100&sign=26d13ef6&sv=2)OxaPayapp.oxapay.com](https://app.oxapay.com/donation-service) [PreviousPayment Link](https://docs.oxapay.com/welcome-to-oxapay/integrations/payment-link) [NextMerchant Service](https://docs.oxapay.com/welcome-to-oxapay/integrations/merchant-service) Last updated 2 months ago --- # Plugins | OxaPay Docs OxaPay offers dedicated digital currency payment gateway plugins for various popular eCommerce platforms, making it easier for merchants to integrate cryptocurrency payments into their online stores. With these plugins, merchants can effortlessly add OxaPay's payment gateway functionality to their eCommerce platforms, allowing customers to choose cryptocurrencies as a payment option during the checkout process. The plugins are designed to ensure a smooth and secure payment experience for customers, while also providing merchants with real-time transaction updates and order management. [](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/wordpress/woocommerce) ![Cover](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2Fcontent.gitbook.com%2Fcontent%2F0cdQgWk1yvwE7MR49PSn%2Fblobs%2FQsNKsae6o1Zb054cs6q7%2Fwoocommerce.jpg&width=752&dpr=4&quality=100&sign=37036000&sv=2) **WooCommerce** WooCommerce is an open-source e-commerce plugin for WordPress. It is designed for small to large-sized online merchants using WordPress. [Download Plugin](https://downloads.wordpress.org/plugin/oxapay.1.0.0.zip) [](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/wisecp) ![Cover](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F2150865118-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F0cdQgWk1yvwE7MR49PSn%252Fuploads%252F3EGGZG6C5hf49v4Ygue0%252FGXNL_tNXUAASXW5%2520%281%29.png%3Falt%3Dmedia%26token%3D54238ede-5c38-4d2f-a8cd-6d3cbd4999da&width=752&dpr=4&quality=100&sign=9f6d1969&sv=2) **WISECP** WISECP is an all-in-one web hosting automation and management platform. It is designed for web hosting companies, domain registrars, and other online service providers [Download Plugin](https://github.com/OxaPay/oxapay-wisecp/archive/refs/tags/v1.0.0.zip) [](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/clientexec) ![Cover](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2Fcontent.gitbook.com%2Fcontent%2F0cdQgWk1yvwE7MR49PSn%2Fblobs%2F39wWoHwsBkPFAatPABHZ%2Fimages.png&width=752&dpr=4&quality=100&sign=67d0dc66&sv=2) **Clientexec** Clientexec is a comprehensive billing and client management platform designed specifically for web hosting businesses. [Download Plugin](https://github.com/OxaPay/oxapay-clientexec/archive/refs/tags/v1.0.0.zip) [](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/blesta) ![Cover](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2Fcontent.gitbook.com%2Fcontent%2F0cdQgWk1yvwE7MR49PSn%2Fblobs%2F6z6JJEZ0RI77w7sj3OsH%2Fblesta-installation-and-configuration-tutorial.png&width=752&dpr=4&quality=100&sign=d8bee493&sv=2) **Blesta** Blesta is an open-source billing and client management platform. It is designed for web hosting companies and other service providers. [Download Plugin](https://github.com/OxaPay/oxapay-blesta/archive/refs/tags/v1.0.0.zip) [](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/whmcs) ![Cover](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2Fcontent.gitbook.com%2Fcontent%2F0cdQgWk1yvwE7MR49PSn%2Fblobs%2FEW65cXFJ6c8wbArjLCh1%2Fwhmcs_ltd_cover.jpeg&width=752&dpr=4&quality=100&sign=a9ea6946&sv=2) **WHMCS** WHMCS is a powerful billing and automation platform tailored for web hosting companies, enabling them to manage billing and client accounts. [Download Plugin](https://github.com/OxaPay/oxapay-whmcs/releases/download/v1.0.0/oxapay_whmcs.zip) [](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/prestashop) ![Cover](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F2150865118-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F0cdQgWk1yvwE7MR49PSn%252Fuploads%252FaGvllwEHKiKs3JWUvkuX%252Fwpbakery-page-builder-for-prestashop.png%3Falt%3Dmedia%26token%3Dbd17a5b4-7584-449e-ad21-55849c9d1d2b&width=752&dpr=4&quality=100&sign=5670e1f9&sv=2) **PrestaShop** PrestaShop is an open-source e-commerce platform that allows users to create and manage online stores with customizable features. [Download Plugin](https://github.com/OxaPay/oxapay-prestashop/archive/refs/tags/v1.0.0.zip) [](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/wordpress/easy-digital-downloads) ![Cover](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2Fcontent.gitbook.com%2Fcontent%2F0cdQgWk1yvwE7MR49PSn%2Fblobs%2FYpmZiZz0Nw5vrb9AnS2c%2Feasy-digital-downloads-banner.svg&width=752&dpr=4&quality=100&sign=31919fc5&sv=2) **Easy Digital Downloads** Easy Digital Downloads (EDD) is a popular WordPress plugin designed for selling digital products like ebooks, software, and digital art. [Download Plugin](https://downloads.wordpress.org/plugin/oxapay-payment-gateway-for-easy-digital-downloads.1.0.0.zip) [](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/wordpress/paid-memberships-pro) ![Cover](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2Fcontent.gitbook.com%2Fcontent%2F0cdQgWk1yvwE7MR49PSn%2Fblobs%2F54vYH5Jxm6ErKkHIHMwE%2Fpaid-memberships-pro.svg&width=752&dpr=4&quality=100&sign=6528fe39&sv=2) **Paid Memberships Pro** Manage member subscriptions with recurring payments, user registration, custom profile fields, and robust member management. [Download Plugin](https://oxapay.com/plugins/oxapay_pmpro.zip) [](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/wordpress/gravity-forms) ![Cover](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F2150865118-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F0cdQgWk1yvwE7MR49PSn%252Fuploads%252FkOQIuQGy8i2jiBLb7FZs%252FScreenshot%25202025-04-13%2520092911.png%3Falt%3Dmedia%26token%3D07d8d791-0755-4751-9ce9-27c0a37b612d&width=752&dpr=4&quality=100&sign=e5be1084&sv=2) **Gravity Forms** Gravity Forms is a powerful WordPress plugin that allows users to create advanced and customizable forms with ease. [Download Plugin](https://downloads.wordpress.org/plugin/oxapay-crypto-payment-gateway-for-gravity-forms.1.0.0.zip) [](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/wordpress/restrict-content-pro) ![Cover](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F2150865118-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F0cdQgWk1yvwE7MR49PSn%252Fuploads%252FPNv4ItF0Ntyw79PTnN0V%252FScreenshot%25202025-04-13%2520092955.png%3Falt%3Dmedia%26token%3D8168f133-d008-47cf-a2bf-e6f8c957ed1a&width=752&dpr=4&quality=100&sign=c34465ac&sv=2) **Restrict Content Pro** Restrict Content Pro is a powerful WordPress membership plugin that allows you to monetize content access. [Download Plugin](https://github.com/OxaPay/oxapay-restrict-content/archive/refs/tags/v1.0.0.zip) [](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/virtuemart) ![Cover](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F2150865118-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F0cdQgWk1yvwE7MR49PSn%252Fuploads%252FQwaAH9k1iNY0KRE4bA3u%252Fmaxresdefault.jpg%3Falt%3Dmedia%26token%3Decb9852e-2589-4432-b419-cc55cb841407&width=752&dpr=4&quality=100&sign=cc803dfd&sv=2) VirtueMart VirtueMart is a Free open-source eCommerce extension for Joomla! CMS has been active in development since 2002. [Downlaod Plugin](https://github.com/OxaPay/oxapay-virtuemart/archive/refs/tags/v1.0.0.zip) [](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/opencart) ![Cover](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F2150865118-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F0cdQgWk1yvwE7MR49PSn%252Fuploads%252FkQ7S7vOxBghl6DyYUsIF%252Fopencart.jpg%3Falt%3Dmedia%26token%3De6fa2678-b35f-4773-8736-849a0d5672da&width=752&dpr=4&quality=100&sign=c73fb3aa&sv=2) **OpenCart** OpenCart is a free, open-source e-commerce platform designed for building and managing online stores. [Downlaod Plugin](https://github.com/OxaPay/oxapay-opencart/releases/download/v1.0.0/oxapay.ocmod.zip) [PreviousSwap Service](https://docs.oxapay.com/welcome-to-oxapay/integrations/swap-service) [NextWISECP](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/wisecp) Last updated 1 month ago --- # Clientexec | OxaPay Docs [](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/clientexec#what-is-clientexec) What is Clientexec? ------------------------------------------------------------------------------------------------------------------------- Clientexec is a comprehensive billing and client management platform designed specifically for web hosting businesses. It allows companies to automate and streamline various aspects of their operations, including invoicing, customer management, and support. [](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/clientexec#key-features-of-clientexec) Key Features of Clientexec: ----------------------------------------------------------------------------------------------------------------------------------------- 1. **Automated Billing**: Manages invoicing, recurring payments, and integrates with multiple payment gateways, streamlining financial transactions. 2. **Client Management**: Provides tools for customer support, including a ticketing system, and a customizable client portal where users can manage their accounts and services. 3. **Service Management**: Automates the provisioning of services such as hosting accounts and domain registrations. It also supports customizable order forms for different products. 4. **Customization and Extensibility**: Offers API access, plugin support, and custom fields to tailor the platform to specific business needs. 5. **Security**: Features robust user permissions and SSL support to ensure data security and controlled access. 6. **User Interface**: The platform is designed with a responsive, mobile-friendly interface for both admin and client areas, improving usability across devices. [](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/clientexec#oxapay-plugin-for-clientexec) OxaPay Plugin For Clientexec -------------------------------------------------------------------------------------------------------------------------------------------- Integrating OxaPay with Clientexec is a strategic move to expand your business and reach new milestones. The OxaPay plugin for Clientexec enables businesses to accept cryptocurrency as a full-fledged payment method, thereby broadening your customer base and enhancing payment convenience. By using Clientexec, you can automate various aspects of your business operations efficiently. Enabling the OxaPay plugin on the Clientexec platform increases operational effectiveness and boosts customer engagement by facilitating crypto transactions with minimal fees and in the shortest time possible. [](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/clientexec#how-to-set-up-oxapay-plugin-for-clientexec) How To Set Up OxaPay Plugin For Clientexec? ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- 1. To install the OxaPay plugin ([Click here to download it](https://github.com/OxaPay/oxapay-clientexec/archive/refs/tags/v1.0.0.zip) ) for Clientexec, move the plugin folder to the following path _“Clientexec → plugins → gateways ”._ 2. The next step is to navigate to the web interface on Clientexec. Hover over the "Settings" tab in the top menu. Then, under the "Plugins" section, click on "Payment Processors." ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2Fcontent.gitbook.com%2Fcontent%2F0cdQgWk1yvwE7MR49PSn%2Fblobs%2Fqf76g7soU07xIWFwzBRd%2FScreenshot%2520%281167%29.png&width=768&dpr=4&quality=100&sign=c01fb2e5&sv=2) 1. Now that you are on the “Payment Processors” page, type "OxaPay" in the dropdown menu. When "OxaPay" appears, click on it to proceed to the plugin settings page. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2Fcontent.gitbook.com%2Fcontent%2F0cdQgWk1yvwE7MR49PSn%2Fblobs%2FrBTuFqwpQPOE9O2nElwg%2FScreenshot%2520%281172%29.png&width=768&dpr=4&quality=100&sign=be52ae75&sv=2) 1. Now, enter your "OxaPay merchant API key" in the designated field (you can find it in your OxaPay panel. If you don’t have an API key, [click here](https://docs.oxapay.com/welcome-to-oxapay/integrations/merchant-service) to learn how to create one, or you can use the "sandbox" mode for testing). Complete the remaining configurations, and then click on "Update Settings". ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2Fcontent.gitbook.com%2Fcontent%2F0cdQgWk1yvwE7MR49PSn%2Fblobs%2FkR2zZ11OSswtasNZK1b9%2FScreenshot%2520%281170%29.png&width=768&dpr=4&quality=100&sign=2c580a8a&sv=2) #### [](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/clientexec#you-can-download-the-oxapay-plugin-for-clientexec-by-clicking-on-the-file-below) You can download the OxaPay plugin for Clientexec by clicking on the file below: 5KB [OxaPay\_clientexec.zip](https://2150865118-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0cdQgWk1yvwE7MR49PSn%2Fuploads%2FkGGTsfIcvAAYgVShO5Hc%2FOxaPay_clientexec.zip?alt=media&token=ddf12fda-15c0-4694-826e-cef08517c22d) archive Download[Open](https://2150865118-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0cdQgWk1yvwE7MR49PSn%2Fuploads%2FkGGTsfIcvAAYgVShO5Hc%2FOxaPay_clientexec.zip?alt=media&token=ddf12fda-15c0-4694-826e-cef08517c22d) We hope this article was helpful to you! The OxaPay plugin for Clientexec is a powerful and valuable tool to elevate your business to the next level. Last updated 1 month ago --- # PrestaShop | OxaPay Docs [](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/prestashop#what-is-prestashop) What is PrestaShop? ------------------------------------------------------------------------------------------------------------------------- PrestaShop is an open-source e-commerce platform used to create and manage online stores. It allows users to build a fully customizable online shop with features for inventory management, payment processing, and shipping. PrestaShop is popular for small to medium-sized businesses due to its flexibility and a large marketplace of add-ons and themes. [](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/prestashop#key-features-of-prestashop) Key Features of PrestaShop: ----------------------------------------------------------------------------------------------------------------------------------------- 1. **Customizable Storefront**: PrestaShop provides an extensive selection of themes and templates, enabling merchants to fully personalize the appearance of their online stores. From color schemes to layout designs, everything is customizable to create a unique brand experience. 2. **Product Management**: Managing your product catalog is made simple with robust tools that allow easy addition and organization of products. You can create detailed product listings with attributes such as size, color, and material, manage variations. 3. **Multi-Language Support**: PrestaShop is built to cater to global markets by offering support for multiple languages and currencies. This enables businesses to sell to international customers, improving accessibility and boosting sales. 4. **Payment Gateway Integration**: The platform integrates with a wide range of popular payment gateways, including OxaPay, PayPal, Stripe, and many others. This flexibility allows customers to choose their preferred payment method, improving conversion rates. 5. **Advanced Reporting & Analytics**: The platform includes powerful reporting and analytics tools that provide in-depth insights into your store’s performance. You can access detailed sales reports, track customer behavior, monitor key performance indicators (KPIs), and analyze customer data to make informed business decisions. [](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/prestashop#oxapay-plugin-for-prestashop) OxaPay Plugin For PrestaShop -------------------------------------------------------------------------------------------------------------------------------------------- Integrating OxaPay with PrestaShop is a powerful step to grow your business and reach new heights. The OxaPay plugin for PrestaShop allows merchants to seamlessly accept cryptocurrency payments, opening up new possibilities for expanding your customer base and offering greater payment flexibility. Enabling the OxaPay plugin on the PrestaShop platform improves operational efficiency and enhances customer experience by providing fast, low-fee crypto transactions as a fully integrated payment method. [](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/prestashop#how-to-set-up-oxapay-plugin-for-prestashop) How To Set Up OxaPay Plugin For PrestaShop? ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- 1. First, after logging into your PrestaShop admin panel, locate the "Modules" tab. Click on it, then select "Module Manager" from the dropdown menu. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2Fcontent.gitbook.com%2Fcontent%2F0cdQgWk1yvwE7MR49PSn%2Fblobs%2F863BLCgGttqwteuj3Xon%2FScreenshot%2520%281280%29.png&width=768&dpr=4&quality=100&sign=154b9ea2&sv=2) 1. Next, click on the "Upload a module" button and upload the OxaPay plugin file ([Click here to download it](https://github.com/OxaPay/oxapay-prestashop/archive/refs/tags/v1.0.0.zip) ). ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2Fcontent.gitbook.com%2Fcontent%2F0cdQgWk1yvwE7MR49PSn%2Fblobs%2FdwCBg4CkJy8lzYRPFn4W%2FScreenshot%2520%281279%29.png&width=768&dpr=4&quality=100&sign=54ce5aca&sv=2) 1. The module installation will begin automatically. Once you see the message "Module installed" and the "Configure" button appears, click it to proceed. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2Fcontent.gitbook.com%2Fcontent%2F0cdQgWk1yvwE7MR49PSn%2Fblobs%2FuwZElriZUtb12tCKiskq%2FScreenshot%2520%281281%29.png&width=768&dpr=4&quality=100&sign=72043357&sv=2) 1. Enter your OxaPay Merchant API key (You can find this key in your OxaPay dashboard. If you don't have an API key, [click here](https://docs.oxapay.com/welcome-to-oxapay/integrations/merchant-service) for instructions on how to create one). Complete any other field. You can use the "sandbox" mode for testing. Once all the details are filled in, click "Save" to finalize the setup. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2Fcontent.gitbook.com%2Fcontent%2F0cdQgWk1yvwE7MR49PSn%2Fblobs%2FsOLlKcCf7qwalJkHqnjf%2FScreenshot%2520%281284%29.png&width=768&dpr=4&quality=100&sign=8f99b97d&sv=2) #### [](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/prestashop#you-can-download-the-oxapay-plugin-for-prestashop-by-clicking-on-the-file-below) You can download the OxaPay plugin for PrestaShop by clicking on the file below: 53KB [OxaPay\_prestashop.zip](https://2150865118-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0cdQgWk1yvwE7MR49PSn%2Fuploads%2FJoGz94kL7boOx4O3BW9P%2FOxaPay_prestashop.zip?alt=media&token=6ed8c300-9168-41e9-8c65-fb48d2b726f9) archive Download[Open](https://2150865118-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0cdQgWk1yvwE7MR49PSn%2Fuploads%2FJoGz94kL7boOx4O3BW9P%2FOxaPay_prestashop.zip?alt=media&token=6ed8c300-9168-41e9-8c65-fb48d2b726f9) We hope you found this article helpful! The OxaPay plugin for PrestaShop is a powerful tool that can elevate your business to new heights. [PreviousBlesta](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/blesta) [NextWHMCS](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/whmcs) Last updated 1 month ago --- # WISECP | OxaPay Docs [](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/wisecp#what-is-wisecp) What is WISECP? ------------------------------------------------------------------------------------------------------------- WISECP is next generation hosting and digital solutions automation. It includes a client area, admin area and a website interface. It has been developed for companies operating in the field of information technologies. With WISECP, all invoicing transactions, accounting (cash, income, expense) records, client management, product management, support services and many other operations can be carried out easily. [](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/wisecp#key-features-of-wisecp) Key Features of WISECP: ----------------------------------------------------------------------------------------------------------------------------- 1. **Client Management**: WISECP allows you to easily manage your client information, issue invoices, and view payment history. 2. **Invoicing and Payments**: The platform enables automatic invoicing and payment management for clients, supporting various payment gateways. 3. **Service Automation**: WISECP can automate the provisioning of web hosting, domain registration, and other services to clients. It handles the necessary configurations and sends access information to clients automatically. 4. **Support and Ticketing**: WISECP includes a ticket management system that helps you respond to client requests and issues, ensuring more effective customer support. 5. **Client Portal**: Your clients can manage their services, pay invoices, and communicate with your support team through a web-based client portal. 6. **Reporting and Analytics**: WISECP provides various tools for generating reports on business performance, financial status, and client information, helping you make better decisions to improve your business. [](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/wisecp#oxapay-plugin-for-wisecp) OxaPay Plugin For WISECP -------------------------------------------------------------------------------------------------------------------------------- The integration of OxaPay with WISECP is a valuable opportunity to expand your business horizons and achieve new milestones. The OxaPay plugin for WISECP allows businesses to accept cryptocurrency as a complete payment method, thereby expanding the customer base and enhancing convenience. Using WISECP helps you automate your business operations in the most efficient way. By enabling the OxaPay plugin on the WISECP platform, you can increase effectiveness and customer engagement by facilitating all types of crypto transactions with minimal fees and in the shortest possible time. [](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/wisecp#how-to-set-up-oxapay-plugin-for-wisecp) How To Set Up OxaPay Plugin For WISECP? ------------------------------------------------------------------------------------------------------------------------------------------------------------- 1. To install the OxaPay plugin ([Click here to download it](https://github.com/OxaPay/oxapay-wisecp/archive/refs/tags/v1.0.0.zip) ) for WISECP, move the plugin folder to the following path _“WISECP → coremio → modules → payment”_. 2. Go to the WISECP admin panel and follow the certain path _“setting → billing → payment gateways”._ ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2Fcontent.gitbook.com%2Fcontent%2F0cdQgWk1yvwE7MR49PSn%2Fblobs%2Fz1NxzrK6FAt005zf7v8F%2FScreenshot%2520%281162%29.png&width=768&dpr=4&quality=100&sign=8ae98dec&sv=2) 1. Now, simply search for "OxaPay" in the "Enabled Module Selection" section and click on it. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2Fcontent.gitbook.com%2Fcontent%2F0cdQgWk1yvwE7MR49PSn%2Fblobs%2FqIQ8aGPyk93D68mq3HGp%2FScreenshot%2520%281201%29.png&width=768&dpr=4&quality=100&sign=655a6fea&sv=2) 1. Next, go to the "All Modules" section, type "OxaPay" in the search bar, and click on "OxaPay" in the search results. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2Fcontent.gitbook.com%2Fcontent%2F0cdQgWk1yvwE7MR49PSn%2Fblobs%2FbErqzbJgt4M9OqTMWhSI%2FScreenshot%2520%281164%29.png&width=768&dpr=4&quality=100&sign=57ce17bc&sv=2) 1. Now, enter your "OxaPay Merchant API Key" in the designated field (you can find it in your OxaPay panel. If you don’t have an API key, [click here](https://docs.oxapay.com/welcome-to-oxapay/integrations/merchant-service) to learn how to create one, or you can use the "sandbox" mode for testing). Complete the remaining configurations, and then click on "Save Settings". ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2Fcontent.gitbook.com%2Fcontent%2F0cdQgWk1yvwE7MR49PSn%2Fblobs%2FKE1nd1xj5VSjci7D76J1%2FScreenshot%2520%281165%29.png&width=768&dpr=4&quality=100&sign=d7083819&sv=2) #### [](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/wisecp#you-can-download-the-oxapay-plugin-for-wisecp-by-clicking-on-the-file-below) You can download the OxaPay plugin for WISECP by clicking on the file below: 17KB [OxaPay\_wisecp.zip](https://2150865118-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0cdQgWk1yvwE7MR49PSn%2Fuploads%2FcjrEyf6oCBpODprqNjl8%2FOxaPay_wisecp.zip?alt=media&token=745076ee-4d0e-404a-842a-0ce64fe35316) archive Download[Open](https://2150865118-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0cdQgWk1yvwE7MR49PSn%2Fuploads%2FcjrEyf6oCBpODprqNjl8%2FOxaPay_wisecp.zip?alt=media&token=745076ee-4d0e-404a-842a-0ce64fe35316) We hope this article was helpful to you! The WISECP plugin by OxaPay is a powerful and valuable tool to elevate your business to the next level. Last updated 1 month ago --- # Blesta | OxaPay Docs [](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/blesta#what-is-blesta) What is Blesta? ------------------------------------------------------------------------------------------------------------- Blesta is a comprehensive billing and client management platform designed primarily for web hosting companies and other service providers. It's a software solution that automates various aspects of a business, including billing, invoicing, client management, and support. [](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/blesta#key-features-of-blesta) Key Features of Blesta: ----------------------------------------------------------------------------------------------------------------------------- 1. **Billing Automation**: Automatically generates and sends invoices, handles both one-time and recurring payments, and supports various payment gateways. 2. **Client Management**: Offers a centralized client portal for managing services, viewing invoices, and making payments, with support for multiple currencies and languages. 3. **Service Provisioning**: Integrates with web hosting control panels and domain registrars to automate service management, supporting a wide range of digital services. 4. **Support System**: Includes a built-in ticketing system, enabling businesses to provide customer support directly through Blesta. 5. **Customizable and Extendable**: Features a modular design that allows for easy customization and the addition of new features through plugins and extensions. 6. **Security**: Offers robust security measures like two-factor authentication (2FA) and data encryption, with regular updates to ensure security. 7. **Reporting and Analytics**: Provides detailed reports on business metrics, with customizable dashboards for real-time monitoring. 8. **Multi-Company Support**: Allows management of multiple companies or brands from a single installation, each with distinct settings and services. [](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/blesta#oxapay-plugin-for-blesta) OxaPay Plugin For Blesta -------------------------------------------------------------------------------------------------------------------------------- Integrating OxaPay with Blesta is a strategic step toward expanding your business and reaching new milestones. The OxaPay plugin for Blesta allows businesses to accept cryptocurrency as a fully integrated payment method, thereby widening your customer base and enhancing payment convenience. By leveraging Blesta, you can efficiently automate various aspects of your business operations. Enabling the OxaPay plugin on the Blesta platform enhances operational efficiency and increases customer engagement by facilitating crypto transactions with minimal fees and rapid processing times. [](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/blesta#how-to-set-up-oxapay-plugin-for-blesta) How To Set Up OxaPay Plugin For Blesta? ------------------------------------------------------------------------------------------------------------------------------------------------------------- 1. To install the OxaPay plugin ([Click here to download it](https://github.com/OxaPay/oxapay-blesta/archive/refs/tags/v1.0.0.zip) ) for Blesta, move the plugin folder to the following path _“Blesta → components → gateways → nonmerchant”_. 2. Navigate to the settings section within Blesta. Click on the "Payment Gateway" option in the settings page. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2Fcontent.gitbook.com%2Fcontent%2F0cdQgWk1yvwE7MR49PSn%2Fblobs%2FbsUEuVERFt8P0QWtnPn5%2FScreenshot%2520%281175%29.png&width=768&dpr=4&quality=100&sign=55ece909&sv=2) 1. In the "Available" section, locate the "OxaPay Payment Gateway" under the Non-Merchant category, and click on the "Install" button. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2Fcontent.gitbook.com%2Fcontent%2F0cdQgWk1yvwE7MR49PSn%2Fblobs%2FMu6z9Hk8NBKIrw5coO2B%2FScreenshot%2520%281176%29-Recovered.png&width=768&dpr=4&quality=100&sign=e836e42b&sv=2) 1. Enter your OxaPay Merchant API key in the designated field. You can find this key in your OxaPay panel. If you don't have an API key, [click here](https://docs.oxapay.com/welcome-to-oxapay/integrations/merchant-service) to learn how to create one. Alternatively, you can use the "sandbox" mode for testing. After entering the Merchant API key, click on "Update Settings" to finalize the setup. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2Fcontent.gitbook.com%2Fcontent%2F0cdQgWk1yvwE7MR49PSn%2Fblobs%2FGiYleXTZdmFZVhJcQ4gb%2FScreenshot%2520%281180%29.png&width=768&dpr=4&quality=100&sign=e2dcd499&sv=2) #### [](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/blesta#you-can-download-the-oxapay-plugin-for-blesta-by-clicking-on-the-file-below) You can download the OxaPay plugin for Blesta by clicking on the file below: 24KB [OxaPay\_blesta.zip](https://2150865118-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0cdQgWk1yvwE7MR49PSn%2Fuploads%2FNqyxmxu3kyBfBz9dt6og%2FOxaPay_blesta.zip?alt=media&token=5fb69040-13a8-4154-bb17-c46d22c8e5a6) archive Download[Open](https://2150865118-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0cdQgWk1yvwE7MR49PSn%2Fuploads%2FNqyxmxu3kyBfBz9dt6og%2FOxaPay_blesta.zip?alt=media&token=5fb69040-13a8-4154-bb17-c46d22c8e5a6) We hope this article was helpful to you! The OxaPay plugin for Blesta is a powerful and valuable tool to elevate your business to the next level. Last updated 1 month ago --- # Revoking Static Address | OxaPay Docs You can revoke a static wallet by providing the merchant API key and the address associated with the static wallet. This action will disable the static wallet and prevent any further transactions from being credited to the specified address. To avoid reaching the limit on generating new static addresses, we recommend manually revoking addresses with no transactions. If you have too many static addresses without transactions, the system will prevent you from generating additional ones. Therefore, it's important to proactively revoke inactive addresses to ensure you can continue generating new ones. post https://api.oxapay.com/v1/payment/static-address/revoke Header parameters merchant\_api\_keystringRequired Your Merchant API Key for authentication and authorization. Content-TypestringRequiredDefault: `application/json` Body application/json application/json addressstringRequired The address of the static wallet you want to revoke. Responses 200 Successful operation application/json Responseobject Show properties 400 Bad request application/json post /payment/static-address/revoke Python PythoncURLPHPNode.js Copy import requests import json url = 'https://api.oxapay.com/v1/payment/static-address/revoke' headers = { 'merchant_api_key': 'YOUR_MERCHANT_API_KEY', 'Content-Type': 'application/json' } data = { "address": "WALLET_ADDRESS_TO_REVOKE" } response = requests.post(url, data=json.dumps(data), headers=headers) result = response.json() print(result) Test it 200 Successful operation Copy { "data": {}, "message": "Operation completed successfully!", "error": {}, "status": 200, "version": "1.0.0" } [PreviousGenerate Static Address](https://docs.oxapay.com/api-reference/payment/generate-static-address) [NextStatic Address List](https://docs.oxapay.com/api-reference/payment/static-address-list) Last updated 4 months ago --- # OpenCart | OxaPay Docs [](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/opencart#what-is-opencart) What is OpenCart? ------------------------------------------------------------------------------------------------------------------- OpenCart is a free, open-source e-commerce platform designed for building and managing online stores. It offers a user-friendly interface, a wide range of extensions, and supports multiple payment gateways, making it a popular choice for businesses looking to sell products online. [](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/opencart#key-features-of-opencart) Key features of OpenCart: ----------------------------------------------------------------------------------------------------------------------------------- 1. **Store Management**: OpenCart offers a comprehensive admin panel that allows businesses to efficiently manage their products, categories, and customer accounts. With multi-store functionality, users can control multiple shops from a single interface, streamlining operations. 2. **Payment Integration**: OpenCart supports various payment gateways such as OxaPay, PayPal, and others, making it easy for businesses to handle transactions. It also supports multiple currencies, ensuring smooth global payments and invoicing. 3. **Product and Inventory Management**: The platform provides tools for managing a wide range of product options, attributes, and stock levels. This helps businesses organize their product catalog and track inventory efficiently. 4. **Automation**: OpenCart offers automated features for order processing, shipping, and notifications. This helps reduce manual tasks, speeding up order fulfillment and enhancing the customer experience. 5. **Analytics and Reports**: Built-in reporting tools provide valuable insights into sales, customer activity, and product performance. These analytics help businesses make data-driven decisions and track overall store performance. 6. **Customer Management**: OpenCart includes customer account management, allowing store owners to track order history, handle communications, and manage customer reviews. Customers can also use a self-service portal to view orders and make changes to their accounts. [](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/opencart#oxapay-plugin-for-opencart) OxaPay Plugin For OpenCart -------------------------------------------------------------------------------------------------------------------------------------- Integrating OxaPay with OpenCart is a great way to take your online store to the next level. The OxaPay extension for OpenCart enables businesses to accept cryptocurrency as a native payment method, providing customers with more payment options and expanding your market reach. With the OxaPay integration, businesses can process transactions quickly and efficiently, with lower fees and faster settlement times compared to traditional fiat currencies. This makes it an attractive option for customers who prefer using cryptocurrencies for their purchases. Additionally, OxaPay offers robust security measures, ensuring that each transaction is secure and reliable, giving both merchants and customers peace of mind. [](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/opencart#how-to-set-up-oxapay-plugin-for-opencart) How To Set Up OxaPay Plugin For OpenCart? ------------------------------------------------------------------------------------------------------------------------------------------------------------------- 1. Ensure that you have OpenCart version 4.x installed on your website. Once logged into your dashboard, go to the left menu, find the "Extensions" tab, click on it, and select "Installer". 2. After that, upload the Oxapay plugin ([Click here to download it](https://github.com/OxaPay/oxapay-opencart/releases/download/v1.0.0/oxapay.ocmod.zip) ). Once you receive a successful upload message, go to the Oxapay bar in the action section and click on the "Install" button to complete the installation. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F2150865118-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F0cdQgWk1yvwE7MR49PSn%252Fuploads%252Fe129nm2uJIVnE1mKBy8S%252F1.png%3Falt%3Dmedia%26token%3Dc0159652-5e06-4a33-bc87-e3a5c02ec883&width=768&dpr=4&quality=100&sign=a9eea8b6&sv=2) 1. Now, first choose the "Payments" type from the list. Then, find the Oxapay bar and click on the "Install" button. After the installation is complete, click on the "Edit" button to configure the settings. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F2150865118-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F0cdQgWk1yvwE7MR49PSn%252Fuploads%252FZf1dh1xRZgBtzB6IQ3Gc%252F2.png%3Falt%3Dmedia%26token%3D0db74240-aa12-4d94-aef7-cb3673b79728&width=768&dpr=4&quality=100&sign=1bdab2c4&sv=2) 1. Now, enter your "OxaPay Merchant API Key" in the designated field (you can find it in your OxaPay panel. If you don’t have an API key, [click here](https://docs.oxapay.com/welcome-to-oxapay/integrations/merchant-service) to learn how to create one, or you can use the "sandbox" mode for testing). Complete the remaining configurations, and then click on the "Save" button. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F2150865118-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F0cdQgWk1yvwE7MR49PSn%252Fuploads%252FVyBeeV2PVqY6gYTOKnCu%252F3.png%3Falt%3Dmedia%26token%3D6a270c66-fa90-4ebb-8545-b570e59bba9b&width=768&dpr=4&quality=100&sign=d2257d10&sv=2) **You can download the OxaPay plugin for OpenCart by clicking on the file below:** 15KB [oxapay.ocmod.zip](https://2150865118-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0cdQgWk1yvwE7MR49PSn%2Fuploads%2F7QK5QCBzLiis9rVyIvvT%2Foxapay.ocmod.zip?alt=media&token=9816f2a5-ebeb-4c1e-bb18-7e9d3156dc61) archive Download[Open](https://2150865118-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0cdQgWk1yvwE7MR49PSn%2Fuploads%2F7QK5QCBzLiis9rVyIvvT%2Foxapay.ocmod.zip?alt=media&token=9816f2a5-ebeb-4c1e-bb18-7e9d3156dc61) We hope this article was helpful to you! The OxaPay plugin for OpenCart is a powerful and valuable tool to help take your business to the next level. [PreviousVirtueMart](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/virtuemart) [NextWordPress](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/wordpress) Last updated 1 month ago --- # VirtueMart | OxaPay Docs [](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/virtuemart#what-is-virtuemart) What is VirtueMart? ------------------------------------------------------------------------------------------------------------------------- **VirtueMart** is an **open-source eCommerce solution** designed to work with the **Joomla** content management system (CMS). It enables users to build and manage online stores with features that support product listings, customer management, orders, and payment processing. [](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/virtuemart#key-features-of-virtuemart) Key Features of VirtueMart: ----------------------------------------------------------------------------------------------------------------------------------------- 1. **Flexible Product Management:** VirtueMart enables easy management of products, categories, attributes, and variants, allowing administrators to efficiently organize and showcase their merchandise. 2. **Multi-Language Support:** With built-in multi-language support, VirtueMart caters to international markets, allowing users to create and manage multilingual online stores. 3. **Multiple Payment Gateways:** VirtueMart supports various payment gateways, including PayPal, Stripe, Authorize.Net, and more, offering flexibility in accepting payments securely. 4. **Shipping and Tax Calculation:** The platform provides tools for calculating shipping costs and taxes based on different parameters such as weight, destination, and tax rates, streamlining the checkout process. 5. **Inventory Management:** VirtueMart offers inventory management features, including stock tracking, low-stock notifications, and backorder management, helping users keep track of their inventory levels. 6. **SEO-Friendly:** The platform is designed with search engine optimization (SEO) in mind, providing features such as customizable URLs, meta tags, and sitemaps to improve online visibility and rankings. 7. **Extensions and Add-ons:** VirtueMart offers a wide range of extensions and add-ons, allowing users to extend the functionality of their online store with additional features and integrations. [](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/virtuemart#oxapay-plugin-for-virtuemart) OxaPay Plugin For VirtueMart -------------------------------------------------------------------------------------------------------------------------------------------- Integrating OxaPay with VirtueMart offers a modern and efficient way to accept cryptocurrency payments in your Joomla-based online store. This powerful combination enables businesses to easily accept crypto for products, providing a fast, secure, and borderless shopping experience for customers around the world. With enterprise-level security, OxaPay ensures that all transactions are processed safely and reliably. This builds trust with your customers while expanding your store’s market reach. Enabling crypto payments in VirtueMart not only simplifies payment processing but also helps attract new customers and boost sales. [](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/virtuemart#how-to-set-up-oxapay-plugin-for-virtuemart) How To Set Up OxaPay Plugin For VirtueMart? ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- 1. Go through the path “System -> Extensions” and upload the "OxaPay" plugin ZIP file ([Click here to download it](https://github.com/OxaPay/oxapay-virtuemart/archive/refs/tags/v1.0.0.zip) ) After that, the plugin must be activated in Plugins. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F2150865118-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F0cdQgWk1yvwE7MR49PSn%252Fuploads%252FtqtxJjS6pojq5TrpYri8%252FScreenshot%25202025-05-18%2520122527.png%3Falt%3Dmedia%26token%3D7f6b28e0-e80d-435d-a9ef-fb1b5c63ce1b&width=768&dpr=4&quality=100&sign=656f1e29&sv=2) ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F2150865118-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F0cdQgWk1yvwE7MR49PSn%252Fuploads%252FUxTSm9R7LUqTiOrNEuna%252FScreenshot%25202025-05-18%2520123058.png%3Falt%3Dmedia%26token%3D131c1b16-8621-4d8e-8a7a-6217fcfb3194&width=768&dpr=4&quality=100&sign=53be53d0&sv=2) 1. Now go to “Components -> VirtueMart -> Payment Methods” and then create a new payment method. Select the “VM Payment - OxaPay Crypto Payment Gateway” in Payment Method. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F2150865118-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F0cdQgWk1yvwE7MR49PSn%252Fuploads%252FA9CoFtR3i2sGAN2H74rA%252FScreenshot%25202025-05-18%2520124628.png%3Falt%3Dmedia%26token%3Db0cf8979-fedf-4a41-b578-a230bc70beb0&width=768&dpr=4&quality=100&sign=2527c99c&sv=2) 1. Go to Configuration and enter your OxaPay Merchant API key (You can find this key in your OxaPay dashboard. If you don't have an API key, [click here](https://docs.oxapay.com/welcome-to-oxapay/integrations/merchant-service) for instructions on how to create one). Complete any other fields. Once all the details are filled in, click "Save" to finalize the setup. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F2150865118-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F0cdQgWk1yvwE7MR49PSn%252Fuploads%252FttpBOJ4XReOGSq2FRGvc%252FScreenshot%25202025-05-18%2520124517.png%3Falt%3Dmedia%26token%3Da0316e1c-2c6f-4fb7-85ae-49d77200696a&width=768&dpr=4&quality=100&sign=40d00092&sv=2) **You can download the OxaPay plugin for VirtueMart by clicking on the file below:** 8KB [oxapay\_virtuemart.zip](https://2150865118-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0cdQgWk1yvwE7MR49PSn%2Fuploads%2Figes6ZYgKH55vXUy9IOZ%2Foxapay_virtuemart.zip?alt=media&token=6a83db96-e8a9-44a9-9eb1-2c5664962799) archive Download[Open](https://2150865118-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0cdQgWk1yvwE7MR49PSn%2Fuploads%2Figes6ZYgKH55vXUy9IOZ%2Foxapay_virtuemart.zip?alt=media&token=6a83db96-e8a9-44a9-9eb1-2c5664962799) We hope you found this article useful! The OxaPay plugin for **VirtueMart** is a powerful tool that can help elevate your business to new heights. [PreviousWHMCS](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/whmcs) [NextOpenCart](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/opencart) Last updated 1 month ago --- # Payout Status Table | OxaPay Docs These are the possible payout statuses you may encounter while using the OxaPay Payout Service. Each status indicates the progress of the payout process, helping you track and manage payouts effectively. Status Description processing Request submitted and is being processed. pending Request has been processed and is now in the payment queue. confirming Transaction created and is awaiting confirmation on the blockchain. confirmed The transaction has been paid successfully. canceled Payout request was canceled. rejected The request was rejected for certain reasons. [PreviousPayout History](https://docs.oxapay.com/api-reference/payout/payout-history) [NextSwap](https://docs.oxapay.com/api-reference/swap) Last updated 2 months ago --- # Generate Static Address | OxaPay Docs This endpoint allows you to generate a static address for a specific currency and network. The static address will be linked to a unique track\_id, and if a callback\_url is provided, your server will receive notifications for any payments made to the address. This enables you to track and receive transactions to the static address, regardless of the amount or timing. > Please note that static addresses with no transactions for six months will be revoked. post https://api.oxapay.com/v1/payment/static-address Header parameters merchant\_api\_keystringRequired Your Merchant API Key for authentication and authorization. Content-TypestringRequiredDefault: `application/json` Body application/json application/json networkstringRequired The blockchain network on which the static address should be created. to\_currencystringOptional The currency symbol of the cryptocurrency you want to convert to. auto\_withdrawalnumber · decimal · max: 1Optional 1 indicates that the received currency will be sent to the address specified in your Address List on the Settings page and 0 indicates that the amount will be credited to your OxaPay balance. callback\_urlstringOptional The URL where payment information will be sent. Use this to receive notifications about payments made to the static address. emailstring · emailOptional Provide the payer's email address for reporting purposes. order\_idstringOptional Specify a unique order ID for reference in your system. descriptionstringOptional Provide order details or any additional information that will be shown in different reports. Responses 200 Successful operation application/json Responseobject Show properties 400 Bad request application/json post /payment/static-address Python PythoncURLPHPNode.js Copy import requests import json url = 'https://api.oxapay.com/v1/payment/static-address' headers = { 'merchant_api_key': 'YOUR_MERCHANT_API_KEY', 'Content-Type': 'application/json' } data = { "network": "TRON", "to_currency": "USDT", "auto_withdrawal": False, "callback_url": "https://example.com/callback", "email": "[email protected]", "order_id": "ORD-12345", "description": "Order #12345" } response = requests.post(url, data=json.dumps(data), headers=headers) result = response.json() print(result) Test it 200 Successful operation Copy { "data": { "network": "TRON", "to_currency": "USDT", "auto_withdrawal": false, "callback_url": "https://example.com/callback", "email": "[email protected]", "order_id": "ORD-12345", "description": "Order #12345" }, "message": "Operation completed successfully!", "error": {}, "status": 200, "version": "1.0.0" } [PreviousGenerate White Label](https://docs.oxapay.com/api-reference/payment/generate-white-label) [NextRevoking Static Address](https://docs.oxapay.com/api-reference/payment/revoking-static-address) Last updated 4 months ago --- # WHMCS | OxaPay Docs [](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/whmcs#what-is-whmcs) What is WHMCS? ---------------------------------------------------------------------------------------------------------- WHMCS (Web Host Manager Complete Solution) is a comprehensive web hosting management and billing software designed for online businesses. It automates various aspects of web hosting operations, such as client management, billing, support, and domain registration. [](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/whmcs#key-features-of-whmcs) Key Features of WHMCS : --------------------------------------------------------------------------------------------------------------------------- 1. **Support System**: WHMCS includes a built-in support ticket system, knowledge base, and support department routing. This helps in managing customer support requests efficiently and provides a streamlined way for clients to get help. 2. **Billing Automation**: WHMCS automates invoicing, payment processing, and reminders. It supports multiple currencies and integrates with numerous payment gateways like PayPal, Stripe, and others, making it easier for web hosting companies to manage their billing. 3. **Domain Management**: The platform allows users to register, transfer, and manage domain names directly through WHMCS. It integrates with a wide range of domain registrars, enabling automated provisioning and management of domain services. 4. **Automation**: WHMCS automates many tasks related to provisioning hosting accounts and managing renewals. This reduces the workload on administrators and improves service delivery speed. 5. **Reporting and Analytics**: The platform provides detailed reports and analytics to track business performance, including sales, revenue, and customer activity. 6. **Client Management**: It offers a complete client management interface, allowing businesses to manage client accounts, track order history, and handle communications efficiently. Clients can also log into a self-service portal to manage their services, pay invoices, and contact support. [](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/whmcs#oxapay-plugin-for-whmcs) OxaPay Plugin For WHMCS ----------------------------------------------------------------------------------------------------------------------------- Integrating OxaPay with WHMCS is a smart move to elevate your business to new heights. The OxaPay plugin for WHMCS allows businesses to accept cryptocurrency as a fully integrated payment option, expanding your customer base and offering greater payment flexibility. The OxaPay plugin ensures that businesses can process payments quickly, with minimal transaction fees, and without the traditional delays associated with fiat currencies. This helps attract a broader audience, including customers who prefer using cryptocurrencies for their online purchases. Additionally, OxaPay's strong security features provide peace of mind, ensuring that every transaction is safe and reliable. [](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/whmcs#how-to-set-up-oxapay-plugin-for-whmcs) How To Set Up OxaPay Plugin For WHMCS? ---------------------------------------------------------------------------------------------------------------------------------------------------------- 1. First, unzip the downloaded OxaPay plugin archive ([Click here to download it](https://github.com/OxaPay/oxapay-whmcs/releases/download/v1.0.0/oxapay_whmcs.zip) ) to your computer or directly on your hosting server. 2. Locate the "oxapaygateway" folder and the "oxapaygateway.php" file from the unzipped archive. Move these to the following directory on your WHMCS installation: "_WHMCS → modules → gateways"._ 3. Transfer the Callback File: Next, find the **oxapaygateway.php** file located in the "callback" folder. Transfer this file to the following path on your WHMCS installation: _"WHMCS → modules → gateways → callback"._ 4. Now, hover over the settings icon, then select "Apps And Integrations" from the menu. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2Fcontent.gitbook.com%2Fcontent%2F0cdQgWk1yvwE7MR49PSn%2Fblobs%2Fq3iPT838u9j0EXCwr79b%2FScreenshot%2520%281242%29.png&width=768&dpr=4&quality=100&sign=97433dc5&sv=2) 1. Navigate to the "Search" tab and enter "OxaPay" in the search bar. In the results window that appears, click on "Activate" and proceed to the plugin settings. 2. Now, enter your “OxaPay Merchant API Key” in the designated field. You can find this key in your OxaPay panel. If you don't have an API key, [click here](https://docs.oxapay.com/welcome-to-oxapay/integrations/merchant-service) to learn how to create one, or you can use the “sandbox” mode for testing purposes. After entering your API key, complete the remaining configuration settings and click on “Save Changes”. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2Fcontent.gitbook.com%2Fcontent%2F0cdQgWk1yvwE7MR49PSn%2Fblobs%2FMAP8dLAsMPY5NSJVxHLC%2FScreenshot%2520%281246%29.png&width=768&dpr=4&quality=100&sign=c68a2e3b&sv=2) #### [](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/whmcs#you-can-download-the-oxapay-plugin-for-whmcs-by-clicking-on-the-file-below) You can download the OxaPay plugin for WHMCS by clicking on the file below: 44KB [oxapay\_whmcs.zip](https://2150865118-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0cdQgWk1yvwE7MR49PSn%2Fuploads%2FawBu44p7LqfuE5tumj2B%2Foxapay_whmcs.zip?alt=media&token=020604c5-4737-4ea6-b68d-7aef8e8a0a96) archive Download[Open](https://2150865118-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0cdQgWk1yvwE7MR49PSn%2Fuploads%2FawBu44p7LqfuE5tumj2B%2Foxapay_whmcs.zip?alt=media&token=020604c5-4737-4ea6-b68d-7aef8e8a0a96) We hope this article was helpful to you! The OxaPay plugin for WHMCS is a powerful and valuable tool that can elevate your business to the next level. [PreviousPrestaShop](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/prestashop) [NextVirtueMart](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/virtuemart) Last updated 1 month ago --- # Static Address List | OxaPay Docs Use this endpoint to retrieve a list of static addresses associated with a specific business. The list can be filtered by various criteria, such as trackId, address, network, email and orderId. Pagination is also available to fetch the results in smaller sets. get https://api.oxapay.com/v1/payment/static-address Query parameters track\_idintegerOptional Filter addresses by a specific ID. networkstringOptional Filter addresses by the expected blockchain network for the specified crypto currency. currencystringOptional Filter addresses by the expected currency. addressstringOptional Filter static addresses by the expected address. It’s better to filter static addresses. have\_txbooleanOptional Filter the addresses that had transactions. order\_idstringOptional Filter addresses by a unique order ID for reference. emailstring · emailOptional Filter addresses by the email. pageinteger · min: 1Optional The page number of the results you want to retrieve. Default: `1` sizeinteger · min: 1 · max: 200Optional Number of records to display per page. Default: `1` Header parameters merchant\_api\_keystringRequired Your Merchant API Key for authentication and authorization. Content-TypestringRequiredDefault: `application/json` Responses 200 Successful operation application/json Responseobject Show properties 400 Bad request application/json get /payment/static-address Python PythoncURLPHPNode.js Copy import requests import json url = 'https://api.oxapay.com/v1/payment/static-address' headers = { 'merchant_api_key': 'YOUR_MERCHANT_API_KEY', 'Content-Type': 'application/json' } params = { 'size': 20, 'page': 1 } response = requests.get(url, params=params , headers=headers) result = response.json() print(result) Test it 200 Successful operation Copy { "data": { "list": [\ {\ "track_id": "133830568",\ "address": "0x71E204659d18cf1477eecFBaC9a20d2cebE184b4",\ "network": "Ethereum Network",\ "callback_url": "https://example.com/callback",\ "email": "[email protected]",\ "order_id": "ORD-12345",\ "description": "Order #12345",\ "date": 1728032999\ },\ {\ "track_id": "123435847",\ "address": "TWYrqEVUpRer7sLLqshkF6HJnioL2VTJH3",\ "network": "Tron Network",\ "callback_url": "https://example.com/callback",\ "email": "[email protected]",\ "order_id": "ORD-12345",\ "description": "Order #12345",\ "date": 1728140762\ }\ ], "meta": { "page": 1, "last_page": 2, "total": 4 } }, "message": "Operation completed successfully!", "error": {}, "status": 200, "version": "1.0.0" } [PreviousRevoking Static Address](https://docs.oxapay.com/api-reference/payment/revoking-static-address) [NextPayment Information](https://docs.oxapay.com/api-reference/payment/payment-information) Last updated 4 months ago --- # WooCommerce | OxaPay Docs [](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/wordpress/woocommerce#what-is-woocommerce) What is WooCommerce? -------------------------------------------------------------------------------------------------------------------------------------- WooCommerce is a free plugin for the WordPress content management system that allows users to easily set up and manage their online stores. It is one of the most popular and widely used tools for creating e-commerce websites. Due to its high flexibility and the ability to extend its functionality with various plugins and themes, WooCommerce is an ideal choice for both small and large businesses. [](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/wordpress/woocommerce#key-features-of-woocommerce) Key Features of WooCommerce: ------------------------------------------------------------------------------------------------------------------------------------------------------ 1. **Free to Use**: WooCommerce is available for free, allowing you to set up your online store without any additional costs. 2. **Integration with WordPress**: WooCommerce is fully integrated with WordPress, enabling you to leverage all of WordPress’s capabilities. 3. **Flexibility**: It offers high customization options through various themes and plugins, allowing you to design your store exactly how you want. 4. **Product Management**: WooCommerce provides easy management of products, allowing you to add, delete, and edit products with details like pricing, images, descriptions, and categories. 5. **Payment Gateways**: It supports multiple payment gateways, including local and international options, making it easy to receive payments from your customers. 6. **Reporting and Analytics**: WooCommerce includes tools for reporting and analyzing your store's performance, helping you monitor and improve your business. 7. **Multilingual Support**: With the help of various plugins, WooCommerce can be set up to support multiple languages, allowing you to serve customers from around the world. 8. **Strong SEO Capabilities**: WooCommerce benefits from WordPress’s powerful SEO features, helping your store get better visibility in search engines. [](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/wordpress/woocommerce#oxapay-plugin-for-woocommerce) OxaPay Plugin For WooCommerce --------------------------------------------------------------------------------------------------------------------------------------------------------- Integrating OxaPay with WooCommerce is a strategic move to expand your business and achieve new milestones. The OxaPay plugin for WooCommerce enables businesses to accept cryptocurrency as a fully integrated payment method, thereby broadening your customer base and enhancing payment flexibility. By leveraging WooCommerce, you can efficiently manage various aspects of your online store. Activating the OxaPay plugin on the WooCommerce platform boosts operational efficiency and enhances customer engagement by enabling crypto transactions with minimal fees and fast processing times. [](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/wordpress/woocommerce#how-to-set-up-oxapay-plugin-for-woocommerce) How To Set Up OxaPay Plugin For WooCommerce? -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- 1. Log in to your WordPress control panel, navigate to the "Plugins" section, and click on "Add New". Select "Upload Plugin" then upload the "OxaPay" plugin ZIP file ([Click here to download it](https://downloads.wordpress.org/plugin/oxapay.1.0.0.zip) ) and click on the"Install Now" button. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2Fcontent.gitbook.com%2Fcontent%2F0cdQgWk1yvwE7MR49PSn%2Fblobs%2FwMM2x0Wgkjes9zqzNfDF%2FScreenshot%2520%281183%29.png&width=768&dpr=4&quality=100&sign=9eb8777a&sv=2) 1. Once the plugin is installed, click on "Activate Plugin" to enable it. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2Fcontent.gitbook.com%2Fcontent%2F0cdQgWk1yvwE7MR49PSn%2Fblobs%2FDcb0bx5LiQQTUUfPoH2T%2FScreenshot%2520%281185%29.png&width=768&dpr=4&quality=100&sign=7dac00f4&sv=2) 1. In the list of installed plugins, locate OxaPay and click on the "Configure" link. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2Fcontent.gitbook.com%2Fcontent%2F0cdQgWk1yvwE7MR49PSn%2Fblobs%2FpK81LUpMfc61L8eEReYq%2FScreenshot%2520%281186%29.png&width=768&dpr=4&quality=100&sign=91fca684&sv=2) 1. Enter your OxaPay Merchant API key (You can find this key in your OxaPay dashboard. If you don't have an API key, [click here](https://docs.oxapay.com/welcome-to-oxapay/integrations/merchant-service) for instructions on how to create one). Complete any other required fields. You can use the "sandbox" mode for testing. Once all the details are filled in, click "Save Changes" to finalize the setup. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2Fcontent.gitbook.com%2Fcontent%2F0cdQgWk1yvwE7MR49PSn%2Fblobs%2FTjd6VpgYB4LdHu0XCV9G%2FScreenshot%2520%281211%29.png&width=768&dpr=4&quality=100&sign=5c6eba20&sv=2) #### [](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/wordpress/woocommerce#if-you-encounter-the-following-error) If you encounter the following error: > “There are no payment methods available. This may be an error on our side. Please contact us if you need any help placing your order.” #### [](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/wordpress/woocommerce#simply-navigate-to-the-checkout-page-in-the-pages-section-of-your-wordpress-admin-panel.-click-on-fo) Simply navigate to the "Checkout" page in the "Pages" section of your WordPress admin panel. Click on "Form" and then select "Switch to classic checkout" to resolve the issue. #### [](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/wordpress/woocommerce#you-can-download-the-oxapay-plugin-for-woocommerce-by-clicking-on-the-file-below) You can download the OxaPay plugin for WooCommerce by clicking on the file below: 124KB [oxapay\_woocommerce.zip](https://2150865118-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0cdQgWk1yvwE7MR49PSn%2Fuploads%2FYCiF6VbExVQryUQXRzLB%2Foxapay_woocommerce.zip?alt=media&token=a7e9b28b-ff5a-4168-9976-a4ec40f03f78) archive Download[Open](https://2150865118-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0cdQgWk1yvwE7MR49PSn%2Fuploads%2FYCiF6VbExVQryUQXRzLB%2Foxapay_woocommerce.zip?alt=media&token=a7e9b28b-ff5a-4168-9976-a4ec40f03f78) We hope this article was helpful to you! The OxaPay plugin for WooCommerce is a powerful and valuable tool to take your business to the next level. Last updated 1 month ago --- # Payout Information | OxaPay Docs This endpoint retrieves the details of a specific payout using its track\_id. After generating a payout request, you will receive a track\_id, which can be used to obtain detailed information about the payout. get https://api.oxapay.com/v1/payout/{track\_id} Path parameters track\_idstringRequired Unique identifier for the payout session. Header parameters payout\_api\_keystringRequired Your Payout API Key for authentication and authorization. Content-TypestringRequiredDefault: `application/json` Responses 200 Successful operation application/json Responseobject Show properties 400 Bad request application/json get /payout/{track\_id} Python PythoncURLPHPNode.js Copy import requests import json track_id = 'TRACK_ID' url = f'https://api.oxapay.com/v1/payout/{track_id}' headers = { 'payout_api_key': 'YOUR_PAYOUT_API_KEY', 'Content-Type': 'application/json' } response = requests.get(url, headers=headers) result = response.json() print(result) Test it 200 Successful operation Copy { "data": { "track_id": "258298351", "address": "1AmH3Qz2LooYa1YSyLhySuatwoRMsfznPJ", "currency": "BTC", "network": "Bitcoin Network", "amount": 0.02, "fee": 0.00001, "status": "processing", "tx_hash": "", "description": "test", "internal": false, "memo": "test", "date": 1736501470 }, "message": "Operation completed successfully!", "error": {}, "status": 200, "version": "1.0.0" } [PreviousGenerate Payout](https://docs.oxapay.com/api-reference/payout/generate-payout) [NextPayout History](https://docs.oxapay.com/api-reference/payout/payout-history) Last updated 4 months ago --- # Integrations | Legacy | OxaPay Docs [Payment Links](https://docs.oxapay.com/legacy/integrations/payment-links) [Donations](https://docs.oxapay.com/legacy/integrations/donations) [Merchant API](https://docs.oxapay.com/legacy/integrations/merchant-api) [Payout API](https://docs.oxapay.com/legacy/integrations/payout-api) [Plugins](https://docs.oxapay.com/legacy/integrations/plugins) [Merchant and Payout Service with API](https://docs.oxapay.com/legacy/integrations/merchant-and-payout-service-with-api) [PreviousGetting Started](https://docs.oxapay.com/legacy/getting-started) [NextPayment Links](https://docs.oxapay.com/legacy/integrations/payment-links) Last updated 1 year ago --- # Getting Started | Legacy | OxaPay Docs To start using the OxaPay Crypto Payment Gateway, follow these steps: [](https://docs.oxapay.com/legacy/getting-started#id-1.-create-an-account) 1\. Create an Account ----------------------------------------------------------------------------------------------------- Visit the OxaPay website and sign up for an account. Fill in the required information and complete the registration process. Once your account is created, you will have access to the OxaPay dashboard. Certainly! Here's the revised version of the "Generate an API Key" section, taking into account the two types of API keys available in OxaPay: [](https://docs.oxapay.com/legacy/getting-started#id-2.-generate-api-keys) 2\. Generate API Keys ----------------------------------------------------------------------------------------------------- To interact with the OxaPay API, you need to generate two types of API keys: the Merchant API Key for processing payments and the Payout API Key for managing payouts. Follow these steps to generate your API keys: ### [](https://docs.oxapay.com/legacy/getting-started#merchant-api-key) Merchant API Key 1. Log in to your OxaPay account. 2. Navigate to the Merchants API tab in your account. 3. Click on the "Generate Merchant API Key" button. 4. Give your Merchant API key a meaningful name for identification purposes. Once generated, make sure to securely store your Merchant API key as it grants access to your OxaPay account for processing payments. ### [](https://docs.oxapay.com/legacy/getting-started#payout-api-key) Payout API Key In addition to generating a Payout API key for managing payouts, OxaPay provides an extra layer of security by allowing you to specify Allowed IPs for transfers. This feature restricts payout requests to be initiated only from the specified IP addresses, enhancing the security of your payout operations. Follow these steps to generate your Payout API key and configure the Allowed IPs for transfer: 1. In your OxaPay account, go to the Payout API tab. 2. Click on the "Generate Payout API Key" button. 3. Provide a descriptive name for your Payout API key. 4. Optionally, you can set the Allowed IPs for transfer in the provided field. Enter the IP addresses from which you want to permit payout requests. Safely store your Payout API key as it provides access to the payout functionality of your OxaPay account. By setting the Allowed IPs for transfer, you can ensure that payout requests can only be initiated from the specified IP addresses, adding an extra layer of security to your payout operations. This helps prevent unauthorized access and reduces the risk of fraudulent activity. Remember to keep your Payout API key confidential and avoid sharing it with unauthorized individuals or third parties. This key grants access to the payout functionality of your OxaPay account and should be treated with the same level of security as your login credentials. Once you have generated the Payout API key and configured the Allowed IPs for transfer, you can proceed with integrating the OxaPay Crypto Payment Gateway and utilizing the Payout API for managing payouts. Refer to the API Reference section for detailed information on using the Payout API key and performing payout-related operations. If you have any questions or need further assistance regarding the configuration of the Allowed IPs for transfer or any other aspects of the Payout API, feel free to reach out to our support team. [](https://docs.oxapay.com/legacy/getting-started#id-3.-test-the-api) 3\. Test the API ------------------------------------------------------------------------------------------- Before integrating the OxaPay API into your application or website, it is recommended to test the API using the sandbox environment. The sandbox environment allows you to experiment and familiarize yourself with the API functionality without processing real transactions. ### [](https://docs.oxapay.com/legacy/getting-started#merchant-api-testing) Merchant API Testing To test the Merchant APIs and validate the available gateways, you can use the 'sandbox' as the merchant field in your API requests. This allows you to simulate payment flows and evaluate the response from the OxaPay system. Note that the sandbox environment is specifically available for testing purposes with the following format: `merchant: 'sandbox'` By including the 'sandbox' value as the merchant field in your Merchant API requests, you can access the test environment and perform various payment scenarios without impacting real transactions or balances. During the testing phase, it is recommended to thoroughly explore the available API endpoints. These endpoints allow you to create payments, retrieve payment information, check transaction status, and more. By testing the API endpoints with different scenarios, you can verify the expected functionality and behavior of the OxaPay API. Once you are confident with the testing results in the sandbox environment, you can proceed to integrate the OxaPay Crypto Payment Gateway into your live application or website. Make sure to update the merchant field to the appropriate value for production use. Refer to the API Reference section for detailed information on available endpoints, request and response formats, and example code snippets to guide you through the integration process. If you encounter any issues or have questions during the integration and testing process, our support team is available to assist you. Let's dive into the API Reference section, where you will find detailed information about each API endpoint and how to use them effectively. [PreviousIntroduction](https://docs.oxapay.com/legacy) [NextIntegrations](https://docs.oxapay.com/legacy/integrations) Last updated 2 months ago --- # Generate Payout | OxaPay Docs This endpoint enables you to generate a cryptocurrency payout request, allowing you to transfer funds to a specified address. It is designed to facilitate seamless and secure transactions by generating a payout request within your account. post https://api.oxapay.com/v1/payout Header parameters payout\_api\_keystringRequired Your Payout API Key for authentication and authorization. Content-TypestringRequiredDefault: `application/json` Body application/json application/json addressstringRequired The recipient's cryptocurrency address where the payout will be sent. currencystringRequired The symbol of the cryptocurrency to be sent (e.g., BTC, ETH, LTC, etc.). amountnumber · decimalRequired The exact amount of cryptocurrency to be sent as the payout. networkstringOptional The blockchain network to be used for the payout. Required for currencies with multiple supported networks. callback\_urlstring · uriOptional The URL for sending payment status updates. memostringOptional A memo or tag for transactions on supported networks (e.g., for TON). descriptionstringOptional A description or additional information for the payout, useful for reports. Responses 200 Successful operation application/json Responseobject Show properties 400 Bad request application/json post /payout Python PythoncURLPHPNode.js Copy import requests import json url = 'https://api.oxapay.com/v1/payout' data = { "address": "RECEIVER_ADDRESS", "amount": 5, "currency": "TRX", "network": "TRC20", "callback_url": "https://example.com/callback", "memo": "Memo12345", "description": "Order #12345" } headers = { 'payout_api_key': 'YOUR_PAYOUT_API_KEY', 'Content-Type': 'application/json' } response = requests.post(url, data=json.dumps(data), headers=headers) result = response.json() print(result) Test it 200 Successful operation Copy { "data": { "track_id": "258298451", "status": "processing" }, "message": "Operation completed successfully!", "error": {}, "status": 200, "version": "1.0.0" } [PreviousPayout](https://docs.oxapay.com/api-reference/payout) [NextPayout Information](https://docs.oxapay.com/api-reference/payout/payout-information) Last updated 4 months ago --- # Introduction | Legacy | OxaPay Docs [](https://docs.oxapay.com/legacy#welcome-to-oxapay) Welcome to OxaPay --------------------------------------------------------------------------- Welcome to the OxaPay Crypto Payment Gateway documentation. OxaPay provides a robust and secure platform for processing cryptocurrency payments, allowing businesses and developers to easily integrate crypto payments into their applications and websites. ### [](https://docs.oxapay.com/legacy#what-is-oxapay) What is OxaPay? OxaPay is a leading crypto payment gateway that enables businesses to accept payments in various cryptocurrencies securely. With OxaPay, merchants can expand their customer base by offering a convenient and efficient payment method that leverages the benefits of blockchain technology. ### [](https://docs.oxapay.com/legacy#what-is-the-oxapay-api) What is the OxaPay API? The OxaPay API is a powerful RESTful interface that allows developers to interact with their OxaPay accounts programmatically. It provides a comprehensive set of endpoints and methods to facilitate the creation and management of invoices, retrieval of real-time rate information, and processing of payments. The OxaPay API enables seamless integration of crypto payments into applications, e-commerce platforms, and websites. ### [](https://docs.oxapay.com/legacy#who-is-this-documentation-for) Who is this documentation for? This documentation is designed for developers, merchants, and businesses who wish to integrate OxaPay's crypto payment gateway into their applications or websites. It provides comprehensive information about the OxaPay API, including endpoint descriptions, request and response examples, and use cases. Whether you are a developer looking to implement crypto payments or a merchant seeking to enhance your payment options, this documentation will guide you through the process of integrating and leveraging OxaPay's powerful crypto payment solutions. Now that you have an overview of OxaPay and the purpose of this documentation, let's get started by creating an account and generating an API key. [](https://docs.oxapay.com/legacy#undefined) ------------------------------------------------ [API Reference](https://docs.oxapay.com/legacy/api-reference) [NextGetting Started](https://docs.oxapay.com/legacy/getting-started) Last updated 2 months ago --- # Generate White Label | OxaPay Docs This endpoint allows you to generate white-labeled payment solutions, delivering a fully branded payment experience powered by the OxaPay gateway. Instead of generating an invoice URL, this endpoint provides comprehensive payment details, including the payment address, currency, amount, expiration time, and other relevant information, enabling you to manage the payment process within your own interface. post https://api.oxapay.com/v1/payment/white-label Header parameters merchant\_api\_keystringRequired Your Merchant API Key for authentication and authorization. Content-TypestringRequiredDefault: `application/json` Body application/json application/json pay\_currencystringRequired Specify the currency symbol if you want the invoice to be paid in a specific currency. Defines the currency in which you wish to receive your settlements. amountnumber · decimalRequired The amount for the payment. If the currency field is not filled, the amount should be specified in dollars. If the `currency` field is filled, the amount should correspond to the specified currency. currencystringOptional Specify the currency symbol if you want the invoice amount calculated with a specific currency. You can also generate invoices in fiat currencies. networkstringOptional The blockchain network on which the payment should be created. If not specified, the default network will be used. lifetimeinteger · min: 15 · max: 2880Optional Set the expiration time for the payment link in minutes. Default: `60` fee\_paid\_by\_payernumber · decimal · max: 1Optional Specify whether the payer will cover the invoice commission. 1 indicates that the payer will pay the fee, while 0 indicates that the merchant will pay the fee. Default: `Merchant setting`Example: `1` under\_paid\_coveragenumber · decimal · max: 60Optional Specify the acceptable inaccuracy in payment. Determines the maximum acceptable difference between the requested and paid amount. Default: `Merchant setting`Example: `10` to\_currencystringOptional The currency symbol of the cryptocurrency you want to convert to. You can only convert paid crypto currencies to USDT. auto\_withdrawalbooleanOptional 1 indicates that the received currency will be sent to the address specified in your Address List on the Settings page and 0 indicates that the amount will be credited to your OxaPay balance. callback\_urlstring · uriOptional The URL where payment information will be sent. Use this to receive notifications about the payment status. emailstring · emailOptional Provide the payer's email address for reporting purposes. order\_idstringOptional Specify a unique order ID for reference in your system. descriptionstringOptional Provide order details or any additional information that will be shown in different reports. Responses 200 Successful operation application/json Responseobject Show properties 400 Bad request application/json post /payment/white-label Python PythoncURLPHPNode.js Copy import requests import json url = 'https://api.oxapay.com/v1/payment/white-label' headers = { 'merchant_api_key': 'YOUR_MERCHANT_API_KEY', 'Content-Type': 'application/json' } data = { "amount": 100, "currency": "USD", "pay_currency": "TRX", "network": "TRC20", "lifetime": 60, "fee_paid_by_payer": 1, "under_paid_coverage": 20, "to_currency": "USDT", "auto_withdrawal": False, "callback_url": "https://example.com/callback", "email": "[email protected]", "order_id": "ORD-12345", "description": "Order #12345" } response = requests.post(url, data=json.dumps(data), headers=headers) result = response.json() print(result) Test it 200 Successful operation Copy { "data": { "track_id": "197218291", "amount": 1, "currency": "usd", "pay_amount": 3.6819352872888, "pay_currency": "trx", "network": "Tron Network", "address": "TQraad2MBFgYUYhTFYeXS5jVpaLZuBwr3w", "callback_url": "https://example.com/callback", "description": "Order #12345", "email": "[email protected]", "fee_paid_by_payer": 1, "lifetime": 60, "order_id": "ORD-12345", "under_paid_coverage": 20, "rate": 3.67376929, "qr_code": "https://api.qrserver.com/v1/create-qr-code/?data=tron:TQraad2MBFgYUYhTFYeXS5jVpaLZuBwr3w?amount=3&size=150x150", "expired_at": 1734514150, "date": 1734510550 }, "message": "Operation completed successfully!", "error": {}, "status": 200, "version": "1.0.0" } [PreviousGenerate Invoice](https://docs.oxapay.com/api-reference/payment/generate-invoice) [NextGenerate Static Address](https://docs.oxapay.com/api-reference/payment/generate-static-address) Last updated 4 months ago --- # Error | OxaPay Docs **API Error Responses** When an error occurs in the OxaPay API, the response will be structured in a standardized format. This allows users to easily identify and address issues with their requests. Below is an overview of the error response structure, the possible status codes, and the types of errors you may encounter. Error response structure Copy { "data": {}, "message": string, // A message containing additional information about the result of the request. "error": { "type": string, "key": string, "message": string } || {}, // An object that provides details about any errors that occurred. "status": integer, // The status of the request response. Typically provided as a numeric code (e.g., 200 for success or other codes for errors). "version": string // The version of the API being used. } #### [](https://docs.oxapay.com/api-reference/error#statuses) Statuses **Status Code** **Meaning** **Common Causes** **200 OK** The request was successful. The request was processed without errors. **400 Bad Request** The request was invalid or malformed. Missing required fields, invalid data format, or unacceptable parameter values. **401 Unauthorized** The user is not authenticated or has invalid credentials. Missing or invalid API key, incorrect session or token. **404 Not Found** The requested resource could not be found. The resource doesn't exist or the endpoint is incorrect. **500 Internal Server Error** An unexpected server-side error occurred. Server failure, issues with third-party integrations or dependencies. **503 Service Unavailable** One of the services is temporarily unavailable. Server overload, service downtime, or maintenance. [PreviousSystem Status](https://docs.oxapay.com/api-reference/common/system-status) [NextWebhook](https://docs.oxapay.com/webhook) Last updated 2 months ago --- # Payout History | OxaPay Docs This endpoint retrieves a list of payout transactions associated with your account, based on your Payout API Key. You can filter the results by various criteria, including time range, status, amount, currency, network, type (internal or external), and more. Additionally, pagination allows you to retrieve the results in smaller, manageable sets. get https://api.oxapay.com/v1/payout Query parameters statusstringOptional Filter payouts based on their status (processing, complete, rejected, etc.). typestring · enumOptional Filter payouts based on type. Possible values: `external``internal` currencystringOptional Specify the currency symbol for filtering payouts in a specific currency. networkstringOptional Specify the blockchain network for filtering payouts on a particular network. from\_amountnumber · decimalOptional Specify the minimum payout amount for filtering. to\_amountnumber · decimalOptional Specify the maximum payout amount for filtering. from\_dateintegerOptional The start of the date window to query for payouts in UNIX format. to\_dateintegerOptional The end of the date window to query for payouts in UNIX format. sort\_bystring · enumOptional Sort the received list by a parameter. Default: `create_date`Possible values: `create_date``pay_date``amount` sort\_typestring · enumOptional Display the list in ascending or descending order. Default: `desc`Possible values: `asc``desc` sizeinteger · min: 1 · max: 200Optional Number of records to be displayed on one page. Default: `10` pageinteger · min: 1Optional The page number of the results you want to retrieve. Default: `1` Header parameters payout\_api\_keystringRequired Your Payout API Key for authentication and authorization. Content-TypestringRequiredDefault: `application/json` Responses 200 Successful operation application/json Responseobject Show properties 400 Bad request application/json get /payout Python PythoncURLPHPNode.js Copy import requests import json url = 'https://api.oxapay.com/v1/payout/' params = { 'size': 20, 'page': 1 } headers = { 'payout_api_key': 'YOUR_PAYOUT_API_KEY ', 'Content-Type': 'application/json' } response = requests.get(url, params=params , headers=headers) result = response.json() print(result) Test it 200 Successful operation Copy { "data": { "list": [\ {\ "track_id": "258298351",\ "address": "1AmH3Qz2LooYa1YSyLhySuatwoRMsfznPJ",\ "currency": "BTC",\ "network": "Bitcoin Network",\ "amount": 0.02,\ "fee": 0.00001,\ "status": "processing",\ "tx_hash": "",\ "description": "test",\ "internal": false,\ "memo": "test",\ "date": 1736501470\ }\ ], "meta": { "page": 1, "last_page": 1, "total": 1 } }, "message": "Operation completed successfully!", "error": {}, "status": 200, "version": "1.0.0" } [PreviousPayout Information](https://docs.oxapay.com/api-reference/payout/payout-information) [NextPayout Status Table](https://docs.oxapay.com/api-reference/payout/payout-status-table) Last updated 4 months ago --- # Swap Rate | OxaPay Docs This endpoint allows you to fetch real-time swap rates for cryptocurrency pairs supported by OxaPay. It’s ideal for applications that need the latest cryptocurrency prices to ensure accurate and timely calculations. post https://api.oxapay.com/v1/general/swap/rate Header parameters general\_api\_keystringRequired Your General API Key for authentication and authorization. Content-TypestringRequiredDefault: `application/json` Body application/json application/json from\_currencystringRequired Specify the currency symbol you want to swap from. Example: `BTC` to\_currencystringRequired Specify the currency symbol you want to swap to. Example: `USDT` Responses 200 Successful operation application/json Responseobject Show properties 400 Bad request application/json post /general/swap/rate Python PythoncURLPHPNode.js Copy import requests import json url = 'https://api.oxapay.com/v1/general/swap/rate' data = { "from_currency": "USDT", "to_currency": "TRX" } headers = { 'general_api_key': 'YOUR_GENERAL_API_KEY', 'Content-Type': 'application/json' } response = requests.post(url, data=json.dumps(data), headers=headers) result = response.json() print(result) Test it 200 Successful operation Copy { "data": { "rate": 94763.06 }, "message": "Operation completed successfully!", "error": {}, "status": 200, "version": "1.0.0" } [PreviousSwap Calculate](https://docs.oxapay.com/api-reference/swap/swap-calculate) [NextCommon](https://docs.oxapay.com/api-reference/common) Last updated 4 months ago --- # Swap Request | OxaPay Docs This endpoint allows you to swap your account assets. You can swap one cryptocurrency for another instantly at the current market rate. To see the supported swap options, refer to the [swap pairs](https://docs.oxapay.com/api-reference/swap/swap-pairs2) endpoint. Whether you're swapping Bitcoin for Tether, Tether for Litecoin, or any other supported combination, this feature ensures secure and accurate asset swaps. Swaps are processed in real-time to provide you with the best available rates. post https://api.oxapay.com/v1/general/swap Header parameters general\_api\_keystringRequired Your General API Key for authentication and authorization. Content-TypestringRequiredDefault: `application/json` Body application/json application/json from\_currencystringRequired Specify the currency symbol you want to swap from. to\_currencystringRequired Specify the currency symbol you want to swap to. amountnumber · decimalRequired Specify the amount of currency you want to swap. Responses 200 Successful operation application/json Responseobject Show properties 400 Bad request application/json post /general/swap Python PythoncURLPHPNode.js Copy import requests import json url = 'https://api.oxapay.com/v1/general/swap' data = { "amount": 0.5, "from_currency": "BTC", "to_currency": "USDT" } headers = { 'general_api_key': 'YOUR_GENERAL_API_KEY', 'Content-Type': 'application/json' } response = requests.post(url, data=json.dumps(data), headers=headers) result = response.json() print(result) Test it 200 Successful operation Copy { "data": { "track_id": "393831199", "from_currency": "USDT", "to_currency": "BTC", "from_amount": 10, "to_amount": 0.0001054, "rate": 94876.66034156, "date": 1736508792 }, "message": "Operation completed successfully!", "error": {}, "status": 200, "version": "1.0.0" } [PreviousSwap](https://docs.oxapay.com/api-reference/swap) [NextSwap History](https://docs.oxapay.com/api-reference/swap/swap-history) Last updated 4 months ago --- # Swap Pairs | OxaPay Docs This endpoint allows you to access a list of swappable cryptocurrencies along with their minimum swap amounts. It provides the available options for the from\_currency and to\_currency fields when performing cryptocurrency swaps. Whether you're swapping Bitcoin for Tether or Tether for Litecoin, this list ensures clarity on supported pairs and their minimum swap requirements, helping you plan seamless transactions. get https://api.oxapay.com/v1/general/swap/pairs Header parameters general\_api\_keystringRequired Your General API Key for authentication and authorization. Content-TypestringRequiredDefault: `application/json` Responses 200 Successful operation application/json Responseobject Show properties 400 Bad request application/json get /general/swap/pairs Python PythoncURLPHPNode.js Copy import requests url = 'https://api.oxapay.com/v1/general/swap/pairs' headers = { 'general_api_key': 'YOUR_GENERAL_API_KEY', 'Content-Type': 'application/json' } response = requests.get(url, headers=headers) result = response.json() print(result) Test it 200 Successful operation Copy { "data": { "list": [\ {\ "from_currency": "BTC",\ "to_currency": "USDT",\ "min_amount": 0.00001\ },\ {\ "from_currency": "ETH",\ "to_currency": "USDT",\ "min_amount": 0.0006\ },\ {\ "from_currency": "BNB",\ "to_currency": "USDT",\ "min_amount": 0.001\ },\ {\ "from_currency": "LTC",\ "to_currency": "USDT",\ "min_amount": 0.01\ },\ {\ "from_currency": "TRX",\ "to_currency": "USDT",\ "min_amount": 2\ },\ {\ "from_currency": "DOGE",\ "to_currency": "USDT",\ "min_amount": 1\ },\ {\ "from_currency": "POL",\ "to_currency": "USDT",\ "min_amount": 1\ },\ {\ "from_currency": "TON",\ "to_currency": "USDT",\ "min_amount": 0.3\ },\ {\ "from_currency": "XMR",\ "to_currency": "USDT",\ "min_amount": 0.005\ },\ {\ "from_currency": "BCH",\ "to_currency": "USDT",\ "min_amount": 0.002\ },\ {\ "from_currency": "SHIB",\ "to_currency": "USDT",\ "min_amount": 100000\ },\ {\ "from_currency": "SOL",\ "to_currency": "USDT",\ "min_amount": 0.008\ },\ {\ "from_currency": "NOT",\ "to_currency": "USDT",\ "min_amount": 50\ },\ {\ "from_currency": "USDC",\ "to_currency": "USDT",\ "min_amount": 1\ },\ {\ "from_currency": "DOGS",\ "to_currency": "USDT",\ "min_amount": 1\ },\ {\ "from_currency": "USDT",\ "to_currency": "TRX",\ "min_amount": 1\ },\ {\ "from_currency": "USDT",\ "to_currency": "DOGE",\ "min_amount": 1\ },\ {\ "from_currency": "USDT",\ "to_currency": "POL",\ "min_amount": 1\ },\ {\ "from_currency": "USDT",\ "to_currency": "TON",\ "min_amount": 1\ },\ {\ "from_currency": "USDT",\ "to_currency": "XMR",\ "min_amount": 1\ },\ {\ "from_currency": "USDT",\ "to_currency": "BCH",\ "min_amount": 1\ },\ {\ "from_currency": "USDT",\ "to_currency": "SHIB",\ "min_amount": 1\ },\ {\ "from_currency": "USDT",\ "to_currency": "SOL",\ "min_amount": 1\ },\ {\ "from_currency": "USDT",\ "to_currency": "NOT",\ "min_amount": 1\ },\ {\ "from_currency": "USDT",\ "to_currency": "USDC",\ "min_amount": 1\ },\ {\ "from_currency": "USDT",\ "to_currency": "DOGS",\ "min_amount": 1\ }\ ] }, "message": "Operation completed successfully!", "error": {}, "status": 200, "version": "1.0.0" } [PreviousSwap History](https://docs.oxapay.com/api-reference/swap/swap-history) [NextSwap Calculate](https://docs.oxapay.com/api-reference/swap/swap-calculate) Last updated 4 months ago --- # WordPress | OxaPay Docs [WooCommerce](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/wordpress/woocommerce) [Easy Digital Downloads](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/wordpress/easy-digital-downloads) [Paid Memberships Pro](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/wordpress/paid-memberships-pro) [Restrict Content Pro](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/wordpress/restrict-content-pro) [Gravity Forms](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/wordpress/gravity-forms) [PreviousOpenCart](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/opencart) [NextWooCommerce](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/wordpress/woocommerce) Last updated 18 days ago --- # Gravity Forms | OxaPay Docs [](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/wordpress/gravity-forms#what-is-gravity-forms) What is Gravity Forms? -------------------------------------------------------------------------------------------------------------------------------------------- Gravity Forms is a powerful WordPress plugin that allows users to create advanced and customizable forms with ease. It’s ideal for building contact forms, surveys, registrations, online payments, and more. Key features include a drag-and-drop interface, integration with third-party services (like OxaPay and PayPal ), and conditional logic to enhance user experience. [](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/wordpress/gravity-forms#key-features-of-gravity-forms) Key Features of Gravity Forms: ------------------------------------------------------------------------------------------------------------------------------------------------------------ 1. **Ease of Use:** Gravity Forms provides a user-friendly drag-and-drop form builder, allowing you to create professional forms in minutes without requiring technical expertise. 2. **Seamless WordPress Integration:** As a WordPress plugin, Gravity Forms integrates effortlessly with WordPress, enabling smooth performance and leveraging all of WordPress’s capabilities. 3. **Customizable Forms:** With extensive field options and advanced settings, you can create contact forms, surveys, payment forms, registration forms, and more to suit your exact needs. 4. **Payment Integrations:** Gravity Forms supports major payment gateways like OxaPay, PayPal, and Stripe, making it easy to accept payments, donations, or subscriptions directly through your forms. 5. **Notifications and Confirmations :**Automate email notifications to inform both users and administrators upon form submissions, and customize confirmation messages or redirects to enhance user engagement. 6. **Responsive Design:** Forms created with Gravity Forms are mobile-friendly and responsive, ensuring they function perfectly across all devices, including tablets and smartphones. [](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/wordpress/gravity-forms#oxapay-plugin-for-gravity-forms) OxaPay Plugin For Gravity Forms --------------------------------------------------------------------------------------------------------------------------------------------------------------- Integrating OxaPay with Gravity Forms is a strategic way to enhance your payment options and reach a broader audience. The OxaPay integration enables businesses to seamlessly accept cryptocurrency payments directly through Gravity Forms, offering customers greater flexibility and modernizing your payment process. Additionally, OxaPay prioritizes security, ensuring that every transaction is safe, reliable, and protected. By adding cryptocurrency as a payment option in Gravity Forms, businesses can attract a wider customer base while streamlining their payment workflows and improving the overall user experience. [](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/wordpress/gravity-forms#how-to-set-up-oxapay-plugin-for-gravity-forms) How To Set Up OxaPay Plugin For Gravity Forms? -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- 1. Log in to your WordPress control panel, navigate to the "Plugins" section, and click on "Add New". Select "Upload Plugin" then upload the "OxaPay" plugin ZIP file ([Click here to download it](https://downloads.wordpress.org/plugin/oxapay-crypto-payment-gateway-for-gravity-forms.1.0.0.zip) ) and click on the"Install Now" button. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F2150865118-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F0cdQgWk1yvwE7MR49PSn%252Fuploads%252FTK8qIZdMdXE7h3RbNyr3%252FScreenshot%2520%2858%29.png%3Falt%3Dmedia%26token%3Decffd2b5-e32e-4f80-afac-1b3931fae4d6&width=768&dpr=4&quality=100&sign=c63cb6c7&sv=2) 1. After installing and activating the Oxapay plugin, go to the **Gravity Forms** settings page and click on OxaPay to enter your OxaPay Merchant API key (You can find this key in your OxaPay dashboard. If you don't have an API key, [click here](https://docs.oxapay.com/welcome-to-oxapay/integrations/merchant-service) for instructions on how to create one). Complete any other required fields. You can use the "sandbox" mode for testing. Once all the details are filled in, click "Save Settings" to finalize the setup. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F2150865118-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F0cdQgWk1yvwE7MR49PSn%252Fuploads%252FGXxmooncc0tkJwzWVayK%252FScreenshot%2520%2854%29.png%3Falt%3Dmedia%26token%3D1b437953-72e6-488d-a63a-e93b61743dea&width=768&dpr=4&quality=100&sign=17f8da5&sv=2) 1. Now click on OxaPay in the navigation bar and to add your form, click on Add New. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F2150865118-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F0cdQgWk1yvwE7MR49PSn%252Fuploads%252F6nFUXxPkbn6vz1FHxoEm%252FScreenshot%2520%2855%29.png%3Falt%3Dmedia%26token%3D13d091ac-1094-427d-928b-a7503b591519&width=768&dpr=4&quality=100&sign=54b3804b&sv=2) 1. After entering the "Add New Form" page, select the form type, choose your desired form and click the "Save" button. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F2150865118-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F0cdQgWk1yvwE7MR49PSn%252Fuploads%252Ft15I6fCjPI2C5beWXTvl%252FScreenshot%2520%2856%29.png%3Falt%3Dmedia%26token%3De64241d6-1195-4591-83cc-cd4d959bdf0f&width=768&dpr=4&quality=100&sign=b5046885&sv=2) **You can download the OxaPay plugin for Gravity Forms by clicking on the file below:** 38KB [oxapay-crypto-payment-gateway-for-gravity-forms.1.0.0.zip](https://2150865118-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0cdQgWk1yvwE7MR49PSn%2Fuploads%2FyONlJp0NA0dHK6HgjReB%2Foxapay-crypto-payment-gateway-for-gravity-forms.1.0.0.zip?alt=media&token=b75f0b73-e92c-47a1-9b0b-4ab7b52892c5) archive Download[Open](https://2150865118-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0cdQgWk1yvwE7MR49PSn%2Fuploads%2FyONlJp0NA0dHK6HgjReB%2Foxapay-crypto-payment-gateway-for-gravity-forms.1.0.0.zip?alt=media&token=b75f0b73-e92c-47a1-9b0b-4ab7b52892c5) We hope you found this article useful! The OxaPay plugin for Gravity Forms is a powerful tool that can help elevate your business to new heights. [PreviousRestrict Content Pro](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/wordpress/restrict-content-pro) [NextPayment](https://docs.oxapay.com/api-reference/payment) Last updated 1 month ago --- # Easy Digital Downloads | OxaPay Docs [](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/wordpress/easy-digital-downloads#what-is-easy-digital-downloads) What is Easy Digital Downloads? ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- Easy Digital Downloads (EDD) is a popular WordPress plugin designed for selling digital products like ebooks, software, and digital art. It provides an easy-to-use platform for managing downloads, payments, and customer data. [](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/wordpress/easy-digital-downloads#key-features-of-easy-digital-downloads) Key Features of Easy Digital Downloads: --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- 1. **Digital Product Management**: With the robust eCommerce platform that comes with a full-featured shopping cart, Easy Digital Downloads allows you to sell digital products with ease and manage your online store efficiently. With a user-friendly interface and a variety of customization options, Easy Digital Downloads is an excellent choice for anyone looking to sell digital goods online. 2. **Get paid effortlessly**: Provides flexible payment options, including support for popular payment gateways like OxaPay, PayPal, Stripe, and Google Pay, as well as subscriptions, giving customers a range of options to pay in a way that suits them. 3. **Intelligently designed:** The effects of site design on customer behavior are well-known. Easy Digital Downloads plays its role by including a base style that looks great as-is, but is also ready to integrate with any WordPress theme. 4. **Unlimited file downloads:** Easy Digital Downloads is a platform for selling digital products that does not impose any additional bandwidth charges on file downloads. This means that you can sell and distribute your digital products without worrying about any extra fees based on the amount of data transferred to customers. 5. **Automatic access control:** With Easy Digital Downloads, you can rest easy knowing that our secure file delivery system logs every customer interaction, giving you complete control over your business. [](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/wordpress/easy-digital-downloads#oxapay-plugin-for-easy-digital-downloads) OxaPay Plugin For Easy Digital Downloads ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ The OxaPay Plugin for Easy Digital Downloads (EDD) is a payment gateway integration that allows digital product sellers to accept payments through OxaPay, a cryptocurrency-based payment system. By integrating this plugin with EDD, store owners can offer their customers the option to pay using various cryptocurrencies, enhancing the flexibility of payment options and catering to a broader audience. The plugin seamlessly integrates into the EDD checkout process, ensuring a smooth and secure transaction experience without compromising usability or security. In addition to offering cryptocurrency payments, the OxaPay plugin provides features like real-time exchange rate conversions, detailed transaction tracking, and automatic payment confirmations, reducing manual tasks for store owners. This plugin is particularly beneficial for businesses looking to expand globally, as it eliminates issues related to traditional currency conversion fees or regional payment restrictions, making it easier to cater to an international customer base. [](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/wordpress/easy-digital-downloads#how-to-set-up-oxapay-plugin-for-easy-digital-downloads) How To Set Up OxaPay Plugin For Easy Digital Downloads? ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- 1. Log in to your WordPress control panel, navigate to the "Plugins" section, and click on "Add New". Select "Upload Plugin" then upload the "OxaPay" plugin ZIP file ([Click here to download it](https://downloads.wordpress.org/plugin/oxapay-payment-gateway-for-easy-digital-downloads.1.0.0.zip) ) and click on the"Install Now" button. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2Fcontent.gitbook.com%2Fcontent%2F0cdQgWk1yvwE7MR49PSn%2Fblobs%2FcgciCXC3Uep1tkGsZFQm%2FScreenshot%2520%281313%29.png&width=768&dpr=4&quality=100&sign=d623ab66&sv=2) 1. Once the plugin is installed, click on "Activate Plugin" to enable it. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2Fcontent.gitbook.com%2Fcontent%2F0cdQgWk1yvwE7MR49PSn%2Fblobs%2F0yf2yisB3KIFoWWW502t%2FPrestaShop-Logo.png&width=768&dpr=4&quality=100&sign=39531bee&sv=2) 1. Go to your "Easy Digital Downloads" settings and navigate to the Payment section. After activating the OxaPay plugin, in the top bar, you will see an option for OxaPay. Click on it to configure the payment gateway settings. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2Fcontent.gitbook.com%2Fcontent%2F0cdQgWk1yvwE7MR49PSn%2Fblobs%2FLdrNJSi57NOOoCSEoXki%2FScreenshot%2520%281316%29.png&width=768&dpr=4&quality=100&sign=951d7549&sv=2) 1. Enter your OxaPay Merchant API key (You can find this key in your OxaPay dashboard. If you don't have an API key, click here for instructions on how to create one). Complete any other fields. You can use the "sandbox" mode for testing. Once all the details are filled in, click "Save Changes" to finalize the setup. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2Fcontent.gitbook.com%2Fcontent%2F0cdQgWk1yvwE7MR49PSn%2Fblobs%2FQ3WPnKp4Jwzp0sE25eFe%2FScreenshot%2520%281317%29.png&width=768&dpr=4&quality=100&sign=30a62e03&sv=2) #### [](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/wordpress/easy-digital-downloads#you-can-download-the-oxapay-plugin-for-easy-digital-downloads-by-clicking-on-the-file-below) You can download the OxaPay plugin for Easy Digital Downloads by clicking on the file below: 120KB [oxapay-payment-gateway-for-easy-digital-downloads.1.0.0.zip](https://2150865118-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0cdQgWk1yvwE7MR49PSn%2Fuploads%2FUm480dzt9EA4QpF2aRg3%2Foxapay-payment-gateway-for-easy-digital-downloads.1.0.0.zip?alt=media&token=60ef1c4f-9f49-4f10-8d97-3a4af59f8943) archive Download[Open](https://2150865118-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0cdQgWk1yvwE7MR49PSn%2Fuploads%2FUm480dzt9EA4QpF2aRg3%2Foxapay-payment-gateway-for-easy-digital-downloads.1.0.0.zip?alt=media&token=60ef1c4f-9f49-4f10-8d97-3a4af59f8943) We hope this article was helpful! The OxaPay plugin for Easy Digital Downloads is a powerful and valuable tool that can help take your business to the next level. [PreviousWooCommerce](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/wordpress/woocommerce) [NextPaid Memberships Pro](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/wordpress/paid-memberships-pro) Last updated 1 month ago --- # Generate Invoice | OxaPay Docs This endpoint enables you to generate a new invoice and obtain a payment URL for completing the transaction. By providing the required parameters in your request, you can specify the invoice amount and customize various options for the payment process. post https://api.oxapay.com/v1/payment/invoice Header parameters merchant\_api\_keystringRequired Your Merchant API Key for authentication and authorization. Content-TypestringRequiredDefault: `application/json` Body application/json application/json amountnumber · decimalRequired The amount for the payment. If the currency field is not filled, the amount should be specified in dollars. If the `currency` field is filled, the amount should correspond to the specified currency. currencystringOptional Specify the currency symbol if you want the invoice amount calculated with a specific currency. You can also generate invoices in fiat currencies. lifetimeinteger · min: 15 · max: 2880Optional Set the expiration time for the payment link in minutes. Default: `60` fee\_paid\_by\_payernumber · decimal · max: 1Optional Specify whether the payer will cover the invoice commission. 1 indicates that the payer will pay the fee, while 0 indicates that the merchant will pay the fee. Default: `Merchant setting`Example: `1` under\_paid\_coveragenumber · decimal · max: 60Optional Specify the acceptable inaccuracy in payment. Determines the maximum acceptable difference between the requested and paid amount. Default: `Merchant setting`Example: `10` to\_currencystringOptional The currency symbol of the cryptocurrency you want to convert to. You can only convert paid crypto currencies to USDT. auto\_withdrawalbooleanOptional 1 indicates that the received currency will be sent to the address specified in your Address List on the Settings page and 0 indicates that the amount will be credited to your OxaPay balance. mixed\_paymentbooleanOptional Specify whether the payer can cover the remaining amount with another currency if they pay less than the invoice amount. 1 allows the user to pay the remainder with a different coin, while 0 doesn't allow it. Default: `Merchant setting`Example: `true` callback\_urlstringOptional The URL where payment information will be sent. Use this to receive notifications about the payment status. return\_urlstringOptional The URL where the payer will be redirected after a successful payment. emailstringOptional Provide the payer's email address for reporting purposes. order\_idstringOptional Specify a unique order ID for reference in your system. thanks\_messagestringOptional A thanks message that brief note displayed to the payer after a successful payment. descriptionstringOptional Provide order details or any additional information that will be shown in different reports. sandboxbooleanOptional The sandbox field is a boolean that specifies whether the API request should operate in sandbox mode (test environment). Set it to true for testing and false for live transactions. Responses 200 Successful operation application/json Responseobject Show properties 400 Bad request application/json post /payment/invoice Python PythoncURLPHPNode.js Copy import requests import json url = 'https://api.oxapay.com/v1/payment/invoice' headers = { 'merchant_api_key': 'YOUR_MERCHANT_API_KEY', 'Content-Type': 'application/json' } data = { "amount": 100, "currency": "USD", "lifetime": 30, "fee_paid_by_payer": 1, "under_paid_coverage": 2.5, "to_currency": "USDT", "auto_withdrawal": False, "mixed_payment": True, "callback_url": "https://example.com/callback", "return_url": "https://example.com/success", "email": "[email protected]", "order_id": "ORD-12345", "thanks_message": "Thanks message", "description": "Order #12345", "sandbox": False } response = requests.post(url, data=json.dumps(data), headers=headers) result = response.json() print(result) Test it 200 Successful operation Copy { "data": { "track_id": "184747701", "payment_url": "http://pay.oxapay.com/12373985/184747701", "expired_at": 1734546589, "date": 1734510589 }, "message": "Operation completed successfully!", "error": {}, "status": 200, "version": "1.0.0" } [PreviousPayment](https://docs.oxapay.com/api-reference/payment) [NextGenerate White Label](https://docs.oxapay.com/api-reference/payment/generate-white-label) Last updated 4 months ago --- # Payment Information | OxaPay Docs Utilize the Payment Information endpoint to retrieve detailed information about a specific payment using its `track_id`. After generating an invoice, you will receive a `track_id`, which serves as a reference for requesting payment details. get https://api.oxapay.com/v1/payment/{track\_id} Path parameters track\_idstringRequired Unique identifier for the payment session. Header parameters merchant\_api\_keystringRequired Your Merchant API Key for authentication and authorization. Content-TypestringRequiredDefault: `application/json` Responses 200 Successful operation application/json Responseobject Show properties 400 Bad request application/json get /payment/{track\_id} Python PythoncURLPHPNode.js Copy import requests import json track_id = 'TRACK_ID' url = f'https://api.oxapay.com/v1/payment/{track_id}' headers = { 'merchant_api_key': 'YOUR_MERCHANT_API_KEY', 'Content-Type': 'application/json' } response = requests.get(url, headers=headers) result = response.json() print(result) Test it 200 Successful operation Copy { "data": { "track_id": "168931368", "type": "invoice", "amount": 15, "currency": "USD", "status": "paid", "mixed_payment": false, "fee_paid_by_payer": 0, "under_paid_coverage": 21.5, "lifetime": 60, "callback_url": "https://example.com/callback", "return_url": "https://example.com/success", "email": "[email protected]", "order_id": "ORD-12345", "description": "Order #12345", "thanks_message": "Thanks Message", "expired_at": 1728121075, "date": 1728117475, "txs": [\ {\ "tx_hash": "0x2DehmnxMDFMhS3KHXCPpGSx41NeLBjH34q5vjN1oGbUDFFAMC9rG3",\ "amount": 0.00613418,\ "currency": "ETH",\ "network": "Ethereum Network",\ "address": "HEHCVjnxD8cQrFwfo4k9WXJXErpmK9Ym1nRaEiJJ8DP4",\ "status": "confirmed",\ "confirmations": 11,\ "auto_convert": {\ "processed": true,\ "amount": 14.73130872,\ "currency": "USDT"\ },\ "auto_withdrawal": {\ "processed": false\ },\ "date": 1728117736\ }\ ] }, "message": "Operation completed successfully!", "error": {}, "status": 200, "version": "1.0.0" } [PreviousStatic Address List](https://docs.oxapay.com/api-reference/payment/static-address-list) [NextPayment History](https://docs.oxapay.com/api-reference/payment/payment-history) Last updated 4 months ago --- # Accepted Currencies | OxaPay Docs The endpoint retrieves the list of cryptocurrencies available for payment processing through OxaPay. These currencies are configured by you on the "Merchant Service" page of your account, specifying the cryptocurrencies your business accepts for payments. get https://api.oxapay.com/v1/payment/accepted-currencies Header parameters merchant\_api\_keystringRequired Your Merchant API Key for authentication and authorization. Content-TypestringRequiredDefault: `application/json` Responses 200 Successful operation application/json Responseobject Show properties 400 Bad request application/json get /payment/accepted-currencies Python PythoncURLPHPNode.js Copy import requests import json url = 'https://api.oxapay.com/v1/payment/accepted-currencies' headers = { 'merchant_api_key': 'YOUR_MERCHANT_API_KEY', 'Content-Type': 'application/json' } response = requests.get(url, headers=headers) result = response.json() print(result) Test it 200 Successful operation Copy { "data": { "list": [\ "BTC",\ "ETH",\ "USDT",\ "USDC",\ "BNB",\ "DOGE"\ ] }, "message": "Operation completed successfully!", "error": {}, "status": 200, "version": "1.0.0" } [PreviousPayment History](https://docs.oxapay.com/api-reference/payment/payment-history) [NextPayment Status Table](https://docs.oxapay.com/api-reference/payment/payment-status-table) Last updated 4 months ago --- # Swap History | OxaPay Docs This endpoint allows you to retrieve a list of swap transactions based on your General API Key. You can filter the results by various criteria, including time range, currency, and swap type (e.g., auto\_convert, manual\_swap, or swap\_by\_api). Pagination support lets you fetch the results in smaller, manageable sets for better control and efficiency. get https://api.oxapay.com/v1/general/swap Query parameters track\_idintegerOptional Filter spesific exchange by it\`s trackId. typestring · enumOptional Filter exchanges based on type. Possible values: `autoConvert``manualSwap``swapByApi` from\_currencystringOptional Specify the currency symbol for filtering exchanges in a specific fromCurrency. to\_currencystringOptional Specify the currency symbol for filtering exchanges in a specific toCurrency. from\_dateintegerOptional The start of the date window to query for exchanges in unix format. to\_dateintegerOptional The start of the date window to query for exchanges in unix format. sort\_bystring · enumOptional Sort the received list by a parameter. Default: `create_date`Possible values: `create_date``amount` sort\_typestring · enumOptional Display the list in ascending or descending order. Default: `desc`Possible values: `asc``desc` sizeinteger · min: 1 · max: 200Optional Number of records to be displayed on one page. Default: `10` pageinteger · min: 1Optional The page number of the results you want to retrieve. Default: `1` Header parameters general\_api\_keystringRequired Your General API Key for authentication and authorization. Content-TypestringRequiredDefault: `application/json` Responses 200 Successful operation application/json 400 Bad request application/json get /general/swap Python PythoncURLPHPNode.js Copy import requests url = 'https://api.oxapay.com/v1/general/swap/' params = { 'size': 20, 'page': 1 } headers = { 'general_api_key': 'YOUR_GENERAL_API_KEY', 'Content-Type': 'application/json' } response = requests.get(url, params=params, headers=headers) result = response.json() print(result) Test it 200 Successful operation Copy { "data": { "list": [\ {\ "track_id": "393831199",\ "from_currency": "USDT",\ "to_currency": "BTC",\ "from_amount": 10,\ "to_amount": 0.0001054,\ "rate": 94876.66034156,\ "date": 1736508792\ },\ {\ "track_id": "315890329",\ "from_currency": "USDT",\ "to_currency": "BTC",\ "from_amount": 1,\ "to_amount": 0.00001052,\ "rate": 95057.03422053,\ "date": 1736503906\ }\ ], "meta": { "page": 1, "last_page": 1, "total": 10 } }, "message": "Operation completed successfully!", "error": {}, "status": 200, "version": "1.0.0" } [PreviousSwap Request](https://docs.oxapay.com/api-reference/swap/swap-request) [NextSwap Pairs](https://docs.oxapay.com/api-reference/swap/swap-pairs) Last updated 4 months ago --- # Common | OxaPay Docs To access and use the APIs in the common section, no authentication key or token is required. Simply call the desired API endpoint directly, and you will receive a response based on the parameters or requests you provide. This makes the common APIs straightforward and easy to integrate, enabling you to quickly test their functionality and incorporate them into your application without worrying about additional authentication steps. Remember to examine the response structure carefully to ensure seamless integration with your application logic. [PreviousSwap Rate](https://docs.oxapay.com/api-reference/swap/swap-rate) [NextAccount Balance](https://docs.oxapay.com/api-reference/common/account-balance) Last updated 11 months ago --- # Restrict Content Pro | OxaPay Docs [](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/wordpress/restrict-content-pro#what-is-restrict-content-pro) What is Restrict Content Pro? ----------------------------------------------------------------------------------------------------------------------------------------------------------------- Restrict Content Pro is a powerful WordPress membership plugin that allows you to monetize content access. As a content restriction plugin, Restrict Content gives you full control over who can and cannot view content on your WordPress site. As a design tool, Restrict Content helps you create pages that dynamically display content based on user role or membership level. ### [](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/wordpress/restrict-content-pro#key-features-of-restrict-content-pro) Key Features of Restrict Content Pro: 1. **Membership Levels:** Set access level, duration (in days, months, years), number of renewals, price, signup fee, status, assign WordPress user role. Set any price (including free) or optionally set a sign up fee. Set the frequency and period, and specify a user role that will be assigned to members when they register. 2. **Auto-Created Member Pages:** Pages generated by the plugin include: Registration, Success, Account, Edit Profile and Update Billing Card. 3. **Auto Renewals:** Select to let customer choose whether to auto renew, always auto renew, or never auto renew. 4. **Payment Gateways:** The system supports various payment gateways including OxaPay, PayPal, Authorize.net, Braintree, and Manual Payments. This ensures secure and diverse options for processing transactions. 5. **Member Emails:** Paid membership activation email, free membership activation email, cancelled membership email, expired membership email, payment received email, renewal payment failed email 6. **Upgrade/Downgrade Membership:** Members can easily upgrade or downgrade their subscription at any time. This ensures they have control over their plan. [](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/wordpress/restrict-content-pro#oxapay-plugin-for-restrict-content-pro) OxaPay Plugin For Restrict Content Pro ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ Integrating OxaPay with Restrict Content is an excellent way to modernize your payment system and expand your reach. This integration allows businesses to effortlessly accept cryptocurrency payments for membership plans and flexible payment solution. OxaPay ensures that all transactions are handled with top-tier security, providing a safe and reliable payment experience for both businesses and customers. By enabling cryptocurrency payments in Restrict Content, you can attract a audience, simplify payment management, and enhance the overall experience for your members. [](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/wordpress/restrict-content-pro#how-to-set-up-oxapay-plugin-for-restrict-content-pro) How To Set Up OxaPay Plugin For Restrict Content Pro? ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- 1. Log in to your WordPress control panel, navigate to the "Plugins" section, and click on "Add New". Select "Upload Plugin" then upload the "OxaPay" plugin ZIP file ([Click here to download it](https://github.com/OxaPay/oxapay-restrict-content/archive/refs/tags/v1.0.0.zip) ) and click on the"Install Now" button. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F2150865118-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F0cdQgWk1yvwE7MR49PSn%252Fuploads%252FxJ9Ce9J9EwgtCqG0Rhdw%252F1.png%3Falt%3Dmedia%26token%3Ddb3c1697-dee0-42c9-8a31-2b102a45379a&width=768&dpr=4&quality=100&sign=f1a55303&sv=2) 1. After installing and activating the Oxapay plugin, go to the "**Restrict Content"** settings page and click on Payments to enter your OxaPay Merchant API key (You can find this key in your OxaPay dashboard. If you don't have an API key, [click here](https://docs.oxapay.com/integrations/merchant-api) for instructions on how to create one). Complete any other fields. You can use the "sandbox" mode for testing. Once all the details are filled in, click "Save Settings" to finalize the setup. (Make sure to check OxaPay in the "Enabled Gateways" section) ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F2150865118-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F0cdQgWk1yvwE7MR49PSn%252Fuploads%252FxV4Y4c4eYukk7rJOaPtN%252F2.png%3Falt%3Dmedia%26token%3Dfab983a1-eac4-404e-a661-bd083bd29497&width=768&dpr=4&quality=100&sign=225ed4fe&sv=2) **You can download the OxaPay plugin for Restrict Content Pro by clicking on the file below:** 10KB [oxapay-crypto-payment-gateway-for-restrict-content.zip](https://2150865118-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0cdQgWk1yvwE7MR49PSn%2Fuploads%2FkCYZMZevxoMv0BtkWwsl%2Foxapay-crypto-payment-gateway-for-restrict-content.zip?alt=media&token=2e77365e-5d97-48b4-b201-7a53f28c6073) archive Download[Open](https://2150865118-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0cdQgWk1yvwE7MR49PSn%2Fuploads%2FkCYZMZevxoMv0BtkWwsl%2Foxapay-crypto-payment-gateway-for-restrict-content.zip?alt=media&token=2e77365e-5d97-48b4-b201-7a53f28c6073) We hope you found this article useful! The OxaPay plugin for Restrict Content is a powerful tool that can help elevate your business to new heights. [PreviousPaid Memberships Pro](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/wordpress/paid-memberships-pro) [NextGravity Forms](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/wordpress/gravity-forms) Last updated 1 month ago --- # Swap | OxaPay Docs If your business requires a service to seamlessly exchange cryptocurrency assets through an API, the Swap Service is the perfect solution. It enables you to integrate crypto swapping functionality directly into your platform or application, allowing you to automate and simplify asset exchanges. With this service, you can efficiently convert one cryptocurrency to another without relying on external platforms, providing flexibility and convenience. #### [](https://docs.oxapay.com/api-reference/swap#to-process-swap-youll-need-a-general-api-key.-follow-these-steps-to-generate-it) To process swap, you'll need a General API key. Follow these steps to generate it: 1. Log in to your OxaPay account. 2. Navigate to the Account Settings page. 3. Fill in the form then click on the "Generate General API Key" button. #### [](https://docs.oxapay.com/api-reference/swap#watch-the-video-below-for-a-step-by-step-walkthrough-of-the-process) Watch the video below for a step-by-step walkthrough of the process: You can swap your crypto assets with the guidance provided in the [Swap Request](https://docs.oxapay.com/api-reference/swap/swap-request2) in the API references. [PreviousPayout Status Table](https://docs.oxapay.com/api-reference/payout/payout-status-table) [NextSwap Request](https://docs.oxapay.com/api-reference/swap/swap-request) Last updated 4 months ago --- # System Status | OxaPay Docs This endpoint allows you to check the current status of the OxaPay API, ensuring it is functioning correctly. get https://api.oxapay.com/v1/common/monitor Responses 200 Successful operation application/json Responseobject Show properties get /common/monitor Python PythoncURLPHPNode.js Copy import requests url = 'https://api.oxapay.com/v1/common/monitor' response = requests.get(url) result = response.json() print(result) Test it 200 Successful operation Copy { "data": { "status": true }, "message": "Operation completed successfully!", "error": {}, "status": 200, "version": "1.0.0" } [PreviousSupported Networks](https://docs.oxapay.com/api-reference/common/supported-networks) [NextError](https://docs.oxapay.com/api-reference/error) Last updated 3 months ago --- # Payout | OxaPay Docs If your business needs to make cryptocurrency payments to your users, the payout service is the ideal solution. With this service, you can easily send payments directly from your OxaPay balances, streamlining the process and ensuring efficiency. It’s a secure and convenient way to manage payouts, allowing you to handle user transactions smoothly without relying on external wallets or platforms. This feature is designed to save time, enhance reliability, and cater to businesses with frequent payout needs. #### [](https://docs.oxapay.com/api-reference/payout#to-process-payouts-youll-need-a-payout-api-key.-follow-these-steps-to-generate-it) To process payouts, you'll need a Payout API key. Follow these steps to generate it: 1. Log in to your OxaPay account. 2. Navigate to the Payout Service page. 3. Fill in the form then click on the "Generate Payout API Key" button. #### [](https://docs.oxapay.com/api-reference/payout#watch-the-video-below-for-a-step-by-step-walkthrough-of-the-process) Watch the video below for a step-by-step walkthrough of the process: You can create your own payout with the guidance provided in the [Generate Payout](https://docs.oxapay.com/api-reference/creating-payout) in the API references. [PreviousPayment Status Table](https://docs.oxapay.com/api-reference/payment/payment-status-table) [NextGenerate Payout](https://docs.oxapay.com/api-reference/payout/generate-payout) Last updated 4 months ago --- # Supported Networks | OxaPay Docs This endpoint allows you to retrieve a list of blockchain networks supported by OxaPay for cryptocurrency transactions. get https://api.oxapay.com/v1/common/networks Responses 200 Successful operation application/json Responseobject Show properties get /common/networks Python PythoncURLPHPNode.js Copy import requests url = 'https://api.oxapay.com/v1/common/networks' response = requests.get(url) result = response.json() print(result) Test it 200 Successful operation Copy { "data": { "list": [\ "Bitcoin Network",\ "Ethereum Network",\ "Tron Network",\ "Binance Smart Chain",\ "Dogecoin Network",\ "Solana Network",\ "Polygon Network",\ "Litecoin Network",\ "DigiByte Network",\ "Monero Network",\ "TON Network",\ "Bitcoin Cash Network",\ "Base"\ ] }, "message": "Operation completed successfully!", "error": {}, "status": 200, "version": "1.0.0" } [PreviousSupported Fiat Currencies](https://docs.oxapay.com/api-reference/common/supported-fiat-currencies) [NextSystem Status](https://docs.oxapay.com/api-reference/common/system-status) Last updated 4 months ago --- # Payment Status Table | OxaPay Docs These are the possible payment statuses you may encounter while using the OxaPay Merchant Service. Each status indicates the progress of the payment process, helping you track and manage payments effectively. Status Description new A newly created invoice. The payer has not selected the payment currency yet. waiting The payer has selected the payment currency. Awaiting payment. paying The payer is attempting to complete the invoice payment. paid The invoice has been fully paid. manual\_accept The invoice was manually accepted by you, and the corresponding amount has been charged to your balance. underpaid The payer made a partial payment, but the invoice is not fully paid. refunding A refund request has been initiated, and the paid amount is in the process of being returned to the payer. refunded The payment has been successfully refunded to the payer. expired The payer did not pay the invoice within the required time frame. [PreviousAccepted Currencies](https://docs.oxapay.com/api-reference/payment/accepted-currencies) [NextPayout](https://docs.oxapay.com/api-reference/payout) Last updated 2 months ago --- # Merchant and Payout Service with API | Legacy | OxaPay Docs OxaPay offers a comprehensive Merchant and Payout Service API that empowers merchants to access and manage their payment and payout activities programmatically. With this API integration, merchants can seamlessly create and manage payment links, process transactions, retrieve payment information, and initiate cryptocurrency payouts to recipients. The Merchant API provides an easy-to-use interface for developers to integrate OxaPay's cryptocurrency payment gateway into their web and mobile applications. It allows businesses to offer cryptocurrency payments as a sole payment option, catering to the growing demand for crypto payments for digital currency transactions. By utilizing the Payout API, businesses can efficiently initiate cryptocurrency payouts to multiple recipients simultaneously, simplifying processes like affiliate payments, vendor payouts, and more. The API offers robust security measures, ensuring that all transactions are processed securely and efficiently. Please refer to the API Reference section for detailed information on the endpoints, request and response formats, and example code snippets for integrating the Merchant and Payout Service API into your applications. [PreviousOpenCart](https://docs.oxapay.com/legacy/integrations/plugins/opencart) [NextAPI Reference](https://docs.oxapay.com/legacy/api-reference) Last updated 2 months ago --- # Webhook | OxaPay Docs Merchants can set up a `callback_url` in their merchant requests, and upon processing payments, OxaPay will send you notifications in JSON format—including the amount and status—when the payment status changes to paying or paid. To receive Webhook notifications, first, you should implement a standard HTTP POST (application/json) call over an HTTPS URL to a CGI script on your server. Insert your created endpoint address in the `callback_url` field of merchant requests. You will receive payment updates (statuses) to this URL address. However, you will initially receive a callback with the "paying" status. You should wait for a second callback where the "status" value will be "paid". When we confirm the transaction, we are ready to manage all the risks concerning accepting real funds later. You should not be concerned about it. Merchant's `callback_url` must return an HTTP 200 response with content "ok" for the OxaPay API to consider the callback successful. The system will try to deliver a Webhook notification up to 5 times or until a successful delivery occurs, whichever happens first. If the first attempt fails, the second one is triggered after approximately 1 minute. The third one is delayed for 3 more minutes, the fourth for 30 minutes, and the last one for 3 hours. The payout Webhook is similar to the merchant Webhook. However, for withdrawals, you will receive different values for the “address” parameter in each callback. [](https://docs.oxapay.com/webhook#validating-callbacks) Validating Callbacks ---------------------------------------------------------------------------------- Merchants must validate the signature of callbacks coming from OxaPay using their `MERCHANT_API_KEY` to prevent fraudulent activity. Also for payout Webhooks you must validate the signature using your `PAYOUT_API_KEY`. OxaPay uses your `MERCHANT_API_KEY` as the HMAC shared secret key to generate an HMAC (sha512) signature of the raw POST data. The HMAC signature is sent as an HTTP header called HMAC. The body of the request contains the callback data in JSON format, similar to the Payment Information API response body. [](https://docs.oxapay.com/webhook#testing-webhook) Testing Webhook ------------------------------------------------------------------------ For payment callback handling, you can use tools like [requestcatcher.com](https://requestcatcher.com/) or [webhook.site](https://webhook.site/) to create a test `callback_url` and inspect the callback data sent from OxaPay. Note that OxaPay payment callbacks will not be sent to private networks (e.g., localhost). For local debugging, you can use services like [ngrok.io](https://ngrok.io/) to expose your local server to the internet and receive webhook callbacks. **To utilize the payment webhook, please follow these steps:** 1\. Create a web server and define an endpoint to handle POST requests. \- Ensure that the firewall software on your server (e.g., Cloudflare) allows incoming requests from OxaPay. You may need to whitelist OxaPay's IP addresses on your side. Please reach out to [\[email protected\]](https://docs.oxapay.com/cdn-cgi/l/email-protection) to obtain the list of IP addresses. 2\. Configure your server to receive POST requests at the specified endpoint URL. \- The POST request body will contain the necessary parameters sent by OxaPay in JSON format. 3\. Validate the HMAC signature of the request to ensure the authenticity of the callback. \- Use your API\_SECRET\_KEY to calculate the HMAC signature and compare it with the received HMAC header. 4\. Process the callback data accordingly based on the status and other parameters provided. [](https://docs.oxapay.com/webhook#sample-payment-ipn-data) Sample Payment IPN data ---------------------------------------------------------------------------------------- In this section, we will provide examples of the data OxaPay send to your system at various stages of the payment process. ### [](https://docs.oxapay.com/webhook#the-input-transaction-types-are) The input transaction types are: * invoice * white\_label * static\_address * payment\_link * donation Copy // Paying IPN // Payer transferred the payment for the invoice. Awaiting blockchain network confirmation. { "track_id":"151811887", string "status":"Paying", string "type":"invoice", string "module_name":"OxaPay", string "amount":10, decimal "value":3.6839, decimal "sent_value": 3.6839, decimal "currency":"POL", string "order_id":"ORD-12345", string "email":"[email protected]", string "note":"", string "fee_paid_by_payer":0, boolean "under_paid_coverage":0, decimal "description":"Test Description", string "date":1738493900, integer "txs":[{\ "status":"confirming", string\ "tx_hash":"x", string\ "sent_amount":10, decimal\ "received_amount":9.85, decimal\ "value":3.6839, decimal\ "sent_value": 3.6839, decimal\ "currency":"POL", string\ "network":"Polygon Network", string\ "sender_address": "x", string\ "address":"x", string\ "rate":0.36839, decimal\ "confirmations":10, integer\ "auto_convert_amount":0, decimal\ "auto_convert_currency":"USDT", string\ "date":1738494035 integer\ }] } Copy // Paid IPN // Payment is confirmed by the network and has been credited to the merchant. Purchased goods/services can be safely delivered to the payer. { "track_id":"151811887", string "status":"Paid", string "type":"invoice", string "module_name":"OxaPay", string "amount":10, decimal "value":3.6839, decimal "sent_value": 3.6839, decimal "currency":"POL", string "order_id":"ORD-12345", string "email":"[email protected]", string "note":"", string "fee_paid_by_payer":0, boolean "under_paid_coverage":0, decimal "description":"Test Description", string "date":1738493900, integer "txs":[{\ "status":"confirmed", string\ "tx_hash":"x", string\ "sent_amount":10, decimal\ "received_amount":9.85, decimal\ "value":3.6839, decimal\ "sent_value": 3.6839, decimal\ "currency":"POL", string\ "network":"Polygon Network", string\ "sender_address": "x", string\ "address":"x", string\ "rate":0.36839, decimal\ "confirmations":250, integer\ "auto_convert_amount":3.62864, decimal\ "auto_convert_currency":"USDT", string\ "date":1738494035 integer\ }] } [](https://docs.oxapay.com/webhook#sample-payout-ipn-data) Sample Payout IPN data -------------------------------------------------------------------------------------- In this section, we will provide examples of the data OxaPay send to your system at various stages of the payout process. ### [](https://docs.oxapay.com/webhook#the-output-transaction-types-are) The output transaction types are: * payout Copy // Confirming IPN // You payout request sent and awaiting blockchain network confirmation. { "track_id":"227296189", string "status":"Confirming", string "type":"payout", string "tx_hash":"x", string "address":"x", string "amount":10.0, decimal "value":4.01, decimal "currency":"POL", string "network":"Polygon Network", string "description":"Order #12345", string "date":1738492316 integer } Copy // Confirmed IPN // Payout is confirmed by the network. { "track_id":"227296189", string "status":"Confirmed", string "type":"payout", string "tx_hash":"x", string "address":"x", string "amount":10.0, decimal "value":4.01, decimal "currency":"POL", string "network":"Polygon Network", string "description":"Order #12345", string "date":1738492316 integer } Copy // Failed IPN // Payout is Failed. { "track_id":"227652478", string "status":"Failed", string "type":"payout", string "tx_hash":"", string "address":"x", string "amount":10.0, decimal "value":4.01, decimal "currency":"POL", string "network":"Polygon Network", string "description":"Order #12345", string "date":1738492316 integer } > Even if your request cannot be processed for any reason, we will still send the webhook payload. [](https://docs.oxapay.com/webhook#example-codes) Example codes -------------------------------------------------------------------- PHP Node.js Python Copy Copy const http = require('http'); const crypto = require('crypto'); const server = http.createServer((req, res) => { if (req.url === '/callback' && req.method === 'POST') { // Validate HMAC signature let postData = ''; req.on('data', chunk => { postData += chunk; }); req.on('end', () => { // Parse the JSON data let data = null; try { data = JSON.parse(postData); } catch (error) { res.statusCode = 400; res.end('Invalid JSON data'); return; } const apiSecretKey = (data.type === 'payment') ? 'YOUR_MERCHANT_API_KEY' : 'YOUR_PAYOUT_API_KEY'; const hmacHeader = req.headers['hmac']; const calculatedHmac = crypto .createHmac('sha512', apiSecretKey) .update(postData) .digest('hex'); if (calculatedHmac === hmacHeader) { // HMAC signature is valid // Process the callback data based on the type if (data.type === 'invoice') { console.log('Received payment callback:', data); // Process payment data here } else if (data.type === 'payout') { console.log('Received payout callback:', data); // Process payout data here } // Return HTTP Response 200 with content "OK" res.statusCode = 200; res.end('OK'); } else { // HMAC signature is not valid // Handle the error accordingly res.statusCode = 400; res.end('Invalid HMAC signature'); } }); } else { // Invalid path or method res.statusCode = 404; res.end('Not Found'); } }); server.listen(3000, () => { console.log('Server listening on port 3000'); }); Copy from flask import Flask, request import hmac import hashlib import json app = Flask(__name__) @app.route('/callback', methods=['POST']) def handle_callback(): post_data = request.get_data(as_text=True) data = json.loads(post_data) # Validate HMAC signature if data['type'] == 'payment': api_secret_key = 'YOUR_MERCHANT_API_KEY' elif data['type'] == 'payout': api_secret_key = 'YOUR_PAYOUT_API_KEY' else: return 'Invalid data.type', 400 hmac_header = request.headers.get('HMAC') post_data = request.get_data() calculated_hmac = hmac.new(api_secret_key.encode(), post_data, hashlib.sha512).hexdigest() if calculated_hmac == hmac_header: # HMAC signature is valid # Process the callback data if data['type'] == 'invoice': print('Received payment callback:', data) # Process payment data here elif data['type'] == 'payout': print('Received payout callback:', data) # Process payout data here # Return HTTP Response 200 with content "OK" return 'OK', 200 else: # HMAC signature is not valid # Handle the error accordingly return 'Invalid HMAC signature', 400 if __name__ == '__main__': app.run(host='YOUR_HOST_ADDRESS',port=3000) Again, please note that these code snippets serve as examples and may require modifications based on your specific implementation and framework. [PreviousError](https://docs.oxapay.com/api-reference/error) [NextUse Cases](https://docs.oxapay.com/use-cases) Last updated 2 months ago --- # Use Cases | OxaPay Docs [](https://docs.oxapay.com/use-cases#e-commerce-flow) E-commerce Flow -------------------------------------------------------------------------- In an e-commerce scenario, merchants can leverage OxaPay's cryptocurrency payment gateway to offer customers the option to make purchases using various cryptocurrencies. The flow for this use case is as follows: 1\. The payer selects item/items for purchase, determining the total sum. 2\. The payer selects the preferred payment currency. 3\. The merchant generates a payment link using the OxaPay API's "Create an Invoice" endpoint. This endpoint allows the merchant to create a payment link with all the necessary payment details, such as the payment amount, currency, and other optional parameters like expiration time, fee\_paid\_by\_payer, and under\_paid\_coverage. 4\. The API generates a unique payment link for the payer, containing the payment details. 5\. The payer receives the payment link and can click on it to proceed with the payment. Alternatively, the merchant can display the payment link on their website or send it via email or any other communication channel. 6\. When the payer clicks on the payment link, they are redirected to OxaPay's payment gateway to complete the payment. 7\. OxaPay's payment gateway displays the payment details and prompts the payer to select their desired cryptocurrency and network. 8\. After selecting the payment currency and network, OxaPay's payment gateway generates a specific payment address for the payer to send the cryptocurrency. 9\. The payer's crypto wallet application opens with the specified payment address pre-filled. 10\. The payer initiates the payment by sending the required cryptocurrency to the generated payment address. 11\. OxaPay's system monitors the transaction and updates the payment status in real-time. 12\. After a successful payment, the payer receives a payment confirmation alert on the page. 13\. The payer can then click on the "Return to Website" button to redirect to the merchant's specified return\_url (if provided). 14\. The merchant's system receives a callback with payment information, such as transaction status, currency, amount, and fees. 15\. The merchant updates the order status and processes the purchase, allowing the payer to access their purchased goods or services. 16\. The merchant can access detailed payment-related information in their OxaPay accounts, providing transparency and easy management. [](https://docs.oxapay.com/use-cases#e-commerce-with-seamless-payment-flow) E-commerce with Seamless Payment Flow ---------------------------------------------------------------------------------------------------------------------- In an e-commerce scenario, merchants can leverage OxaPay's payment link feature to create a seamless payment experience for their customers. The flow for this use case, which includes the creation of a payment link, is as follows: 1\. The payer selects item/items for purchase, determining the total sum. 2\. The payer selects the preferred payment currency. 3\. The system retrieves the exchange rate for the selected currency and estimates the total amount in cryptocurrency. 4\. The merchant calls the "Create white-label" method to generate a payment link and obtain the payment address (e.g., a BTC wallet address for BTC payments). 5\. The payer is provided with the payment address and can initiate the payment by sending the required cryptocurrency to the given address. 6\. The payer can scan the QR code or manually copy the address and proceed with the payment using their preferred crypto wallet application. 7\. When the payer sends the cryptocurrency to the payment address, OxaPay's system receives a callback containing payment information, such as transaction status, currency, amount, and fees. 8\. The merchant's system updates the payment status based on the callback information, completing the purchase process. 9\. The merchant can access all payment-related information in their OxaPay accounts, ensuring transparency and easy management. [](https://docs.oxapay.com/use-cases#investment-flow) Investment Flow -------------------------------------------------------------------------- For investment platforms or websites, OxaPay offers a seamless crypto deposit and balance management flow. The steps for this use case are as follows: 1\. The user has a crypto balance on the website. 2\. The user selects the desired payment currency for making a deposit. 3\. The merchant calls the "Create static address" method to generate a permanent deposit address for the selected currency. 4\. The website displays the deposit address (e.g., BTC address) to the user, who can initiate the deposit by sending the cryptocurrency to the provided address. 5\. The user can scan the QR code or manually copy the address and proceed with the deposit using their crypto wallet application. 6\. After the user sends the cryptocurrency to the deposit address, OxaPay's system receives a callback containing deposit information, such as transaction status, currency, amount, and fees. 7\. The merchant updates the user's crypto balance based on the callback information, reflecting the deposited amount in the user's account. 8\. All relevant information about the deposit and user's balance is accessible in the merchant's OxaPay account. [](https://docs.oxapay.com/use-cases#withdrawal-flow) Withdrawal Flow -------------------------------------------------------------------------- In scenarios where users want to withdraw funds from their crypto balance on a website or platform, OxaPay simplifies the withdrawal process. The steps are as follows: 1\. The merchant has a crypto balance in their OxaPay account, which includes user funds. 2\. A user requests a withdrawal from their balance on the website. 3\. The merchant uses the OxaPay API's "/api/send" method to initiate a payout, providing the user's desired withdrawal address and amount. 4\. OxaPay's system sends the funds to the user's provided crypto address. 5\. After processing the payout, the merchant's system receives a callback containing transaction parameters, such as transaction status, currency, amount, and fees. 6\. The merchant updates the user's crypto balance, deducting the withdrawn amount from the user's account. 7\. The merchant can access comprehensive information about the transaction and balance in their OxaPay accounts, ensuring transparency and easy tracking. [](https://docs.oxapay.com/use-cases#global-freelance-marketplace) Global Freelance Marketplace ---------------------------------------------------------------------------------------------------- 1\. A global freelance marketplace connects freelancers and clients from around the world for various projects and services. 2\. To facilitate secure and efficient cross-border payments, the freelance marketplace integrates OxaPay's payment gateway. 3\. When a client hires a freelancer and agrees on a project's terms, they proceed to make a payment for the services rendered. 4\. The client selects their preferred cryptocurrency and network for payment on the freelance marketplace's payment page. 5\. OxaPay's payment gateway calculates the total amount in the selected cryptocurrency based on the current exchange rate. 6\. The client is redirected to OxaPay's payment gateway to complete the transaction. 7\. OxaPay's payment gateway generates a specific payment address for the client to send the cryptocurrency. 8\. The client's crypto wallet application opens with the payment address pre-filled. 9\. The client initiates the payment by sending the required cryptocurrency to the generated payment address. 10\. OxaPay's system monitors the transaction and updates the payment status in real-time. 11\. After a successful payment, the freelancer is notified of the payment and can proceed with the project. 12\. The freelancer delivers the completed project to the client through the freelance marketplace's platform. 13\. The client reviews and approves the project's completion. 14\. Upon approval, the freelance marketplace receives a callback from OxaPay's payment gateway with payment information, such as transaction status, currency, amount, and fees. 15\. The freelance marketplace releases the payment to the freelancer's account on the platform. 16\. The freelancer can access their earnings and withdraw funds to their crypto wallet at any time. 17\. The freelancer can view detailed payment-related information in their OxaPay accounts for transparency and financial tracking. By integrating OxaPay's payment gateway, the freelance marketplace streamlines global payments for freelancers and clients, enabling them to transact in various cryptocurrencies securely and conveniently. The ability to select payment currency and network provides clients with flexibility in cross-border transactions, while real-time payment status updates ensure transparency and efficiency. Additionally, OxaPay's comprehensive payment information and management features enable the freelance marketplace to enhance financial tracking and provide a seamless payment experience for both clients and freelancers. [](https://docs.oxapay.com/use-cases#online-gaming-platform-with-in-game-purchases) Online Gaming Platform with In-Game Purchases: --------------------------------------------------------------------------------------------------------------------------------------- 1\. Players on an online gaming platform want to make in-game purchases to enhance their gaming experience. 2\. The gaming platform integrates OxaPay's payment gateway to offer cryptocurrency payment options for in-game purchases. 3\. When a player decides to make an in-game purchase, the gaming platform prompts them to select their preferred cryptocurrency for payment. 4\. OxaPay's payment gateway calculates the total amount in the selected cryptocurrency based on the current exchange rate. 5\. The player is directed to OxaPay's payment gateway to complete the transaction. They can choose their desired cryptocurrency and network for payment. 6\. OxaPay's payment gateway generates a specific payment address for the player to send the cryptocurrency. 7\. The player's crypto wallet application opens with the payment address pre-filled. 8\. The player initiates the payment by sending the required cryptocurrency to the generated payment address. 9\. OxaPay's system monitors the transaction and updates the payment status in real-time. 10\. After a successful payment, the player receives a payment confirmation alert from their crypto wallet application. 11\. The player returns to the gaming platform, and the in-game purchase is instantly credited to their gaming account. 12\. The gaming platform receives a callback with payment information, such as transaction status, currency, amount, and fees. 13\. The gaming platform updates the player's account with the purchased in-game items or currency, providing them with an enhanced gaming experience. 14\. The gaming platform can access detailed payment-related information in their OxaPay accounts, ensuring transparency and seamless management of in-game purchases. By integrating OxaPay's payment gateway, online gaming platforms can offer a secure, fast, and convenient way for players to make in-game purchases using various cryptocurrencies. The ability to select payment currency and network provides players with flexibility, while real-time payment status updates and payment confirmations ensure a smooth and reliable payment process. Additionally, OxaPay's comprehensive payment information and management features enable the gaming platform to streamline payment tracking and enhance the overall gaming experience for players. These use cases demonstrate the versatility of OxaPay's cryptocurrency payment gateway, offering seamless payment processing, deposit management, and withdrawal functionalities to cater to various business needs. OxaPay's API integration provides the necessary tools and flexibility to enhance crypto-based transactions and offer an efficient payment solution for businesses and customers alike. [PreviousWebhook](https://docs.oxapay.com/webhook) Last updated 2 months ago --- # Account Balance | OxaPay Docs This endpoint allows you to retrieve the details of all wallets associated with a user, including a list of currencies and their corresponding amounts. get https://api.oxapay.com/v1/general/account/balance Query parameters currencystringOptional Specify a specific currency to get the balance for that currency. If not provided, the response will contain the balance for all available currencies. Header parameters general\_api\_keystringRequired Your General API Key for authentication and authorization. Content-TypestringRequiredDefault: `application/json` Responses 200 Successful operation application/json get /general/account/balance Python PythoncURLPHPNode.js Copy import requests url = 'https://api.oxapay.com/v1/general/account/balance' headers = { 'general_api_key': 'YOUR_GENERAL_API_KEY', 'Content-Type': 'application/json' } response = requests.get(url, headers=headers) result = response.json() print(result) Test it 200 Successful operation Copy { "data": { "BNB": 0, "DGB": 0, "XMR": 0, "BTC": 0.35029492, "ETH": 0, "USDC": 0, "POL": 0, "SOL": 0, "NOT": 0, "SHIB": 0, "TRX": 0, "USDT": 1074682.71394, "DOGS": 0, "TON": 0, "BCH": 0, "DOGE": 0, "LTC": 0 }, "message": "Operation completed successfully!", "error": {}, "status": 200, "version": "1.0.0" } [PreviousCommon](https://docs.oxapay.com/api-reference/common) [NextPrices](https://docs.oxapay.com/api-reference/common/prices) Last updated 4 months ago --- # Prices | OxaPay Docs This endpoint allows you to retrieve the current prices of all cryptocurrencies supported by OxaPay. get https://api.oxapay.com/v1/common/prices Responses 200 Successful operation application/json Responseobject Show properties get /common/prices Python PythoncURLPHPNode.js Copy import requests url = 'https://api.oxapay.com/v1/common/prices' response = requests.get(url) result = response.json() print(result) Test it 200 Successful operation Copy { "data": { "DOGE": 0.33417, "BNB": 695.79, "XMR": 198.42, "BTC": 94876.55, "ETH": 3301.45, "USDC": 1.0001, "POL": 0.4591, "SOL": 191.35, "NOT": 0.0059799, "SHIB": 0.00002163, "TRX": 0.2422, "USDT": 1, "DOGS": 0.000459, "TON": 5.2515, "BCH": 433.5, "DGB": 0.01244, "LTC": 103.99 }, "message": "Operation completed successfully!", "error": {}, "status": 200, "version": "1.0.3" } [PreviousAccount Balance](https://docs.oxapay.com/api-reference/common/account-balance) [NextSupported Currencies](https://docs.oxapay.com/api-reference/common/supported-currencies) Last updated 4 months ago --- # Swap Calculate | OxaPay Docs This endpoint allows you to instantly calculate how much cryptocurrency you'll receive when swapping one currency for another. Designed for ease of use, it provides real-time rates to ensure accurate calculations. Simply integrate this feature into your app to access the latest rates anytime. Whether you're buying or selling, this endpoint simplifies the process by giving you quick and precise swap amounts for your desired currency. post https://api.oxapay.com/v1/general/swap/calculate Header parameters general\_api\_keystringRequired Your General API Key for authentication and authorization. Content-TypestringRequiredDefault: `application/json` Body application/json application/json from\_currencystringRequired Specify the currency symbol you want to swap from. to\_currencystringRequired Specify the currency symbol you want to swap to. amountnumber · decimalRequired Specify the amount of currency you want to swap. Responses 200 Successful operation application/json Responseobject Show properties 400 Bad request application/json post /general/swap/calculate Python PythoncURLPHPNode.js Copy import requests import json url = 'https://api.oxapay.com/v1/general/swap/calculate' data = { "amount": 12, "from_currency": "USDT", "to_currency": "TRX" } headers = { 'general_api_key': 'YOUR_GENERAL_API_KEY', 'Content-Type': 'application/json' } response = requests.post(url, data=json.dumps(data), headers=headers) result = response.json() print(result) Test it 200 Successful operation Copy { "data": { "to_amount": 94763.06, "rate": 94763.06, "amount": 1 }, "message": "Operation completed successfully!", "error": {}, "status": 200, "version": "1.0.0" } [PreviousSwap Pairs](https://docs.oxapay.com/api-reference/swap/swap-pairs) [NextSwap Rate](https://docs.oxapay.com/api-reference/swap/swap-rate) Last updated 4 months ago --- # Donations | Legacy | OxaPay Docs OxaPay provides a seamless way to accept donations for charitable organizations or fundraising campaigns. By utilizing OxaPay's payment gateway, donors can easily contribute funds through cryptocurrencies. This integration enables charitable organizations to expand their donor base and receive donations in a secure and efficient manner. ### [](https://docs.oxapay.com/legacy/integrations/donations#create-your-account) Create your account You need an OxaPay account for managing and saving your crypto assets. You can create your OxaPay account free at this link (Just need an email and sign up in less than 1 minute): [https://app.oxapay.com/signinapp.oxapay.com](https://app.oxapay.com/signin) ### [](https://docs.oxapay.com/legacy/integrations/donations#donations-page) Donations page On the [Donations page](https://app.oxapay.com/donations) (you can find it in your OxaPay panel menu), you can view the details of your donations. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F517956072-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FAQc1OXMAl6RP5j6dwH6R%252Fuploads%252FThMzHywDimDPgQCXktUo%252Fd1.png%3Falt%3Dmedia%26token%3D1f6d3c89-b389-4191-915c-aca75b17b522&width=768&dpr=4&quality=100&sign=a86235d1&sv=2) ### [](https://docs.oxapay.com/legacy/integrations/donations#generate-your-donations-link) Generate your donations link 1- Enter a desired name for your donations link, which should be between 3 and 30 characters long, in the "Name" field. 2- Choose the accepted coins in the "Accepted Coins" section. Accepted coins refer to specific cryptocurrencies that are considered valid and can be used for payment. You can manually select specific coins or click on "Select All" to choose all coins. 3- In the field below, you can enable the SHOW option to display the NAME and EMAIL fields. By enabling this option, if the payer enters their name and email, it will be shown in Your Donation transactions. 4- Additionally, if name and email are necessary, you can activate the REQUIRE option to make the payer's name and email fields required. By enabling this option, the payer will be required to enter their name and email before proceeding with the payment. 5- Finally, click on the "Create donation button" to generate your desired donation link. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F517956072-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FAQc1OXMAl6RP5j6dwH6R%252Fuploads%252FQXdZYpE932dOP1PmVfdD%252Fd3.png%3Falt%3Dmedia%26token%3D41d76195-2c5e-4681-b09d-e88fd991435f&width=768&dpr=4&quality=100&sign=1d9b4c45&sv=2) ### [](https://docs.oxapay.com/legacy/integrations/donations#donations-summary) Donations Summary In this section, you can see the total value of donated transactions for today, this week, this month, and overall. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F517956072-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FAQc1OXMAl6RP5j6dwH6R%252Fuploads%252F76NWxTdvKlH6Tfxtcs6A%252Fd2.png%3Falt%3Dmedia%26token%3D15dc7791-7f5f-4389-a1e2-f27c902995d5&width=768&dpr=4&quality=100&sign=c97ecfd1&sv=2) ### [](https://docs.oxapay.com/legacy/integrations/donations#donation-payments-statistics) Donation payments statistics In the " Donation payments statistics " section, you can view a chart displaying the payment transactions associated with your Donation payment. This chart provides visual information about the donation activity, allowing you to track and monitor the performance of your Donation over time. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F517956072-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FAQc1OXMAl6RP5j6dwH6R%252Fuploads%252FirJhok18zI86DuZzIaZF%252Fd4.png%3Falt%3Dmedia%26token%3De050fc37-0f4c-4ce9-8eb1-e13b8babcef1&width=768&dpr=4&quality=100&sign=1fbd7850&sv=2) ### [](https://docs.oxapay.com/legacy/integrations/donations#your-donation-list) Your donation list In the "Your donation list" section, you can view the details of your Donation link and copy the URL or use its QR code. This allows you to easily share the Donation link with others Please note that the created donation links are not editable, and if any changes are required, you must delete that link and create a new one. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F517956072-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FAQc1OXMAl6RP5j6dwH6R%252Fuploads%252FgKP6WAfngkSf1R5LreEi%252Fd5.png%3Falt%3Dmedia%26token%3D051c766b-3faf-40cb-ba88-b11a1118d252&width=768&dpr=4&quality=100&sign=197f1d7e&sv=2) ### [](https://docs.oxapay.com/legacy/integrations/donations#pre-built-donation-button-codes) pre-built donation button codes If you wish, you can use the pre-built donation button codes provided by OxaPay. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F517956072-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FAQc1OXMAl6RP5j6dwH6R%252Fuploads%252F2sDjMBjM49jGK9OUYQnb%252Fd6.png%3Falt%3Dmedia%26token%3De8daf1de-aa54-446d-a31c-aff36eaccdbf&width=768&dpr=4&quality=100&sign=4cae99f8&sv=2) ### [](https://docs.oxapay.com/legacy/integrations/donations#your-donations-transactions) Your donations transactions In the "your donations transactions" section, you can view the details of your donations transactions. Please note that 'Amount sent' is the amount paid, and 'Amount received' is the amount paid after deducting the transaction fee. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F517956072-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FAQc1OXMAl6RP5j6dwH6R%252Fuploads%252FuhuE5K2MBdMwHHyRKR8s%252Fd7.png%3Falt%3Dmedia%26token%3D3ce60d66-872b-4d02-8a42-a879465dcf34&width=768&dpr=4&quality=100&sign=39107a73&sv=2) [PreviousPayment Links](https://docs.oxapay.com/legacy/integrations/payment-links) [NextMerchant API](https://docs.oxapay.com/legacy/integrations/merchant-api) Last updated 2 months ago --- # Troubleshooting | Legacy | OxaPay Docs **1\. Invalid API Key or Inactive Merchant:** \- Ensure that you are using the correct API key provided by OxaPay for authentication and authorization. \- Check if your merchant account is active and enabled for API access. If not, contact OxaPay support to resolve the issue. **2\. Validation** **Problem:** \- Verify that all required parameters are included in the request and have the correct format. \- Check for any misspelled parameters or incorrect values that might cause validation errors. **3\. Invalid Callback URL:** \- Ensure that the provided callback URL is a valid and accessible HTTPS URL where OxaPay can send payment notifications. \- Double-check for any typos or missing characters in the callback URL. **4\. Invalid Return URL or Failure URL:** \- When specifying return URLs or failure URLs, make sure they are valid URLs where the payer will be redirected after a successful or failed payment, respectively. \- Confirm that the URLs are correctly formatted and accessible. **5\. Insufficient Balance or Transfer Limits:** \- If you encounter errors related to insufficient balance or transfer limits, ensure that your merchant account has sufficient balance to process the payments. \- Verify that the payment amount is within the allowed transfer limits set by OxaPay. **6\. Payment Status Not Updated:** \- If you do not receive payment status updates or callbacks, check your server's firewall settings to ensure that OxaPay's requests can come through. \- Make sure that your server is accessible over HTTPS to receive callback notifications. **7\. Incorrect Currency or Network:** \- Ensure that you are using valid currency symbols and network values when making API requests. \- Refer to the documentation or supported currencies/networks endpoint to get the correct values. **8\. Rate Limit Exceeded:** \- OxaPay has rate limits in place to prevent abuse of the API. If you receive a rate limit error, consider optimizing your API usage or contact OxaPay support for assistance. **9\. Callback Signature Validation:** \- When receiving webhook notifications, validate the signature of callbacks coming from OxaPay using your API Secret Key. This helps prevent fraudulent activity. \- Check that the HMAC signature in the HTTP header matches the signature generated from the raw POST data using the API Secret Key. **10\. Contact OxaPay Support:** \- If you encounter any issues or errors that are not covered in this troubleshooting guide, feel free to reach out to OxaPay support for further assistance. Please note that this is a general troubleshooting guide, and specific issues may require further investigation and support from OxaPay's technical team. It's essential to follow the API documentation and guidelines provided by OxaPay to ensure smooth integration and resolution of any potential issues. [PreviousUse Cases](https://docs.oxapay.com/legacy/use-cases) Last updated 2 months ago --- # Payment | OxaPay Docs If you require a reliable solution to handle payment processing programmatically, Merchant Services are essential. They provide the tools and APIs necessary to seamlessly integrate payment functionality into your application or website. With these services, developers can efficiently manage transactions, ensuring secure and convenient payment processing for users. #### [](https://docs.oxapay.com/api-reference/payment#to-process-payments-youll-need-a-merchant-api-key.-follow-these-steps-to-generate-it) To process payments, you'll need a Merchant API key. Follow these steps to generate it: 1. Log in to your OxaPay account. 2. Navigate to the Merchant Service. 3. Fill in the form then click on the "Generate Merchant API Key" button. #### [](https://docs.oxapay.com/api-reference/payment#watch-the-video-below-for-a-step-by-step-walkthrough-of-the-process) Watch the video below for a step-by-step walkthrough of the process: #### [](https://docs.oxapay.com/api-reference/payment#below-youll-find-the-three-types-of-merchant-services-available) Below, you’ll find the three types of merchant services available. ### [](https://docs.oxapay.com/api-reference/payment#merchant-invoice) Merchant Invoice OxaPay’s crypto invoice service streamlines payment processes for businesses across retail, e-commerce, and services. This solution simplifies issuing and managing invoices, accepting crypto payments, and providing instant payment updates. Its seamless integration allows for enhanced payment options, boosting customer satisfaction. This service provides a comprehensive solution for businesses eager to engage with the expanding cryptocurrency market, delivering a secure and seamless payment experience. You can generate your invoice with the guidance provided in the [Generate Invoice](https://docs.oxapay.com/api-reference/creating-an-invoice) in the API references. ### [](https://docs.oxapay.com/api-reference/payment#merchant-white-label) Merchant White Label OxaPay's White Label solution seamlessly integrates cryptocurrency payments into your brand, enabling the creation of customized payment processes that reflect your brand identity. This solution provides a secure and versatile payment gateway without the high costs or need for extensive technical expertise. Tailor payment processes to align with your brand, utilizing advanced features to streamline your payment operations. This cost-effective solution enhances your brand and expands payment options. You can generate your own white-label with the guidance provided in the [Generate White Label](https://docs.oxapay.com/api-reference/creating-white-label-payment) in the API references. ### [](https://docs.oxapay.com/api-reference/payment#merchant-static-address) Merchant Static Address OxaPay's Static Address solution gives each of your customers a unique and static payment address. This address remains the same for all future payments, simplifying the payment process for both the merchant and the customer. It eliminates the complexity of managing multiple addresses and enhances transaction efficiency, security, and financial management. Ideal for high-volume businesses seeking improved user experience.Streamline operations, reduce costs, and boost customer satisfaction with OxaPay's Static Address solution and advanced payment tools. You can generate your static address with the guidance provided in the [Generate Static Address](https://docs.oxapay.com/api-reference/creating-static-wallet) in the API references. By referring to the API Reference, you can gain a comprehensive understanding of the OxaPay API and leverage its capabilities to create a seamless payment experience for your users. Whether you need to initiate payments, retrieve payment details, or manage transactions, the API Reference provides the necessary documentation to facilitate successful integration. [PreviousGravity Forms](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/wordpress/gravity-forms) [NextGenerate Invoice](https://docs.oxapay.com/api-reference/payment/generate-invoice) Last updated 4 months ago --- # Supported Currencies | OxaPay Docs This endpoint allows you to access a comprehensive list of supported cryptocurrencies, including their network details, symbol, name, and withdrawal information, enabling you to identify the appropriate network for each currency. get https://api.oxapay.com/v1/common/currencies Responses 200 Successful operation application/json Responseobject Show properties get /common/currencies Python PythoncURLPHPNode.js Copy import requests url = 'https://api.oxapay.com/v1/common/currencies' response = requests.get(url) result = response.json() print(result) Test it 200 Successful operation Copy { "data": { "BTC": { "symbol": "BTC", "name": "Bitcoin", "status": true, "networks": { "Bitcoin": { "network": "Bitcoin", "name": "Bitcoin Network", "keys": [\ "Bitcoin",\ "BTC"\ ], "required_confirmations": 2, "withdraw_fee": 0.00011, "withdraw_min": 0.000045, "deposit_min": 9.28e-8, "static_fixed_fee": 0.000002 } } }, "ETH": { "symbol": "ETH", "name": "Ethereum", "status": true, "networks": { "Ethereum": { "network": "Ethereum", "name": "Ethereum Network", "keys": [\ "Ethereum",\ "ERC20",\ "ETH"\ ], "required_confirmations": 10, "withdraw_fee": 0.0002, "withdraw_min": 0.0001, "deposit_min": 0.0000040832, "static_fixed_fee": 0 }, "Base": { "network": "Base", "name": "Base Network", "keys": [\ "Base"\ ], "required_confirmations": 10, "withdraw_fee": 8e-7, "withdraw_min": 0.0002, "deposit_min": 0.0000040832, "static_fixed_fee": 0 } } }, "USDT": { "symbol": "USDT", "name": "Tether", "status": true, "networks": { "Ethereum": { "network": "Ethereum", "name": "Ethereum Network", "keys": [\ "Ethereum",\ "ERC20",\ "ETH"\ ], "required_confirmations": 10, "withdraw_fee": 5, "withdraw_min": 1, "deposit_min": 0.01, "static_fixed_fee": 0 }, "Tron": { "network": "Tron", "name": "Tron Network", "keys": [\ "Tron",\ "TRC20",\ "TRX"\ ], "required_confirmations": 10, "withdraw_fee": 1, "withdraw_min": 0.01, "deposit_min": 0.01, "static_fixed_fee": 0.3 }, "BSC": { "network": "BSC", "name": "Binance Smart Chain", "keys": [\ "BSC",\ "BEP20",\ "BNB",\ "Binance"\ ], "required_confirmations": 15, "withdraw_fee": 0.25, "withdraw_min": 0.01, "deposit_min": 0.01, "static_fixed_fee": 0 }, "Polygon": { "network": "Polygon", "name": "Polygon Network", "keys": [\ "Polygon",\ "POL"\ ], "required_confirmations": 50, "withdraw_fee": 0.25, "withdraw_min": 0.01, "deposit_min": 0.01, "static_fixed_fee": 0 }, "The Open Network": { "network": "The Open Network", "name": "TON Network", "keys": [\ "The Open Network",\ "TON"\ ], "required_confirmations": 3, "withdraw_fee": 0.25, "withdraw_min": 0.01, "deposit_min": 0.01, "static_fixed_fee": 0 } } }, "USDC": { "symbol": "USDC", "name": "USD Coin", "status": true, "networks": { "Ethereum": { "network": "Ethereum", "name": "Ethereum Network", "keys": [\ "Ethereum",\ "ERC20",\ "ETH"\ ], "required_confirmations": 10, "withdraw_fee": 5, "withdraw_min": 5, "deposit_min": 0.0100020004, "static_fixed_fee": 0 } } }, "BNB": { "symbol": "BNB", "name": "BNB", "status": true, "networks": { "BSC": { "network": "BSC", "name": "Binance Smart Chain", "keys": [\ "BSC",\ "BEP20",\ "BNB",\ "Binance"\ ], "required_confirmations": 15, "withdraw_fee": 0.0000126, "withdraw_min": 0.0004, "deposit_min": 0.0000151999, "static_fixed_fee": 0 } } }, "DOGE": { "symbol": "DOGE", "name": "Dogecoin", "status": true, "networks": { "Dogecoin": { "network": "Dogecoin", "name": "Dogecoin Network", "keys": [\ "Dogecoin",\ "DOGE"\ ], "required_confirmations": 12, "withdraw_fee": 0.009, "withdraw_min": 0.01, "deposit_min": 0.0620039683, "static_fixed_fee": 0 } } }, "POL": { "symbol": "POL", "name": "Polygon", "status": true, "networks": { "Polygon": { "network": "Polygon", "name": "Polygon Network", "keys": [\ "Polygon",\ "POL"\ ], "required_confirmations": 50, "withdraw_fee": 0.005, "withdraw_min": 0.001, "deposit_min": 0.0554323725, "static_fixed_fee": 0 } } }, "LTC": { "symbol": "LTC", "name": "Litecoin", "status": true, "networks": { "Litecoin": { "network": "Litecoin", "name": "Litecoin Network", "keys": [\ "Litecoin",\ "LTC"\ ], "required_confirmations": 3, "withdraw_fee": 0.00014, "withdraw_min": 0.002, "deposit_min": 0.0001189343, "static_fixed_fee": 0 } } }, "SOL": { "symbol": "SOL", "name": "Solana", "status": true, "networks": { "Solana": { "network": "Solana", "name": "Solana Network", "keys": [\ "Solana",\ "SOL"\ ], "required_confirmations": 30, "withdraw_fee": 0.00003, "withdraw_min": 0.01, "deposit_min": 0.0000671006, "static_fixed_fee": 0 } } }, "TRX": { "symbol": "TRX", "name": "Tron", "status": true, "networks": { "Tron": { "network": "Tron", "name": "Tron Network", "keys": [\ "Tron",\ "TRC20",\ "TRX"\ ], "required_confirmations": 10, "withdraw_fee": 1, "withdraw_min": 0.0001, "deposit_min": 0.0355745286, "static_fixed_fee": 0 } } }, "SHIB": { "symbol": "SHIB", "name": "Shiba Inu", "status": true, "networks": { "BSC": { "network": "BSC", "name": "Binance Smart Chain", "keys": [\ "BSC",\ "BEP20",\ "BNB",\ "Binance"\ ], "required_confirmations": 15, "withdraw_fee": 3000, "withdraw_min": 1000, "deposit_min": 880.2816901408, "static_fixed_fee": 0 } } }, "TON": { "symbol": "TON", "name": "Toncoin", "status": true, "networks": { "The Open Network": { "network": "The Open Network", "name": "TON Network", "keys": [\ "The Open Network",\ "TON"\ ], "required_confirmations": 3, "withdraw_fee": 0.008, "withdraw_min": 0.05, "deposit_min": 0.003550632, "static_fixed_fee": 0 } } }, "XMR": { "symbol": "XMR", "name": "Monero", "status": true, "networks": { "Monero": { "network": "Monero", "name": "Monero Network", "keys": [\ "Monero",\ "XMR"\ ], "required_confirmations": 3, "withdraw_fee": 0.00009, "withdraw_min": 0.0001, "deposit_min": 0.0000313853, "static_fixed_fee": 0 } } }, "DAI": { "symbol": "DAI", "name": "DAI", "status": true, "networks": { "Polygon": { "network": "Polygon", "name": "Polygon Network", "keys": [\ "Polygon",\ "POL"\ ], "required_confirmations": 50, "withdraw_fee": 1, "withdraw_min": 0.01, "deposit_min": 0.01, "static_fixed_fee": 0 } } }, "BCH": { "symbol": "BCH", "name": "Bitcoin Cash", "status": true, "networks": { "BitcoinCash": { "network": "BitcoinCash", "name": "Bitcoin Cash Network", "keys": [\ "BitcoinCash",\ "BCH"\ ], "required_confirmations": 4, "withdraw_fee": 0.000024, "withdraw_min": 0.00001, "deposit_min": 0.0000199045, "static_fixed_fee": 0 } } }, "NOT": { "symbol": "NOT", "name": "NotCoin", "status": true, "networks": { "The Open Network": { "network": "The Open Network", "name": "TON Network", "keys": [\ "The Open Network",\ "TON"\ ], "required_confirmations": 3, "withdraw_fee": 14, "withdraw_min": 5, "deposit_min": 5.681172594, "static_fixed_fee": 0 } } }, "DOGS": { "symbol": "DOGS", "name": "Dogs", "status": true, "networks": { "The Open Network": { "network": "The Open Network", "name": "TON Network", "keys": [\ "The Open Network",\ "TON"\ ], "required_confirmations": 3, "withdraw_fee": 210, "withdraw_min": 5, "deposit_min": 80.5152979066, "static_fixed_fee": 0 } } } }, "message": "Operation completed successfully!", "error": {}, "status": 200, "version": "1.0.0" } [PreviousPrices](https://docs.oxapay.com/api-reference/common/prices) [NextSupported Fiat Currencies](https://docs.oxapay.com/api-reference/common/supported-fiat-currencies) Last updated 4 months ago --- # Paid Memberships Pro | OxaPay Docs [](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/wordpress/paid-memberships-pro#what-is-paid-memberships-pro) What is Paid Memberships Pro? ----------------------------------------------------------------------------------------------------------------------------------------------------------------- Paid Memberships Pro is a popular WordPress plugin designed for managing and selling paid memberships. It allows site administrators to restrict access to content or services based on membership levels, offering exclusive content to paying members. With this plugin, you can set up multiple membership tiers, integrate various payment gateways, and manage access to premium content. [](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/wordpress/paid-memberships-pro#key-features-of-paid-memberships-pro) Key Features of Paid Memberships Pro: --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- 1. **Unlimited Membership Levels**: Create an unlimited number of membership tiers with varying prices and access privileges. Each level can offer unique benefits, allowing you to cater to different types of members or audiences. 2. **Content Restriction**: Restrict access to specific content (such as posts, pages, categories, or custom post types) based on membership status. This lets you offer exclusive content to paying members while keeping general content available to all. 3. **Flexible Payment Gateways**: Integrates seamlessly with popular payment gateways like OxaPay, PayPal, Stripe, and Authorize.net. You can offer different payment methods for your members and manage payments with ease, ensuring a smooth and secure transaction process. 4. **Member Management**: Provides a detailed interface to manage your members, allowing you to view, edit, or update member profiles, change their membership level, or handle billing issues directly from the admin dashboard. 5. **Reports & Analytics**: Track membership statistics with built-in reporting tools that give insights into revenue, active memberships, and overall growth. You can generate custom reports for better decision-making and optimization of your membership strategy. 6. **Email Notifications**: Automate emails for critical events, such as membership signups, renewals, cancellations, and expiration reminders. Customize these email templates to communicate effectively with your members. 7. **Add-ons & Integrations**: Expand the functionality of Paid Memberships Pro with a wide variety of add-ons, like affiliate tracking, WooCommerce integration, or custom member directories. This allows you to scale your membership site and add features as your needs grow. [](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/wordpress/paid-memberships-pro#oxapay-plugin-for-paid-memberships-pro) OxaPay Plugin For Paid Memberships Pro ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ The OxaPay Plugin for Paid Memberships Pr**o** is an extension designed to integrate the OxaPay payment gateway with the Paid Memberships Pro plugin, allowing websites to accept cryptocurrency payments for membership subscriptions. OxaPay is known for facilitating secure and efficient cryptocurrency transactions, offering users the ability to pay with various digital currencies like Bitcoin, Ethereum, and more. This integration expands payment options for membership-based websites, catering to customers who prefer using cryptocurrencies instead of traditional payment methods. With this plugin, website owners can leverage the benefits of blockchain technology, such as faster transactions, lower fees, and broader international reach. The OxaPay plugin ensures a smooth checkout process, providing a seamless experience for members while maintaining compatibility with Paid Memberships Pro. This makes it a valuable solution for businesses seeking to diversify their payment options and attract a global audience. [](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/wordpress/paid-memberships-pro#how-to-set-up-oxapay-plugin-for-paid-memberships-pro) How To Set Up OxaPay Plugin For Paid Memberships Pro? ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- 1. Log in to your WordPress control panel, navigate to the "Plugins" section, and click on "Add New". Select "Upload Plugin" then upload the "OxaPay" plugin ZIP file ([Click here to download it](https://oxapay.com/plugins/oxapay_pmpro.zip) ) and click on the"Install Now" button. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2Fcontent.gitbook.com%2Fcontent%2F0cdQgWk1yvwE7MR49PSn%2Fblobs%2FXzHvUdIaOvkLZzc0L8Yq%2FScreenshot%2520%289%29.png&width=768&dpr=4&quality=100&sign=79b01f8e&sv=2) 1. Go to your "Paid Memberships Pro" settings and navigate to the "Payment Gateway". ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2Fcontent.gitbook.com%2Fcontent%2F0cdQgWk1yvwE7MR49PSn%2Fblobs%2FxcYoXWQF9wBjNPXfL5gq%2FScreenshot%2520%2813%29.png&width=768&dpr=4&quality=100&sign=bf24b07b&sv=2) 1. Enter your OxaPay Merchant API key (You can find this key in your OxaPay dashboard. If you don't have an API key, click here for instructions on how to create one). Complete any other fields. You can use the "sandbox" mode for testing. Once all the details are filled in, click "Save Settings" to finalize the setup. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2Fcontent.gitbook.com%2Fcontent%2F0cdQgWk1yvwE7MR49PSn%2Fblobs%2FMJhDsMinqmfJTvcCdNxY%2FScreenshot%2520%2812%29.png&width=768&dpr=4&quality=100&sign=db738d81&sv=2) #### [](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/wordpress/paid-memberships-pro#you-can-download-the-oxapay-plugin-for-paid-memberships-pro-by-clicking-on-the-file-below) You can download the OxaPay plugin for Paid Memberships Pro by clicking on the file below: 22KB [oxapay-crypto-gateway-for-paid-memberships-pro.1.0.0.zip](https://2150865118-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0cdQgWk1yvwE7MR49PSn%2Fuploads%2FLfWgm6L0oXSWH2Y9ZlDR%2Foxapay-crypto-gateway-for-paid-memberships-pro.1.0.0.zip?alt=media&token=fc022b7e-4385-423a-b859-9565fe69c88b) archive Download[Open](https://2150865118-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0cdQgWk1yvwE7MR49PSn%2Fuploads%2FLfWgm6L0oXSWH2Y9ZlDR%2Foxapay-crypto-gateway-for-paid-memberships-pro.1.0.0.zip?alt=media&token=fc022b7e-4385-423a-b859-9565fe69c88b) We hope this article was helpful! The OxaPay plugin for Paid Memberships Pro is a powerful and valuable tool that can help take your business to the next level. [PreviousEasy Digital Downloads](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/wordpress/easy-digital-downloads) [NextRestrict Content Pro](https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/wordpress/restrict-content-pro) Last updated 1 month ago --- # Supported Fiat Currencies | OxaPay Docs This endpoint allows you to retrieve a list of supported fiat currencies, with details including currency code (e.g., USD, AUD), symbol, name, price, and display precision. Merchants can use this data to create invoices in fiat currencies. get https://api.oxapay.com/v1/common/fiats Responses 200 Successful operation application/json Responseobject Show properties get /common/fiats Python PythoncURLPHPNode.js Copy import requests url = 'https://api.oxapay.com/v1/common/fiats' response = requests.get(url) result = response.json() print(result) Test it 200 Successful operation Copy { "data": { "USD": { "symbol": "USD", "name": "United States Dollar", "price": 1, "display_precision": 0.001 }, "AMD": { "symbol": "AMD", "name": "Armenian Dram", "price": 0.00252146, "display_precision": 0.1 }, "AUD": { "symbol": "AUD", "name": "Australian Dollar", "price": 0.64417134, "display_precision": 0.001 }, "AZN": { "symbol": "AZN", "name": "Azerbaijani Manat", "price": 0.58823529, "display_precision": 0.001 }, "BRL": { "symbol": "BRL", "name": "Brazilian Real", "price": 0.19290387, "display_precision": 0.001 }, "CAD": { "symbol": "CAD", "name": "Canadian Dollar", "price": 0.72528465, "display_precision": 0.001 }, "CHF": { "symbol": "CHF", "name": "Swiss Franc", "price": 1.09690497, "display_precision": 0.0001 }, "CNH": { "symbol": "CNH", "name": "Chinese Yuan (Offshore)", "price": 0.13775649, "display_precision": 0.01 }, "CNY": { "symbol": "CNY", "name": "Chinese Yuan", "price": 0.13815843, "display_precision": 0.001 }, "CZK": { "symbol": "CZK", "name": "Czech Republic Koruna", "price": 0.04200128, "display_precision": 0.01 }, "DKK": { "symbol": "DKK", "name": "Danish Krone", "price": 0.14240819, "display_precision": 0.001 }, "EUR": { "symbol": "EUR", "name": "Euro", "price": 1.06245537, "display_precision": 0.0001 }, "GBP": { "symbol": "GBP", "name": "British Pound Sterling", "price": 1.24456436, "display_precision": 0.0001 }, "GHS": { "symbol": "GHS", "name": "Ghanaian Cedi", "price": 0.07437206, "display_precision": 0.01 }, "HKD": { "symbol": "HKD", "name": "Hong Kong Dollar", "price": 0.12773181, "display_precision": 0.01 }, "HUF": { "symbol": "HUF", "name": "Hungarian Forint", "price": 0.00269629, "display_precision": 0.1 }, "IDR": { "symbol": "IDR", "name": "Indonesian Rupiah", "price": 0.00006216, "display_precision": 1 }, "ILS": { "symbol": "ILS", "name": "Israeli New Sheqel", "price": 0.26630945, "display_precision": 0.001 }, "INR": { "symbol": "INR", "name": "Indian Rupee", "price": 0.01197495, "display_precision": 0.01 }, "ISK": { "symbol": "ISK", "name": "Icelandic Króna", "price": 0.00706131, "display_precision": 0.1 }, "JPY": { "symbol": "JPY", "name": "Japanese Yen", "price": 0.0064821, "display_precision": 0.1 }, "KRW": { "symbol": "KRW", "name": "South Korean Won", "price": 0.00072048, "display_precision": 1 }, "KZT": { "symbol": "KZT", "name": "Kazakhstani Tenge", "price": 0.00223112, "display_precision": 0.1 }, "MXN": { "symbol": "MXN", "name": "Mexican Peso", "price": 0.05981358, "display_precision": 0.01 }, "MYR": { "symbol": "MYR", "name": "Malaysian Ringgit", "price": 0.2094855, "display_precision": 0.001 }, "NOK": { "symbol": "NOK", "name": "Norwegian Krone", "price": 0.09141394, "display_precision": 0.01 }, "NZD": { "symbol": "NZD", "name": "New Zealand Dollar", "price": 0.59035466, "display_precision": 0.001 }, "PHP": { "symbol": "PHP", "name": "Philippine Peso", "price": 0.01756583, "display_precision": 0.01 }, "PKR": { "symbol": "PKR", "name": "Pakistani Rupee", "price": 0.00359691, "display_precision": 0.1 }, "PLN": { "symbol": "PLN", "name": "Polish Zloty", "price": 0.24682429, "display_precision": 0.001 }, "RUB": { "symbol": "RUB", "name": "Russian Ruble", "price": 0.01070713, "display_precision": 0.01 }, "SEK": { "symbol": "SEK", "name": "Swedish Krona", "price": 0.0919065, "display_precision": 0.01 }, "SGD": { "symbol": "SGD", "name": "Singapore Dollar", "price": 0.73380815, "display_precision": 0.001 }, "THB": { "symbol": "THB", "name": "Thai Baht", "price": 0.02721835, "display_precision": 0.01 }, "TMT": { "symbol": "TMT", "name": "Turkmenistani Manat", "price": 0.28571428, "display_precision": 0.001 }, "TRY": { "symbol": "TRY", "name": "Turkish Lira", "price": 0.03083831, "display_precision": 0.01 }, "UAH": { "symbol": "UAH", "name": "Ukrainian Hryvnia", "price": 0.02527927, "display_precision": 0.01 }, "UZS": { "symbol": "UZS", "name": "Uzbekistan Som", "price": 0.00007892, "display_precision": 0.1 }, "VND": { "symbol": "VND", "name": "Vietnamese Dong", "price": 0.00003972, "display_precision": 1 }, "ZAR": { "symbol": "ZAR", "name": "South African Rand", "price": 0.05259256, "display_precision": 0.01 } }, "message": "Operation completed successfully!", "error": {}, "status": 200, "version": "1.0.0" } [PreviousSupported Currencies](https://docs.oxapay.com/api-reference/common/supported-currencies) [NextSupported Networks](https://docs.oxapay.com/api-reference/common/supported-networks) Last updated 4 months ago --- # Payment History | OxaPay Docs Use this endpoint to retrieve a list of payments associated with your account, determined by your Merchant API Key. You can filter the results using various criteria, including time range, payment status, amount, payment type, and more. Additionally, the endpoint supports pagination with page and size parameters, allowing you to customize the number of results per request. get https://api.oxapay.com/v1/payment Query parameters track\_idintegerOptional Filter payments by a specific invoice ID. typestring · enumOptional Filter payments by type. Possible values: `invoice``white_label``static_address` statusstring · enumOptional Filter payments by status. Possible values: `Paying``Paid` pay\_currencystringOptional Filter payments by a specific crypto currency symbol in which the pay amount is specified. currencystringOptional Filter payments by a specific currency symbol. networkstringOptional Filter payments by the expected blockchain network for the specified crypto currency. addressstringOptional Filter payments by the expected address. It’s better to filter static addresses. from\_dateintegerOptional The start of the date window to query for payments in UNIX format. to\_dateintegerOptional The end of the date window to query for payments in UNIX format. from\_amountnumber · decimalOptional Filter payments with amounts greater than or equal to the specified value. to\_amountnumber · decimalOptional Filter payments with amounts less than or equal to the specified value. sort\_bystring · enumOptional Sort the received list by a parameter. Default: `create_date`Possible values: `create_date``pay_date``amount` sort\_typestring · enumOptional Display the list in ascending or descending order. Default: `desc`Possible values: `asc``desc` pageinteger · min: 1Optional The page number of the results you want to retrieve. Default: `1` sizeinteger · min: 1 · max: 200Optional Number of records to display per page. Default: `10` Header parameters merchant\_api\_keystringRequired Your Merchant API Key for authentication and authorization. Content-TypestringRequiredDefault: `application/json` Responses 200 Successful operation application/json Responseobject Show properties 400 Bad request application/json get /payment Python PythoncURLPHPNode.js Copy import requests import json url = 'https://api.oxapay.com/v1/payment/' headers = { 'merchant_api_key': 'YOUR_MERCHANT_API_KEY', 'Content-Type': 'application/json' } params = { 'size': 20, 'page': 1 } response = requests.get(url, params=params , headers=headers) result = response.json() print(result) Test it 200 Successful operation Copy { "data": { "list": [\ {\ "track_id": "168931368",\ "type": "invoice",\ "amount": 15,\ "currency": "USD",\ "status": "paid",\ "mixed_payment": true,\ "fee_paid_by_payer": 0,\ "under_paid_coverage": 21.5,\ "lifetime": 60,\ "callback_url": "https://example.com/callback",\ "return_url": "https://example.com/success",\ "email": "[email protected]",\ "order_id": "ORD-12345",\ "description": "Order #12345",\ "thanks_message": "Thanks Message",\ "expired_at": 1728121075,\ "date": 1728117475,\ "txs": [\ {\ "tx_hash": "0x2DehmnxMDFMhS3KHXCPpGSx41NeLBjH34q5vjN1oGbUDFFAMC9rG3",\ "amount": 0.00613418,\ "currency": "ETH",\ "network": "Ethereum Network",\ "address": "HEHCVjnxD8cQrFwfo4k9WXJXErpmK9Ym1nRaEiJJ8DP3",\ "status": "confirmed",\ "confirmations": 11,\ "auto_convert": {\ "processed": true,\ "amount": 14.73130872,\ "currency": "USDT"\ },\ "auto_withdrawal": {\ "processed": false\ },\ "date": 1728117736\ }\ ]\ }\ ], "meta": { "page": 1, "last_page": 1, "total": 1 } }, "message": "Operation completed successfully!", "error": {}, "status": 200, "version": "1.0.0" } [PreviousPayment Information](https://docs.oxapay.com/api-reference/payment/payment-information) [NextAccepted Currencies](https://docs.oxapay.com/api-reference/payment/accepted-currencies) Last updated 4 months ago --- # Payment Links | Legacy | OxaPay Docs Payment links are a versatile tool offered by OxaPay that enables merchants to create customized payment URLs for their customers. With payment links, merchants can easily share payment requests through email, social media, or messaging platforms. Customers can then make payments conveniently by clicking on the provided link. This integration simplifies the payment process and enhances the customer experience. ### [](https://docs.oxapay.com/legacy/integrations/payment-links#create-your-account) Create your account You need an OxaPay account for managing and saving your crypto assets. You can create your OxaPay account free at this link (Just need an email and sign up in less than 1 minute): [https://app.oxapay.com/signinapp.oxapay.com](https://app.oxapay.com/signin) ### [](https://docs.oxapay.com/legacy/integrations/payment-links#payment-link-page) Payment link page On the [Payment link](https://app.oxapay.com/paymentlink) page (you can find it in your OxaPay panel menu), you can view the details of your payment link. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F517956072-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FAQc1OXMAl6RP5j6dwH6R%252Fuploads%252FTWxQiZiWmbXKMGJF2txP%252FPicture1.png%3Falt%3Dmedia%26token%3Dd587520b-8f0c-4d52-8666-de731ce10e77&width=768&dpr=4&quality=100&sign=fd0abf7b&sv=2) ### [](https://docs.oxapay.com/legacy/integrations/payment-links#generate-your-payment-link) Generate your payment link 1\. Enter a desired name for your payment link, which should be between 3 and 30 characters long, in the "Name" field. 2\. Specify the payment amount in the "Price" field. 3\. Choose the accepted coins in the "Accepted Coins" section. Accepted coins refer to specific cryptocurrencies that are considered valid and can be used for payment. You can manually select specific coins or click on "Select All" to choose all coins. 4\. In the "Underpaid Cover" section, you can set a percentage between 0% and 60%. If the payer submits a payment that is slightly less than or equal to the underpaid amount, the invoice will still be accepted. 5\. If you enable the "Fee paid by payer", your customer will cover all the fees for this payment. 6\. Provide additional information or description about your payment link in the "Description" field. 7\. Finally, click on "Create Payment Link" to generate your desired payment link. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F517956072-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FAQc1OXMAl6RP5j6dwH6R%252Fuploads%252FlucEcgg7MbrYTtoYUg7P%252FPicture3.png%3Falt%3Dmedia%26token%3Dc7a5e681-7018-4c7e-816f-2aadcdb35a3a&width=768&dpr=4&quality=100&sign=3206ed03&sv=2) ### [](https://docs.oxapay.com/legacy/integrations/payment-links#payment-summary) Payment Summary In this section, you can see the total value of payment transactions for today, this week, this month, and overall. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F517956072-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FAQc1OXMAl6RP5j6dwH6R%252Fuploads%252FlVdYC6nqFK6LHCRfjVfb%252FPicture2.png%3Falt%3Dmedia%26token%3Dc33a797d-d6bf-4f31-8361-c02422141b1c&width=768&dpr=4&quality=100&sign=1c6f4727&sv=2) ### [](https://docs.oxapay.com/legacy/integrations/payment-links#payment-links-statistics) Payment links statistics In the "Payment links statistics " section, you can view a chart displaying the payment transactions associated with your payment link. This chart provides a visual representation of the payment activity, allowing you to track and monitor the performance of your payment link over time. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F517956072-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FAQc1OXMAl6RP5j6dwH6R%252Fuploads%252FlEPWWcqtAvS4V1dFHnVl%252FPicture4.png%3Falt%3Dmedia%26token%3D39115667-0518-4bfc-83e8-cc81bffcf66f&width=768&dpr=4&quality=100&sign=c8202cb&sv=2) ### [](https://docs.oxapay.com/legacy/integrations/payment-links#your-payment-links) Your payment links In the "Your payment links" section, you can view the details of your payment link and you can copy the URL of your payment link or use its QR code. This allows you to easily share the payment link with others. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F517956072-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FAQc1OXMAl6RP5j6dwH6R%252Fuploads%252FrVxyeBXQKTs3jiEOrlCb%252FPicture5.png%3Falt%3Dmedia%26token%3D4b5abd74-642d-4ec4-9962-b4dcc0e04d0c&width=768&dpr=4&quality=100&sign=b4ba77a&sv=2) Please note that the created payment links are not editable, and if any changes are required, you must delete that link and create a new one. ### [](https://docs.oxapay.com/legacy/integrations/payment-links#your-payment-links-transactions) Your payment links transactions In the "Your payment links transactions" section, you can view the details of your payment links transactions. Please note that 'Amount' represents the invoice amount, 'Amount sent' is the amount paid, and 'Amount received' is the amount paid after deducting the transaction fee. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F517956072-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FAQc1OXMAl6RP5j6dwH6R%252Fuploads%252FCeEOjGrOdpivS0uT3Mbi%252FPicture6.png%3Falt%3Dmedia%26token%3D9f1849fb-e335-456a-bec2-6ecf1e679a57&width=768&dpr=4&quality=100&sign=5ee56c6&sv=2) [PreviousIntegrations](https://docs.oxapay.com/legacy/integrations) [NextDonations](https://docs.oxapay.com/legacy/integrations/donations) Last updated 2 months ago --- # Merchant API | Legacy | OxaPay Docs Merchants refer to webmasters or businesses who use OxaPay's services to integrate cryptocurrency payments into their websites. OxaPay's Merchants Webservice provides an API for webmasters to easily add crypto as a payment method on their websites, apps, and bots. ### [](https://docs.oxapay.com/legacy/integrations/merchant-api#create-your-account) Create your account You need an OxaPay account for managing and saving your crypto assets. You can create your OxaPay account free at this link (Need an email and sign up in less than 1 minute): [https://app.oxapay.com/signinapp.oxapay.com](https://app.oxapay.com/signin) ### [](https://docs.oxapay.com/legacy/integrations/merchant-api#merchants-page) Merchants page On the [Merchants page](https://app.oxapay.com/merchant) (you can find it in your OxaPay panel menu), you can view the details of your Merchant keys. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F517956072-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FAQc1OXMAl6RP5j6dwH6R%252Fuploads%252FG933Q0vEgclVKefxqVym%252Fm-1.png%3Falt%3Dmedia%26token%3D52867c78-cc38-4c7a-8d78-e9a242e333fe&width=768&dpr=4&quality=100&sign=31fc7ba7&sv=2) ### [](https://docs.oxapay.com/legacy/integrations/merchant-api#generate-your-merchant-api-key) Generate your Merchant API key 1- Enter a desired name for your Merchant, which should be between 3 and 30 characters long, in the "Name" field. 2- Enter your logo’s URL in the “Logo URL” field. This logo will be displayed on your merchant payment page. The logo should have a transparent background and be in dark colors in PNG or SVG format. 3- Choose the accepted coins in the "Accepted Coins" section. Accepted coins refer to specific cryptocurrencies that are considered valid and can be used for payment. You can manually select specific coins or click on "Select All" to choose all coins. 4- In the "Underpaid Cover" section, you can set a percentage between 0% and 60%. If the payer submits a payment that is slightly less than or equal to the underpaid amount, the invoice will still be accepted. 5- If you enable the "Fee paid by payer", your customer will cover all the fees for this payment. 6- Finally, click on "Generate merchant API key" to generate your desired merchant key. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F517956072-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FAQc1OXMAl6RP5j6dwH6R%252Fuploads%252FsFNeRsI9ZuQbekOHi8OG%252Fm-3.png%3Falt%3Dmedia%26token%3D83af5bc8-38fe-498a-8304-198eb7ff2c62&width=768&dpr=4&quality=100&sign=864722b0&sv=2) ### [](https://docs.oxapay.com/legacy/integrations/merchant-api#payment-summary) Payment Summary In this section, you can see the total value of the merchant’s transactions for today, this week, this month, and overall. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F517956072-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FAQc1OXMAl6RP5j6dwH6R%252Fuploads%252FlVdYC6nqFK6LHCRfjVfb%252FPicture2.png%3Falt%3Dmedia%26token%3Dc33a797d-d6bf-4f31-8361-c02422141b1c&width=768&dpr=4&quality=100&sign=1c6f4727&sv=2) ### [](https://docs.oxapay.com/legacy/integrations/merchant-api#merchants-payment-statistics) Merchants payment statistics In the "Merchants payments statistics " section, you can view a chart displaying the payment transactions associated with your Merchant payment. This chart provides visual information about the Merchant key activity, allowing you to track and monitor the performance of your Merchant payments over time. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F517956072-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FAQc1OXMAl6RP5j6dwH6R%252Fuploads%252FL5PiuWZ1os5EfrbT25sD%252Fm-4.png%3Falt%3Dmedia%26token%3Dec5dfa61-73ba-4ac8-8973-4ed645f6748e&width=768&dpr=4&quality=100&sign=aa4447ca&sv=2) ### [](https://docs.oxapay.com/legacy/integrations/merchant-api#your-merchants-api-keys) Your Merchants API keys In the " Your merchant API keys " section, you can view the details of your merchant keys and you can copy the URL of your merchant key or use its QR code. This allows you to share the merchant key with others easily. Please note that the created merchant keys are editable, and if any changes are required, you can click on the edit button in “Actions”. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F517956072-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FAQc1OXMAl6RP5j6dwH6R%252Fuploads%252Fcqtm5hnNvhdI2gHValwh%252Fm-5-highlight.png%3Falt%3Dmedia%26token%3D020056b0-16fa-476d-9087-bd56129c1b62&width=768&dpr=4&quality=100&sign=d6152d33&sv=2) ### [](https://docs.oxapay.com/legacy/integrations/merchant-api#the-process-of-using-the-merchant-key) The process of using the merchant key After obtaining the merchant key, you can create an invoice, static address, and white-label Payment with the guidance provided in the [API references](https://docs.oxapay.com/api-reference) . ### [](https://docs.oxapay.com/legacy/integrations/merchant-api#what-is-an-invoice-link) What is an invoice link? An invoice link is a dynamic payment link associated with a predefined expiration time and a specific invoice amount. Invoice links are typically generated for one-time use. ### [](https://docs.oxapay.com/legacy/integrations/merchant-api#how-to-create-an-invoice-link) How to create an invoice link? You can create your invoice link with the guidance provided in the [Creating an Invoice](https://docs.oxapay.com/api-reference/creating-an-invoice) in the API references. ### [](https://docs.oxapay.com/legacy/integrations/merchant-api#what-is-a-static-address) What is a static address? A static address is an address that remains valid indefinitely and has no restrictions on the amount or time of use. ### [](https://docs.oxapay.com/legacy/integrations/merchant-api#how-to-create-a-static-address) How to create a static address? You can create your static address with the guidance provided in the [Creating Static Wallet](https://docs.oxapay.com/api-reference/creating-static-wallet) in the API references. ### [](https://docs.oxapay.com/legacy/integrations/merchant-api#what-is-white-label-address) What is white-label address? A white-label address is a dynamic address associated with a predefined expiration time and a specific invoice amount. Unlike static addresses that remain constant, white-label addresses are typically generated for one-time use. ### [](https://docs.oxapay.com/legacy/integrations/merchant-api#how-to-create-white-label-payment) How to create white-label Payment? You can create your own white-label with the guidance provided in the Creating [White-Label](https://docs.oxapay.com/api-reference/creating-white-label-payment) Payment in the API references. ### [](https://docs.oxapay.com/legacy/integrations/merchant-api#your-merchant-transactions) Your merchant transactions In the "Your merchants transactions" section, You can view the details of your merchants' transactions. Please note that the ‘Invoice amount’ refers to the entered defined amount of the invoice. 'Amount sent' is the amount paid, and 'Amount received' is the amount paid after deducting the transaction fee. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F517956072-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FAQc1OXMAl6RP5j6dwH6R%252Fuploads%252FIQ741jxW6XRAptXV8tbc%252Fm-6.png%3Falt%3Dmedia%26token%3D709c0cc6-2f3b-475b-a6df-231c0283c235&width=768&dpr=4&quality=100&sign=5916fa27&sv=2) [PreviousDonations](https://docs.oxapay.com/legacy/integrations/donations) [NextPayout API](https://docs.oxapay.com/legacy/integrations/payout-api) Last updated 2 months ago --- # Payout API | Legacy | OxaPay Docs ### [](https://docs.oxapay.com/legacy/integrations/payout-api#what-is-payout-api) What is Payout API? OxaPay's payout API is a feature that allows users to mass transfer crypto assets to other users automatically. This feature is particularly useful for webmasters. #### [](https://docs.oxapay.com/legacy/integrations/payout-api#internal-payout-api) Internal payout API: This feature is especially beneficial for webmasters who need to make micropayments to their users. The internal Payout API offers the capability to transfer with zero fees and without any limits. #### [](https://docs.oxapay.com/legacy/integrations/payout-api#external-payout-api) External payout API: This feature enables users to automate mass transfers of crypto assets to other users. However, please be aware that this option incurs fees and has limitations on the amount that can be transferred. ### [](https://docs.oxapay.com/legacy/integrations/payout-api#create-your-account) Create your account You need an OxaPay account for managing and saving your crypto assets. You can create your OxaPay account free at this link (Need an email and sign up in less than 1 minute): [https://app.oxapay.com/signinapp.oxapay.com](https://app.oxapay.com/signin) ### [](https://docs.oxapay.com/legacy/integrations/payout-api#payout-api-page) Payout API page On the [Payout API page](https://app.oxapay.com/payout) (you can find it in your OxaPay panel menu), you can view the details of your Payout. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F517956072-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FAQc1OXMAl6RP5j6dwH6R%252Fuploads%252Fin1NL41FEmKQ1ntaRcEG%252Fpo1.png%3Falt%3Dmedia%26token%3D312d8cbb-b5dd-421c-86b5-c2d97fa513a8&width=768&dpr=4&quality=100&sign=5bf77ec1&sv=2) ### [](https://docs.oxapay.com/legacy/integrations/payout-api#generate-your-payout-api-key) Generate your Payout API key 1-Right from the start, It is important to note that you need to enable 2FA (Two-Factor Authentication) for your account to use the payout API. 2-Enter a desired name for your Payout API, which should be between 3 and 30 characters long, in the "Name" field. 3-In the “Allowed IPs for transfer” field you can set some IPs and permit them to transfer. Any request for transfer from other IPs will fail. 4-The “Total daily transfer limit” field is for more security of your API transfers and if your total daily transfer exceeds this amount, the remained transactions will fail. 5-The “Transfer limit per transaction” field is for more security of your API transfers and transactions with more than this amount will fail. 6-In the “2FA verification code” field you should enter your 2FA code. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F517956072-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FAQc1OXMAl6RP5j6dwH6R%252Fuploads%252F4D4XzbtVI3XRaUTfEs3C%252Fpo4.png%3Falt%3Dmedia%26token%3De3d62535-9883-438e-9567-bfc4338e5d10&width=768&dpr=4&quality=100&sign=78dfcae3&sv=2) ### [](https://docs.oxapay.com/legacy/integrations/payout-api#payment-summary) Payment Summary In this section, you can see the total value of the Payouts transactions for today, this week, this month, and overall. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F517956072-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FAQc1OXMAl6RP5j6dwH6R%252Fuploads%252FiRn9Db5RIKWMqkgKoDrS%252Fpo2.png%3Falt%3Dmedia%26token%3D5461b90c-869c-4f6c-a418-e877aef26511&width=768&dpr=4&quality=100&sign=8b0063a1&sv=2) ### [](https://docs.oxapay.com/legacy/integrations/payout-api#payout-statistics) Payout Statistics In the "Payouts statistics" section, you can view a chart displaying the payment transactions associated with your Payouts. This chart provides visual information about the Payout activity, allowing you to track and monitor the performance of your Payouts over time. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F517956072-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FAQc1OXMAl6RP5j6dwH6R%252Fuploads%252FrfZ0jzEplWtWRioB3J8v%252F2023-09-03%252011.47.56.jpg%3Falt%3Dmedia%26token%3D2e308774-fc26-43e5-9fd6-04b2a522db68&width=768&dpr=4&quality=100&sign=ce8dc19&sv=2) ### [](https://docs.oxapay.com/legacy/integrations/payout-api#your-payout-api-keys) Your Payout API keys In "Your Payout API keys" section, you can view the details of your payout API and you can copy the URL of your payout API key or use its QR code. This allows you to easily share the payout API with others. Please note that the created Payout API are editable, and if any changes are required, you can click on the edit button in “Actions”. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F517956072-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FAQc1OXMAl6RP5j6dwH6R%252Fuploads%252Febz6KHEu6dmosvMfhlyw%252Fpo5.png%3Falt%3Dmedia%26token%3Db85056ef-684c-4874-8688-52b6cc8d9e9b&width=768&dpr=4&quality=100&sign=b54c19b5&sv=2) ### [](https://docs.oxapay.com/legacy/integrations/payout-api#how-to-create-payout) How to create Payout? You can create your own Payout with the guidance provided in the [Creating Payout](https://docs.oxapay.com/api-reference/creating-payout) in the API references. ### [](https://docs.oxapay.com/legacy/integrations/payout-api#your-payout-apis-transactions) Your Payout APIs transactions In "Your Payout APIs transactions" section, you can view the details of your Payout APIs transactions. Please note that the ‘Invoice amount’ refers to the entered defined amount of the invoice. 'Amount sent' is the amount paid, and 'Amount received' is the amount paid after deducting the transaction fee. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F517956072-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FAQc1OXMAl6RP5j6dwH6R%252Fuploads%252F56ffPpcfVcBjnYVdyWu0%252Fpo6.png%3Falt%3Dmedia%26token%3Dd14c84ae-48e0-4a55-ae01-622236fa4372&width=768&dpr=4&quality=100&sign=297bc4ff&sv=2) [PreviousMerchant API](https://docs.oxapay.com/legacy/integrations/merchant-api) [NextPlugins](https://docs.oxapay.com/legacy/integrations/plugins) Last updated 2 months ago --- # Use Cases | Legacy | OxaPay Docs [](https://docs.oxapay.com/legacy/use-cases#e-commerce-flow) E-commerce Flow --------------------------------------------------------------------------------- In an e-commerce scenario, merchants can leverage OxaPay's cryptocurrency payment gateway to offer customers the option to make purchases using various cryptocurrencies. The flow for this use case is as follows: 1\. The payer selects item/items for purchase, determining the total sum. 2\. The payer selects the preferred payment currency. 3\. The merchant generates a payment link using the OxaPay API's "Create an Invoice" endpoint. This endpoint allows the merchant to create a payment link with all the necessary payment details, such as the payment amount, currency, and other optional parameters like expiration time, feePaidByPayer, and underPaidCover. 4\. The API generates a unique payment link for the payer, containing the payment details. 5\. The payer receives the payment link and can click on it to proceed with the payment. Alternatively, the merchant can display the payment link on their website or send it via email or any other communication channel. 6\. When the payer clicks on the payment link, they are redirected to OxaPay's payment gateway to complete the payment. 7\. OxaPay's payment gateway displays the payment details and prompts the payer to select their desired cryptocurrency and network. 8\. After selecting the payment currency and network, OxaPay's payment gateway generates a specific payment address for the payer to send the cryptocurrency. 9\. The payer's crypto wallet application opens with the specified payment address pre-filled. 10\. The payer initiates the payment by sending the required cryptocurrency to the generated payment address. 11\. OxaPay's system monitors the transaction and updates the payment status in real-time. 12\. After a successful payment, the payer receives a payment confirmation alert on the page. 13\. The payer can then click on the "Return to Website" button to redirect to the merchant's specified returnUrl (if provided) 14\. The merchant's system receives a callback with payment information, such as transaction status, currency, amount, and fees. 15\. The merchant updates the order status and processes the purchase, allowing the payer to access their purchased goods or services. 16\. The merchant can access detailed payment-related information in their OxaPay accounts, providing transparency and easy management. [](https://docs.oxapay.com/legacy/use-cases#e-commerce-with-seamless-payment-flow) E-commerce with Seamless Payment Flow ----------------------------------------------------------------------------------------------------------------------------- In an e-commerce scenario, merchants can leverage OxaPay's payment link feature to create a seamless payment experience for their customers. The flow for this use case, which includes the creation of a payment link, is as follows: 1\. The payer selects item/items for purchase, determining the total sum. 2\. The payer selects the preferred payment currency. 3\. The system retrieves the exchange rate for the selected currency and estimates the total amount in cryptocurrency. 4\. The merchant calls the "Create white-label" method to generate a payment link and obtain the payment address (e.g., a BTC wallet address for BTC payments). 5\. The payer is provided with the payment address and can initiate the payment by sending the required cryptocurrency to the given address. 6\. The payer can scan the QR code or manually copy the address and proceed with the payment using their preferred crypto wallet application. 7\. When the payer sends the cryptocurrency to the payment address, OxaPay's system receives a callback containing payment information, such as transaction status, currency, amount, and fees. 8\. The merchant's system updates the payment status based on the callback information, completing the purchase process. 9\. The merchant can access all payment-related information in their OxaPay accounts, ensuring transparency and easy management. [](https://docs.oxapay.com/legacy/use-cases#investment-flow) Investment Flow --------------------------------------------------------------------------------- For investment platforms or websites, OxaPay offers a seamless crypto deposit and balance management flow. The steps for this use case are as follows: 1\. The user has a crypto balance on the website. 2\. The user selects the desired payment currency for making a deposit. 3\. The merchant calls the "Create static address" method to generate a permanent deposit address for the selected currency. 4\. The website displays the deposit address (e.g., BTC address) to the user, who can initiate the deposit by sending the cryptocurrency to the provided address. 5\. The user can scan the QR code or manually copy the address and proceed with the deposit using their crypto wallet application. 6\. After the user sends the cryptocurrency to the deposit address, OxaPay's system receives a callback containing deposit information, such as transaction status, currency, amount, and fees. 7\. The merchant updates the user's crypto balance based on the callback information, reflecting the deposited amount in the user's account. 8\. All relevant information about the deposit and user's balance is accessible in the merchant's OxaPay account. [](https://docs.oxapay.com/legacy/use-cases#withdrawal-flow) Withdrawal Flow --------------------------------------------------------------------------------- In scenarios where users want to withdraw funds from their crypto balance on a website or platform, OxaPay simplifies the withdrawal process. The steps are as follows: 1\. The merchant has a crypto balance in their OxaPay account, which includes user funds. 2\. A user requests a withdrawal from their balance on the website. 3\. The merchant uses the OxaPay API's "/api/send" method to initiate a payout, providing the user's desired withdrawal address and amount. 4\. OxaPay's system sends the funds to the user's provided crypto address. 5\. After processing the payout, the merchant's system receives a callback containing transaction parameters, such as transaction status, currency, amount, and fees. 6\. The merchant updates the user's crypto balance, deducting the withdrawn amount from the user's account. 7\. The merchant can access comprehensive information about the transaction and balance in their OxaPay accounts, ensuring transparency and easy tracking. [](https://docs.oxapay.com/legacy/use-cases#global-freelance-marketplace) Global Freelance Marketplace ----------------------------------------------------------------------------------------------------------- 1\. A global freelance marketplace connects freelancers and clients from around the world for various projects and services. 2\. To facilitate secure and efficient cross-border payments, the freelance marketplace integrates OxaPay's payment gateway. 3\. When a client hires a freelancer and agrees on a project's terms, they proceed to make a payment for the services rendered. 4\. The client selects their preferred cryptocurrency and network for payment on the freelance marketplace's payment page. 5\. OxaPay's payment gateway calculates the total amount in the selected cryptocurrency based on the current exchange rate. 6\. The client is redirected to OxaPay's payment gateway to complete the transaction. 7\. OxaPay's payment gateway generates a specific payment address for the client to send the cryptocurrency. 8\. The client's crypto wallet application opens with the payment address pre-filled. 9\. The client initiates the payment by sending the required cryptocurrency to the generated payment address. 10\. OxaPay's system monitors the transaction and updates the payment status in real-time. 11\. After a successful payment, the freelancer is notified of the payment and can proceed with the project. 12\. The freelancer delivers the completed project to the client through the freelance marketplace's platform. 13\. The client reviews and approves the project's completion. 14\. Upon approval, the freelance marketplace receives a callback from OxaPay's payment gateway with payment information, such as transaction status, currency, amount, and fees. 15\. The freelance marketplace releases the payment to the freelancer's account on the platform. 16\. The freelancer can access their earnings and withdraw funds to their crypto wallet at any time. 17\. The freelancer can view detailed payment-related information in their OxaPay accounts for transparency and financial tracking. By integrating OxaPay's payment gateway, the freelance marketplace streamlines global payments for freelancers and clients, enabling them to transact in various cryptocurrencies securely and conveniently. The ability to select payment currency and network provides clients with flexibility in cross-border transactions, while real-time payment status updates ensure transparency and efficiency. Additionally, OxaPay's comprehensive payment information and management features enable the freelance marketplace to enhance financial tracking and provide a seamless payment experience for both clients and freelancers. [](https://docs.oxapay.com/legacy/use-cases#online-gaming-platform-with-in-game-purchases) Online Gaming Platform with In-Game Purchases: ---------------------------------------------------------------------------------------------------------------------------------------------- 1\. Players on an online gaming platform want to make in-game purchases to enhance their gaming experience. 2\. The gaming platform integrates OxaPay's payment gateway to offer cryptocurrency payment options for in-game purchases. 3\. When a player decides to make an in-game purchase, the gaming platform prompts them to select their preferred cryptocurrency for payment. 4\. OxaPay's payment gateway calculates the total amount in the selected cryptocurrency based on the current exchange rate. 5\. The player is directed to OxaPay's payment gateway to complete the transaction. They can choose their desired cryptocurrency and network for payment. 6\. OxaPay's payment gateway generates a specific payment address for the player to send the cryptocurrency. 7\. The player's crypto wallet application opens with the payment address pre-filled. 8\. The player initiates the payment by sending the required cryptocurrency to the generated payment address. 9\. OxaPay's system monitors the transaction and updates the payment status in real-time. 10\. After a successful payment, the player receives a payment confirmation alert from their crypto wallet application. 11\. The player returns to the gaming platform, and the in-game purchase is instantly credited to their gaming account. 12\. The gaming platform receives a callback with payment information, such as transaction status, currency, amount, and fees. 13\. The gaming platform updates the player's account with the purchased in-game items or currency, providing them with an enhanced gaming experience. 14\. The gaming platform can access detailed payment-related information in their OxaPay accounts, ensuring transparency and seamless management of in-game purchases. By integrating OxaPay's payment gateway, online gaming platforms can offer a secure, fast, and convenient way for players to make in-game purchases using various cryptocurrencies. The ability to select payment currency and network provides players with flexibility, while real-time payment status updates and payment confirmations ensure a smooth and reliable payment process. Additionally, OxaPay's comprehensive payment information and management features enable the gaming platform to streamline payment tracking and enhance the overall gaming experience for players. These use cases demonstrate the versatility of OxaPay's cryptocurrency payment gateway, offering seamless payment processing, deposit management, and withdrawal functionalities to cater to various business needs. OxaPay's API integration provides the necessary tools and flexibility to enhance crypto-based transactions and offer an efficient payment solution for businesses and customers alike. [PreviousWebhook](https://docs.oxapay.com/legacy/webhook) [NextTroubleshooting](https://docs.oxapay.com/legacy/troubleshooting) Last updated 2 years ago --- # Blesta | Legacy | OxaPay Docs [](https://docs.oxapay.com/legacy/integrations/plugins/blesta#what-is-blesta) What is Blesta? -------------------------------------------------------------------------------------------------- Blesta is a comprehensive billing and client management platform designed primarily for web hosting companies and other service providers. It's a software solution that automates various aspects of a business, including billing, invoicing, client management, and support. [](https://docs.oxapay.com/legacy/integrations/plugins/blesta#key-features-of-blesta) Key Features of Blesta: ------------------------------------------------------------------------------------------------------------------ 1. **Billing Automation**: Automatically generates and sends invoices, handles both one-time and recurring payments, and supports various payment gateways. 2. **Client Management**: Offers a centralized client portal for managing services, viewing invoices, and making payments, with support for multiple currencies and languages. 3. **Service Provisioning**: Integrates with web hosting control panels and domain registrars to automate service management, supporting a wide range of digital services. 4. **Support System**: Includes a built-in ticketing system, enabling businesses to provide customer support directly through Blesta. 5. **Customizable and Extendable**: Features a modular design that allows for easy customization and the addition of new features through plugins and extensions. 6. **Security**: Offers robust security measures like two-factor authentication (2FA) and data encryption, with regular updates to ensure security. 7. **Reporting and Analytics**: Provides detailed reports on business metrics, with customizable dashboards for real-time monitoring. 8. **Multi-Company Support**: Allows management of multiple companies or brands from a single installation, each with distinct settings and services. [](https://docs.oxapay.com/legacy/integrations/plugins/blesta#oxapay-plugin-for-blesta) OxaPay Plugin For Blesta --------------------------------------------------------------------------------------------------------------------- Integrating OxaPay with Blesta is a strategic step toward expanding your business and reaching new milestones. The OxaPay plugin for Blesta allows businesses to accept cryptocurrency as a fully integrated payment method, thereby widening your customer base and enhancing payment convenience. By leveraging Blesta, you can efficiently automate various aspects of your business operations. Enabling the OxaPay plugin on the Blesta platform enhances operational efficiency and increases customer engagement by facilitating crypto transactions with minimal fees and rapid processing times. [](https://docs.oxapay.com/legacy/integrations/plugins/blesta#how-to-set-up-oxapay-plugin-for-blesta) How To Set Up OxaPay Plugin For Blesta? -------------------------------------------------------------------------------------------------------------------------------------------------- 1. To install the OxaPay plugin ([Click here to download it](https://github.com/OxaPay/oxapay-blesta/archive/refs/tags/v1.0.0.zip) ) for Blesta, move the plugin folder to the following path _“Blesta → components → gateways → nonmerchant”_. 2. Navigate to the settings section within Blesta. Click on the "Payment Gateway" option in the settings page. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F517956072-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FAQc1OXMAl6RP5j6dwH6R%252Fuploads%252Fvy2EXtGbcNaB6Y2ht0iP%252FScreenshot%2520%281175%29.png%3Falt%3Dmedia%26token%3Dfe33b049-8ad2-4ff3-8a77-0f7540afca63&width=768&dpr=4&quality=100&sign=7cb2c9f0&sv=2) 1. In the "Available" section, locate the "OxaPay Payment Gateway" under the Non-Merchant category, and click on the "Install" button. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F517956072-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FAQc1OXMAl6RP5j6dwH6R%252Fuploads%252FhADJteLeT38dRE3IXeeP%252FScreenshot%2520%281176%29-Recovered.png%3Falt%3Dmedia%26token%3Dbd70d626-cdf9-401a-a776-8a263bebabb2&width=768&dpr=4&quality=100&sign=254a09e4&sv=2) 1. Enter your OxaPay Merchant API key in the designated field. You can find this key in your OxaPay panel. If you don't have an API key, [click here](https://docs.oxapay.com/legacy/integrations/merchant-api) to learn how to create one. Alternatively, you can use the "sandbox" mode for testing. After entering the Merchant API key, click on "Update Settings" to finalize the setup. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F517956072-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FAQc1OXMAl6RP5j6dwH6R%252Fuploads%252FfqwBx0JsFSO9JHsEwZ7P%252FScreenshot%2520%281180%29.png%3Falt%3Dmedia%26token%3D27ef11e5-17fb-4c35-a236-ce45fdae35df&width=768&dpr=4&quality=100&sign=32f3c990&sv=2) #### [](https://docs.oxapay.com/legacy/integrations/plugins/blesta#you-can-download-the-oxapay-plugin-for-blesta-by-clicking-on-the-file-below) You can download the OxaPay plugin for Blesta by clicking on the file below: 24KB [oxapay\_blesta.zip](https://517956072-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAQc1OXMAl6RP5j6dwH6R%2Fuploads%2FWqVR9zzNrVZ4ZBEEDFtD%2Foxapay_blesta.zip?alt=media&token=46a75b67-f9bf-40d6-82d4-657c3a59187a) archive Download[Open](https://517956072-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAQc1OXMAl6RP5j6dwH6R%2Fuploads%2FWqVR9zzNrVZ4ZBEEDFtD%2Foxapay_blesta.zip?alt=media&token=46a75b67-f9bf-40d6-82d4-657c3a59187a) We hope this article was helpful to you! The OxaPay plugin for Blesta is a powerful and valuable tool to elevate your business to the next level. Last updated 1 month ago --- # WooCommerce | Legacy | OxaPay Docs [](https://docs.oxapay.com/legacy/integrations/plugins/woocommerce#what-is-woocommerce) What is WooCommerce? ----------------------------------------------------------------------------------------------------------------- WooCommerce is a free plugin for the WordPress content management system that allows users to easily set up and manage their online stores. It is one of the most popular and widely used tools for creating e-commerce websites. Due to its high flexibility and the ability to extend its functionality with various plugins and themes, WooCommerce is an ideal choice for both small and large businesses. [](https://docs.oxapay.com/legacy/integrations/plugins/woocommerce#key-features-of-woocommerce) Key Features of WooCommerce: --------------------------------------------------------------------------------------------------------------------------------- 1. **Free to Use**: WooCommerce is available for free, allowing you to set up your online store without any additional costs. 2. **Integration with WordPress**: WooCommerce is fully integrated with WordPress, enabling you to leverage all of WordPress’s capabilities. 3. **Flexibility**: It offers high customization options through various themes and plugins, allowing you to design your store exactly how you want. 4. **Product Management**: WooCommerce provides easy management of products, allowing you to add, delete, and edit products with details like pricing, images, descriptions, and categories. 5. **Payment Gateways**: It supports multiple payment gateways, including local and international options, making it easy to receive payments from your customers. 6. **Reporting and Analytics**: WooCommerce includes tools for reporting and analyzing your store's performance, helping you monitor and improve your business. 7. **Multilingual Support**: With the help of various plugins, WooCommerce can be set up to support multiple languages, allowing you to serve customers from around the world. 8. **Strong SEO Capabilities**: WooCommerce benefits from WordPress’s powerful SEO features, helping your store get better visibility in search engines. [](https://docs.oxapay.com/legacy/integrations/plugins/woocommerce#oxapay-plugin-for-woocommerce) OxaPay Plugin For WooCommerce ------------------------------------------------------------------------------------------------------------------------------------ Integrating OxaPay with WooCommerce is a strategic move to expand your business and achieve new milestones. The OxaPay plugin for WooCommerce enables businesses to accept cryptocurrency as a fully integrated payment method, thereby broadening your customer base and enhancing payment flexibility. By leveraging WooCommerce, you can efficiently manage various aspects of your online store. Activating the OxaPay plugin on the WooCommerce platform boosts operational efficiency and enhances customer engagement by enabling crypto transactions with minimal fees and fast processing times. [](https://docs.oxapay.com/legacy/integrations/plugins/woocommerce#how-to-set-up-oxapay-plugin-for-woocommerce) How To Set Up OxaPay Plugin For WooCommerce? ----------------------------------------------------------------------------------------------------------------------------------------------------------------- 1. Log in to your WordPress control panel, navigate to the "Plugins" section, and click on "Add New". Select "Upload Plugin" then upload the "OxaPay" plugin ZIP file ([Click here to download it](https://downloads.wordpress.org/plugin/oxapay.1.0.0.zip) ) and click on the"Install Now" button. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F517956072-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FAQc1OXMAl6RP5j6dwH6R%252Fuploads%252FOWrsO2aPy12OZTEQKjxs%252FScreenshot%2520%281183%29.png%3Falt%3Dmedia%26token%3D97557b0b-ad62-476c-b0ab-7c5e9b6b2303&width=768&dpr=4&quality=100&sign=982eeae7&sv=2) 1. Once the plugin is installed, click on "Activate Plugin" to enable it. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F517956072-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FAQc1OXMAl6RP5j6dwH6R%252Fuploads%252F3ZheLQOpX6goFgMrfKwv%252FScreenshot%2520%281185%29.png%3Falt%3Dmedia%26token%3Dda37edfe-9f34-4ccb-803d-d940c366185e&width=768&dpr=4&quality=100&sign=bf969351&sv=2) 1. In the list of installed plugins, locate OxaPay and click on the "Configure" link. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F517956072-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FAQc1OXMAl6RP5j6dwH6R%252Fuploads%252FUlQhslXjvApsnYBf3Rin%252FScreenshot%2520%281186%29.png%3Falt%3Dmedia%26token%3D6c8b404a-9040-4e1e-b5e5-3eebb7261fbf&width=768&dpr=4&quality=100&sign=7293c148&sv=2) 1. Enter your OxaPay Merchant API key (You can find this key in your OxaPay dashboard. If you don't have an API key, [click here](https://docs.oxapay.com/legacy/integrations/merchant-api) for instructions on how to create one). Complete any other required fields. You can use the "sandbox" mode for testing. Once all the details are filled in, click "Save Changes" to finalize the setup. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F517956072-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FAQc1OXMAl6RP5j6dwH6R%252Fuploads%252FO9oZwT1CYduLrJDPawrn%252FScreenshot%2520%281211%29.png%3Falt%3Dmedia%26token%3D561fa2c7-d71d-4a16-a134-cd08e1205166&width=768&dpr=4&quality=100&sign=b949b960&sv=2) #### [](https://docs.oxapay.com/legacy/integrations/plugins/woocommerce#if-you-encounter-the-following-error) If you encounter the following error: > “There are no payment methods available. This may be an error on our side. Please contact us if you need any help placing your order.” #### [](https://docs.oxapay.com/legacy/integrations/plugins/woocommerce#simply-navigate-to-the-checkout-page-in-the-pages-section-of-your-wordpress-admin-panel.-click-on-fo) Simply navigate to the "Checkout" page in the "Pages" section of your WordPress admin panel. Click on "Form" and then select "Switch to classic checkout" to resolve the issue. #### [](https://docs.oxapay.com/legacy/integrations/plugins/woocommerce#you-can-download-the-oxapay-plugin-for-woocommerce-by-clicking-on-the-file-below) You can download the OxaPay plugin for WooCommerce by clicking on the file below: 29KB [oxapay.1.0.0.zip](https://517956072-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAQc1OXMAl6RP5j6dwH6R%2Fuploads%2FdyYD4TFEKN6iujhsYzKa%2Foxapay.1.0.0.zip?alt=media&token=53f114bb-df8c-4562-a019-510fa6ed24e6) archive Download[Open](https://517956072-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAQc1OXMAl6RP5j6dwH6R%2Fuploads%2FdyYD4TFEKN6iujhsYzKa%2Foxapay.1.0.0.zip?alt=media&token=53f114bb-df8c-4562-a019-510fa6ed24e6) We hope this article was helpful to you! The OxaPay plugin for WooCommerce is a powerful and valuable tool to take your business to the next level. Last updated 7 months ago --- # VirtueMart | Legacy | OxaPay Docs [](https://docs.oxapay.com/legacy/integrations/plugins/virtuemart#what-is-virtuemart) What is VirtueMart? -------------------------------------------------------------------------------------------------------------- **VirtueMart** is an **open-source eCommerce solution** designed to work with the **Joomla** content management system (CMS). It enables users to build and manage online stores with features that support product listings, customer management, orders, and payment processing. [](https://docs.oxapay.com/legacy/integrations/plugins/virtuemart#key-features-of-virtuemart) Key Features of VirtueMart: ------------------------------------------------------------------------------------------------------------------------------ 1. **Flexible Product Management:** VirtueMart enables easy management of products, categories, attributes, and variants, allowing administrators to efficiently organize and showcase their merchandise. 2. **Multi-Language Support:** With built-in multi-language support, VirtueMart caters to international markets, allowing users to create and manage multilingual online stores. 3. **Multiple Payment Gateways:** VirtueMart supports various payment gateways, including PayPal, Stripe, Authorize.Net, and more, offering flexibility in accepting payments securely. 4. **Shipping and Tax Calculation:** The platform provides tools for calculating shipping costs and taxes based on different parameters such as weight, destination, and tax rates, streamlining the checkout process. 5. **Inventory Management:** VirtueMart offers inventory management features, including stock tracking, low-stock notifications, and backorder management, helping users keep track of their inventory levels. 6. **SEO-Friendly:** The platform is designed with search engine optimization (SEO) in mind, providing features such as customizable URLs, meta tags, and sitemaps to improve online visibility and rankings. 7. **Extensions and Add-ons:** VirtueMart offers a wide range of extensions and add-ons, allowing users to extend the functionality of their online store with additional features and integrations. [](https://docs.oxapay.com/legacy/integrations/plugins/virtuemart#oxapay-plugin-for-virtuemart) OxaPay Plugin For VirtueMart --------------------------------------------------------------------------------------------------------------------------------- Integrating OxaPay with VirtueMart offers a modern and efficient way to accept cryptocurrency payments in your Joomla-based online store. This powerful combination enables businesses to easily accept crypto for products, providing a fast, secure, and borderless shopping experience for customers around the world. With enterprise-level security, OxaPay ensures that all transactions are processed safely and reliably. This builds trust with your customers while expanding your store’s market reach. Enabling crypto payments in VirtueMart not only simplifies payment processing but also helps attract new customers and boost sales. [](https://docs.oxapay.com/legacy/integrations/plugins/virtuemart#how-to-set-up-oxapay-plugin-for-virtuemart) How To Set Up OxaPay Plugin For VirtueMart? -------------------------------------------------------------------------------------------------------------------------------------------------------------- 1. Go to System -> Extensions, then upload the "OxaPay" plugin ZIP file ([Click here to download it](https://github.com/OxaPay/oxapay-virtuemart/archive/refs/tags/v1.0.0.zip) ) After that, the plugin must be activated in Plugins. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F517956072-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FAQc1OXMAl6RP5j6dwH6R%252Fuploads%252FmawOqmYOsGioRqY9oNTy%252FScreenshot%25202025-05-18%2520122527.png%3Falt%3Dmedia%26token%3Dd79398e1-6efb-4331-8616-ef4e9c97c915&width=768&dpr=4&quality=100&sign=f7e41336&sv=2) ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F517956072-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FAQc1OXMAl6RP5j6dwH6R%252Fuploads%252FtiJk43Yaj8d5Ym0fy0it%252FScreenshot%25202025-05-18%2520123058.png%3Falt%3Dmedia%26token%3Df69a3537-a4f8-4311-a6dc-6d5d1f44da78&width=768&dpr=4&quality=100&sign=d00e7cc4&sv=2) 1. Now go to “Components -> VirtueMart -> Payment Methods” and then create a new payment method. Select the “VM Payment - OxaPay Crypto Payment Gateway” in Payment Method. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F517956072-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FAQc1OXMAl6RP5j6dwH6R%252Fuploads%252F1ssxtYPg7Wyg6OZMsMk3%252FScreenshot%25202025-05-18%2520124628.png%3Falt%3Dmedia%26token%3D1e98e4b8-a490-42ad-bf58-259aa49b8836&width=768&dpr=4&quality=100&sign=7eca17c1&sv=2) 1. Go to Configuration and enter your OxaPay Merchant API key (You can find this key in your OxaPay dashboard. If you don't have an API key, [click here](https://docs.oxapay.com/legacy/integrations/merchant-api) for instructions on how to create one). Complete any other fields. Once all the details are filled in, click "Save" to finalize the setup. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F517956072-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FAQc1OXMAl6RP5j6dwH6R%252Fuploads%252FkdsPUebEri2F31vPNz1A%252FScreenshot%25202025-05-18%2520124517.png%3Falt%3Dmedia%26token%3D86684986-eaf4-42f3-af51-f3420f80e7c3&width=768&dpr=4&quality=100&sign=8c2cdc83&sv=2) **You can download the OxaPay plugin for VirtueMart by clicking on the file below:** 8KB [oxapay\_virtuemart.zip](https://517956072-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAQc1OXMAl6RP5j6dwH6R%2Fuploads%2Fj6HslqYOjeV8LX5Eivng%2Foxapay_virtuemart.zip?alt=media&token=6b618df5-4db9-47f4-bb77-5e59bf751d7a) archive Download[Open](https://517956072-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAQc1OXMAl6RP5j6dwH6R%2Fuploads%2Fj6HslqYOjeV8LX5Eivng%2Foxapay_virtuemart.zip?alt=media&token=6b618df5-4db9-47f4-bb77-5e59bf751d7a) We hope you found this article useful! The OxaPay plugin for **VirtueMart** is a powerful tool that can help elevate your business to new heights. Last updated 1 month ago --- # OpenCart | Legacy | OxaPay Docs [](https://docs.oxapay.com/legacy/integrations/plugins/opencart#what-is-opencart) What is OpenCart? -------------------------------------------------------------------------------------------------------- OpenCart is a free, open-source e-commerce platform designed for building and managing online stores. It offers a user-friendly interface, a wide range of extensions, and supports multiple payment gateways, making it a popular choice for businesses looking to sell products online. [](https://docs.oxapay.com/legacy/integrations/plugins/opencart#key-features-of-opencart) Key features of OpenCart: ------------------------------------------------------------------------------------------------------------------------ 1. **Store Management**: OpenCart offers a comprehensive admin panel that allows businesses to efficiently manage their products, categories, and customer accounts. With multi-store functionality, users can control multiple shops from a single interface, streamlining operations. 2. **Payment Integration**: OpenCart supports various payment gateways such as OxaPay, PayPal, and others, making it easy for businesses to handle transactions. It also supports multiple currencies, ensuring smooth global payments and invoicing. 3. **Product and Inventory Management**: The platform provides tools for managing a wide range of product options, attributes, and stock levels. This helps businesses organize their product catalog and track inventory efficiently. 4. **Automation**: OpenCart offers automated features for order processing, shipping, and notifications. This helps reduce manual tasks, speeding up order fulfillment and enhancing the customer experience. 5. **Analytics and Reports**: Built-in reporting tools provide valuable insights into sales, customer activity, and product performance. These analytics help businesses make data-driven decisions and track overall store performance. 6. **Customer Management**: OpenCart includes customer account management, allowing store owners to track order history, handle communications, and manage customer reviews. Customers can also use a self-service portal to view orders and make changes to their accounts. [](https://docs.oxapay.com/legacy/integrations/plugins/opencart#oxapay-plugin-for-opencart) OxaPay Plugin For OpenCart --------------------------------------------------------------------------------------------------------------------------- Integrating OxaPay with OpenCart is a great way to take your online store to the next level. The OxaPay extension for OpenCart enables businesses to accept cryptocurrency as a native payment method, providing customers with more payment options and expanding your market reach. With the OxaPay integration, businesses can process transactions quickly and efficiently, with lower fees and faster settlement times compared to traditional fiat currencies. This makes it an attractive option for customers who prefer using cryptocurrencies for their purchases. Additionally, OxaPay offers robust security measures, ensuring that each transaction is secure and reliable, giving both merchants and customers peace of mind. [](https://docs.oxapay.com/legacy/integrations/plugins/opencart#how-to-set-up-oxapay-plugin-for-opencart) How To Set Up OxaPay Plugin For OpenCart? -------------------------------------------------------------------------------------------------------------------------------------------------------- 1. Ensure that you have OpenCart version 4.x installed on your website. Once logged into your dashboard, go to the left menu, find the "Extensions" tab, click on it, and select "Installer". 2. After that, upload the Oxapay plugin ([Click here to download it](https://github.com/OxaPay/oxapay-opencart/releases/download/v1.0.0/oxapay.ocmod.zip) ). Once you receive a successful upload message, go to the Oxapay bar in the action section and click on the "Install" button to complete the installation. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F517956072-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FAQc1OXMAl6RP5j6dwH6R%252Fuploads%252FfdiFtceQDTN0lF212sxJ%252F1.png%3Falt%3Dmedia%26token%3D0a86a793-408d-4774-8b2e-f31a9a7d958b&width=768&dpr=4&quality=100&sign=6dd0f1e1&sv=2) 1. Now, first choose the "Payments" type from the list. Then, find the Oxapay bar and click on the "Install" button. After the installation is complete, click on the "Edit" button to configure the settings. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F517956072-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FAQc1OXMAl6RP5j6dwH6R%252Fuploads%252FPFggMzPqa1Wz0Pb6HJCj%252F2.png%3Falt%3Dmedia%26token%3D3c8562eb-42b7-44fe-970d-ca34f46585ca&width=768&dpr=4&quality=100&sign=2205a851&sv=2) 1. Now, enter your "OxaPay Merchant API Key" in the designated field (you can find it in your OxaPay panel. If you don’t have an API key, [click here](https://docs.oxapay.com/legacy/integrations/merchant-api) to learn how to create one, or you can use the "sandbox" mode for testing). Complete the remaining configurations, and then click on the "Save" button. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F517956072-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FAQc1OXMAl6RP5j6dwH6R%252Fuploads%252FUSULvIZe5aVjm4wOqYV4%252F3.png%3Falt%3Dmedia%26token%3Db7fc0fd7-084d-44ee-922d-0ca9fd9e2967&width=768&dpr=4&quality=100&sign=988e1d2a&sv=2) **You can download the OxaPay plugin for OpenCart by clicking on the file below:** 15KB [oxapay.ocmod.zip](https://517956072-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAQc1OXMAl6RP5j6dwH6R%2Fuploads%2FvxyN25jjuBWQPXN0V1p5%2Foxapay.ocmod.zip?alt=media&token=6106afd6-1a51-4eca-9a3c-c5483f48a739) archive Download[Open](https://517956072-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAQc1OXMAl6RP5j6dwH6R%2Fuploads%2FvxyN25jjuBWQPXN0V1p5%2Foxapay.ocmod.zip?alt=media&token=6106afd6-1a51-4eca-9a3c-c5483f48a739) [](https://517956072-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAQc1OXMAl6RP5j6dwH6R%2Fuploads%2FiLnrpPpcCQfdABDrB489%2FOxaPay_woocommerce.zip?alt=media&token=c8dab002-375f-408a-81cc-dc7b737b0923) We hope this article was helpful to you! The OxaPay plugin for OpenCart is a powerful and valuable tool to help take your business to the next level. [PreviousVirtueMart](https://docs.oxapay.com/legacy/integrations/plugins/virtuemart) [NextMerchant and Payout Service with API](https://docs.oxapay.com/legacy/integrations/merchant-and-payout-service-with-api) Last updated 1 month ago --- # Easy Digital Downloads | Legacy | OxaPay Docs [](https://docs.oxapay.com/legacy/integrations/plugins/easy-digital-downloads#what-is-easy-digital-downloads) What is Easy Digital Downloads? -------------------------------------------------------------------------------------------------------------------------------------------------- Easy Digital Downloads (EDD) is a popular WordPress plugin designed for selling digital products like ebooks, software, and digital art. It provides an easy-to-use platform for managing downloads, payments, and customer data. [](https://docs.oxapay.com/legacy/integrations/plugins/easy-digital-downloads#key-features-of-easy-digital-downloads) Key Features of Easy Digital Downloads: ------------------------------------------------------------------------------------------------------------------------------------------------------------------ 1. **Digital Product Management**: With the robust eCommerce platform that comes with a full-featured shopping cart, Easy Digital Downloads allows you to sell digital products with ease and manage your online store efficiently. With a user-friendly interface and a variety of customization options, Easy Digital Downloads is an excellent choice for anyone looking to sell digital goods online. 2. **Get paid effortlessly**: Provides flexible payment options, including support for popular payment gateways like OxaPay, PayPal, Stripe, and Google Pay, as well as subscriptions, giving customers a range of options to pay in a way that suits them. 3. **Intelligently designed:** The effects of site design on customer behavior are well-known. Easy Digital Downloads plays its role by including a base style that looks great as-is, but is also ready to integrate with any WordPress theme. 4. **Unlimited file downloads:** Easy Digital Downloads is a platform for selling digital products that does not impose any additional bandwidth charges on file downloads. This means that you can sell and distribute your digital products without worrying about any extra fees based on the amount of data transferred to customers. 5. **Automatic access control:** With Easy Digital Downloads, you can rest easy knowing that our secure file delivery system logs every customer interaction, giving you complete control over your business. [](https://docs.oxapay.com/legacy/integrations/plugins/easy-digital-downloads#oxapay-plugin-for-easy-digital-downloads) OxaPay Plugin For Easy Digital Downloads --------------------------------------------------------------------------------------------------------------------------------------------------------------------- The OxaPay Plugin for Easy Digital Downloads (EDD) is a payment gateway integration that allows digital product sellers to accept payments through OxaPay, a cryptocurrency-based payment system. By integrating this plugin with EDD, store owners can offer their customers the option to pay using various cryptocurrencies, enhancing the flexibility of payment options and catering to a broader audience. The plugin seamlessly integrates into the EDD checkout process, ensuring a smooth and secure transaction experience without compromising usability or security. In addition to offering cryptocurrency payments, the OxaPay plugin provides features like real-time exchange rate conversions, detailed transaction tracking, and automatic payment confirmations, reducing manual tasks for store owners. This plugin is particularly beneficial for businesses looking to expand globally, as it eliminates issues related to traditional currency conversion fees or regional payment restrictions, making it easier to cater to an international customer base. [](https://docs.oxapay.com/legacy/integrations/plugins/easy-digital-downloads#how-to-set-up-oxapay-plugin-for-easy-digital-downloads) How To Set Up OxaPay Plugin For Easy Digital Downloads? -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- 1. Log in to your WordPress control panel, navigate to the "Plugins" section, and click on "Add New". Select "Upload Plugin" then upload the "OxaPay" plugin ZIP file ([Click here to download it](https://downloads.wordpress.org/plugin/oxapay-payment-gateway-for-easy-digital-downloads.1.0.0.zip) ) and click on the"Install Now" button. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F517956072-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FAQc1OXMAl6RP5j6dwH6R%252Fuploads%252FaCedpYTVNSXMBoHEL3xb%252FScreenshot%2520%281313%29.png%3Falt%3Dmedia%26token%3Da3e2dc35-2a49-4f63-a19d-a8168ff1e85c&width=768&dpr=4&quality=100&sign=7af1ecab&sv=2) 1. Once the plugin is installed, click on "Activate Plugin" to enable it. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F517956072-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FAQc1OXMAl6RP5j6dwH6R%252Fuploads%252FJiIGC6AZoqdzsoKxbxUw%252FPrestaShop-Logo.png%3Falt%3Dmedia%26token%3D5e401897-8528-46a4-8211-605439bc4339&width=768&dpr=4&quality=100&sign=ac845dd9&sv=2) 1. Go to your "Easy Digital Downloads" settings and navigate to the Payment section. After activating the OxaPay plugin, in the top bar, you will see an option for OxaPay. Click on it to configure the payment gateway settings. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F517956072-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FAQc1OXMAl6RP5j6dwH6R%252Fuploads%252F88VSW29NauXQigxVCitu%252FScreenshot%2520%281316%29.png%3Falt%3Dmedia%26token%3D432d46dc-06eb-4fc0-b79c-607010657ecf&width=768&dpr=4&quality=100&sign=3a7b6255&sv=2) 1. Enter your OxaPay Merchant API key (You can find this key in your OxaPay dashboard. If you don't have an API key, click here for instructions on how to create one). Complete any other fields. You can use the "sandbox" mode for testing. Once all the details are filled in, click "Save Changes" to finalize the setup. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F517956072-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FAQc1OXMAl6RP5j6dwH6R%252Fuploads%252FP3m56g6s4iLudpRDzRWW%252FScreenshot%2520%281317%29.png%3Falt%3Dmedia%26token%3D0034bf4a-5705-4075-816c-644a46b2a428&width=768&dpr=4&quality=100&sign=f7f2723c&sv=2) #### [](https://docs.oxapay.com/legacy/integrations/plugins/easy-digital-downloads#you-can-download-the-oxapay-plugin-for-easy-digital-downloads-by-clicking-on-the-file-below) You can download the OxaPay plugin for Easy Digital Downloads by clicking on the file below: 120KB [oxapay-payment-gateway-for-easy-digital-downloads.1.0.0.zip](https://517956072-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAQc1OXMAl6RP5j6dwH6R%2Fuploads%2FJbxQHlIekJr9rz7TPiCs%2Foxapay-payment-gateway-for-easy-digital-downloads.1.0.0.zip?alt=media&token=367041c3-73a7-40c4-93fe-005b8a14dc92) archive Download[Open](https://517956072-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAQc1OXMAl6RP5j6dwH6R%2Fuploads%2FJbxQHlIekJr9rz7TPiCs%2Foxapay-payment-gateway-for-easy-digital-downloads.1.0.0.zip?alt=media&token=367041c3-73a7-40c4-93fe-005b8a14dc92) We hope this article was helpful! The OxaPay plugin for Easy Digital Downloads is a powerful and valuable tool that can help take your business to the next level. [PreviousPrestaShop](https://docs.oxapay.com/legacy/integrations/plugins/prestashop) [NextPaid Memberships Pro](https://docs.oxapay.com/legacy/integrations/plugins/paid-memberships-pro) Last updated 1 month ago --- # Paid Memberships Pro | Legacy | OxaPay Docs [](https://docs.oxapay.com/legacy/integrations/plugins/paid-memberships-pro#what-is-paid-memberships-pro) What is Paid Memberships Pro? -------------------------------------------------------------------------------------------------------------------------------------------- Paid Memberships Pro is a popular WordPress plugin designed for managing and selling paid memberships. It allows site administrators to restrict access to content or services based on membership levels, offering exclusive content to paying members. With this plugin, you can set up multiple membership tiers, integrate various payment gateways, and manage access to premium content. [](https://docs.oxapay.com/legacy/integrations/plugins/paid-memberships-pro#key-features-of-paid-memberships-pro) Key Features of Paid Memberships Pro: ------------------------------------------------------------------------------------------------------------------------------------------------------------ 1. **Unlimited Membership Levels**: Create an unlimited number of membership tiers with varying prices and access privileges. Each level can offer unique benefits, allowing you to cater to different types of members or audiences. 2. **Content Restriction**: Restrict access to specific content (such as posts, pages, categories, or custom post types) based on membership status. This lets you offer exclusive content to paying members while keeping general content available to all. 3. **Flexible Payment Gateways**: Integrates seamlessly with popular payment gateways like OxaPay, PayPal, Stripe, and Authorize.net. You can offer different payment methods for your members and manage payments with ease, ensuring a smooth and secure transaction process. 4. **Member Management**: Provides a detailed interface to manage your members, allowing you to view, edit, or update member profiles, change their membership level, or handle billing issues directly from the admin dashboard. 5. **Reports & Analytics**: Track membership statistics with built-in reporting tools that give insights into revenue, active memberships, and overall growth. You can generate custom reports for better decision-making and optimization of your membership strategy. 6. **Email Notifications**: Automate emails for critical events, such as membership signups, renewals, cancellations, and expiration reminders. Customize these email templates to communicate effectively with your members. 7. **Add-ons & Integrations**: Expand the functionality of Paid Memberships Pro with a wide variety of add-ons, like affiliate tracking, WooCommerce integration, or custom member directories. This allows you to scale your membership site and add features as your needs grow. [](https://docs.oxapay.com/legacy/integrations/plugins/paid-memberships-pro#oxapay-plugin-for-paid-memberships-pro) OxaPay Plugin For Paid Memberships Pro --------------------------------------------------------------------------------------------------------------------------------------------------------------- The OxaPay Plugin for Paid Memberships Pr**o** is an extension designed to integrate the OxaPay payment gateway with the Paid Memberships Pro plugin, allowing websites to accept cryptocurrency payments for membership subscriptions. OxaPay is known for facilitating secure and efficient cryptocurrency transactions, offering users the ability to pay with various digital currencies like Bitcoin, Ethereum, and more. This integration expands payment options for membership-based websites, catering to customers who prefer using cryptocurrencies instead of traditional payment methods. With this plugin, website owners can leverage the benefits of blockchain technology, such as faster transactions, lower fees, and broader international reach. The OxaPay plugin ensures a smooth checkout process, providing a seamless experience for members while maintaining compatibility with Paid Memberships Pro. This makes it a valuable solution for businesses seeking to diversify their payment options and attract a global audience. [](https://docs.oxapay.com/legacy/integrations/plugins/paid-memberships-pro#how-to-set-up-oxapay-plugin-for-paid-memberships-pro) How To Set Up OxaPay Plugin For Paid Memberships Pro? -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- 1. Log in to your WordPress control panel, navigate to the "Plugins" section, and click on "Add New". Select "Upload Plugin" then upload the "OxaPay" plugin ZIP file ([Click here to download it](https://oxapay.com/plugins/oxapay_pmpro.zip) ) and click on the"Install Now" button. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F517956072-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FAQc1OXMAl6RP5j6dwH6R%252Fuploads%252FPNRKXBSBGV6vqWZBRMHa%252FScreenshot%2520%289%29.png%3Falt%3Dmedia%26token%3D788b60bd-280f-417a-88ba-2d39f3de3e22&width=768&dpr=4&quality=100&sign=40d694cd&sv=2) 1. Go to your "Paid Memberships Pro" settings and navigate to the "Payment Gateway". ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F517956072-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FAQc1OXMAl6RP5j6dwH6R%252Fuploads%252Fql1HvqoxTktKAztHL9l3%252FScreenshot%2520%2813%29.png%3Falt%3Dmedia%26token%3D28a31ef0-257c-4f0e-a85c-1da039af76f2&width=768&dpr=4&quality=100&sign=5144b3ce&sv=2) 1. Enter your OxaPay Merchant API key (You can find this key in your OxaPay dashboard. If you don't have an API key, click here for instructions on how to create one). Complete any other fields. You can use the "sandbox" mode for testing. Once all the details are filled in, click "Save Settings" to finalize the setup. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F517956072-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FAQc1OXMAl6RP5j6dwH6R%252Fuploads%252FlOkeHxyr4FfH7Dio3oI6%252FScreenshot%2520%2812%29.png%3Falt%3Dmedia%26token%3D397a38dd-6810-4a08-bb33-ea8d756347bf&width=768&dpr=4&quality=100&sign=86203788&sv=2) #### [](https://docs.oxapay.com/legacy/integrations/plugins/paid-memberships-pro#you-can-download-the-oxapay-plugin-for-paid-memberships-pro-by-clicking-on-the-file-below) You can download the OxaPay plugin for Paid Memberships Pro by clicking on the file below: 22KB [oxapay-crypto-gateway-for-paid-memberships-pro.1.0.0.zip](https://517956072-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAQc1OXMAl6RP5j6dwH6R%2Fuploads%2F2I5SjQ20FFpOXOgMgJTd%2Foxapay-crypto-gateway-for-paid-memberships-pro.1.0.0.zip?alt=media&token=8949807d-f799-45d9-9f81-0cc6c6cf4e6d) archive Download[Open](https://517956072-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAQc1OXMAl6RP5j6dwH6R%2Fuploads%2F2I5SjQ20FFpOXOgMgJTd%2Foxapay-crypto-gateway-for-paid-memberships-pro.1.0.0.zip?alt=media&token=8949807d-f799-45d9-9f81-0cc6c6cf4e6d) We hope this article was helpful! The OxaPay plugin for Paid Memberships Pro is a powerful and valuable tool that can help take your business to the next level. [PreviousEasy Digital Downloads](https://docs.oxapay.com/legacy/integrations/plugins/easy-digital-downloads) [NextGravity Forms](https://docs.oxapay.com/legacy/integrations/plugins/gravity-forms) Last updated 1 month ago --- # Gravity Forms | Legacy | OxaPay Docs [](https://docs.oxapay.com/legacy/integrations/plugins/gravity-forms#what-is-gravity-forms) What is Gravity Forms? ----------------------------------------------------------------------------------------------------------------------- Gravity Forms is a powerful WordPress plugin that allows users to create advanced and customizable forms with ease. It’s ideal for building contact forms, surveys, registrations, online payments, and more. Key features include a drag-and-drop interface, integration with third-party services (like OxaPay and PayPal ), and conditional logic to enhance user experience. [](https://docs.oxapay.com/legacy/integrations/plugins/gravity-forms#key-features-of-gravity-forms) Key Features of Gravity Forms: --------------------------------------------------------------------------------------------------------------------------------------- 1. **Ease of Use:** Gravity Forms provides a user-friendly drag-and-drop form builder, allowing you to create professional forms in minutes without requiring technical expertise. 2. **Seamless WordPress Integration:** As a WordPress plugin, Gravity Forms integrates effortlessly with WordPress, enabling smooth performance and leveraging all of WordPress’s capabilities. 3. **Customizable Forms:** With extensive field options and advanced settings, you can create contact forms, surveys, payment forms, registration forms, and more to suit your exact needs. 4. **Payment Integrations:** Gravity Forms supports major payment gateways like OxaPay, PayPal, and Stripe, making it easy to accept payments, donations, or subscriptions directly through your forms. 5. **Notifications and Confirmations :**Automate email notifications to inform both users and administrators upon form submissions, and customize confirmation messages or redirects to enhance user engagement. 6. **Responsive Design:** Forms created with Gravity Forms are mobile-friendly and responsive, ensuring they function perfectly across all devices, including tablets and smartphones. [](https://docs.oxapay.com/legacy/integrations/plugins/gravity-forms#oxapay-plugin-for-gravity-forms) OxaPay Plugin For Gravity Forms ------------------------------------------------------------------------------------------------------------------------------------------ Integrating OxaPay with Gravity Forms is a strategic way to enhance your payment options and reach a broader audience. The OxaPay integration enables businesses to seamlessly accept cryptocurrency payments directly through Gravity Forms, offering customers greater flexibility and modernizing your payment process. Additionally, OxaPay prioritizes security, ensuring that every transaction is safe, reliable, and protected. By adding cryptocurrency as a payment option inGravity Forms, businesses can attract a wider customer base while streamlining their payment workflows and improving the overall user experience. [](https://docs.oxapay.com/legacy/integrations/plugins/gravity-forms#how-to-set-up-oxapay-plugin-for-gravity-forms) How To Set Up OxaPay Plugin For Gravity Forms? ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- 1. Log in to your WordPress control panel, navigate to the "Plugins" section, and click on "Add New". Select "Upload Plugin" then upload the "OxaPay" plugin ZIP file ([Click here to download it](https://downloads.wordpress.org/plugin/oxapay-crypto-payment-gateway-for-gravity-forms.1.0.0.zip) ) and click on the"Install Now" button. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F517956072-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FAQc1OXMAl6RP5j6dwH6R%252Fuploads%252FFSunSCN1Ru1ko1yp7SuL%252FScreenshot%2520%2858%29.png%3Falt%3Dmedia%26token%3Dd9648e78-5664-4889-a917-78918985b744&width=768&dpr=4&quality=100&sign=c2e18ef4&sv=2) 1. After installing and activating the OxaPay plugin, go to the "**Gravity Forms"** settings page and click on OxaPay to enter your OxaPay Merchant API key (You can find this key in your OxaPay dashboard. If you don't have an API key, [click here](https://docs.oxapay.com/legacy/integrations/merchant-api) for instructions on how to create one). Complete any other required fields. You can use the "sandbox" mode for testing. Once all the details are filled in, click "Save Settings" to finalize the setup. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F517956072-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FAQc1OXMAl6RP5j6dwH6R%252Fuploads%252FT8eOA4P2enR6vFnV6GzZ%252FScreenshot%2520%2854%29.png%3Falt%3Dmedia%26token%3D5e7ea790-5ffb-4ffe-8cdb-61c93dd6d002&width=768&dpr=4&quality=100&sign=c16fca1e&sv=2) 1. Now click on "OxaPay" in the navigation bar and to add your form, click on "Add New". ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F517956072-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FAQc1OXMAl6RP5j6dwH6R%252Fuploads%252Fn6n5ukfpqL9bOXrPiJSk%252FScreenshot%2520%2855%29.png%3Falt%3Dmedia%26token%3Db6afdd4c-634d-4dd6-96e1-ed11a36e4d1d&width=768&dpr=4&quality=100&sign=d6640e80&sv=2) 1. After entering the "Add New Form" page, select the form type, choose your desired form and click the "Save" button. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F517956072-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FAQc1OXMAl6RP5j6dwH6R%252Fuploads%252FliORasglWvDf83Qd3yZv%252FScreenshot%2520%2856%29.png%3Falt%3Dmedia%26token%3D0e1cd5a4-826f-4ece-88a6-1c2277579207&width=768&dpr=4&quality=100&sign=d5c5ca04&sv=2) **You can download the OxaPay plugin for Gravity Forms by clicking on the file below:** 38KB [oxapay-crypto-payment-gateway-for-gravity-forms.1.0.0.zip](https://517956072-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAQc1OXMAl6RP5j6dwH6R%2Fuploads%2F8zg7Q3SYy1X3cDQ5EWVD%2Foxapay-crypto-payment-gateway-for-gravity-forms.1.0.0.zip?alt=media&token=be885715-237a-4aaa-9055-e0e8e0574872) archive Download[Open](https://517956072-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAQc1OXMAl6RP5j6dwH6R%2Fuploads%2F8zg7Q3SYy1X3cDQ5EWVD%2Foxapay-crypto-payment-gateway-for-gravity-forms.1.0.0.zip?alt=media&token=be885715-237a-4aaa-9055-e0e8e0574872) We hope you found this article useful! The OxaPay plugin for Gravity Forms is a powerful tool that can help elevate your business to new heights. Last updated 1 month ago --- # PrestaShop | Legacy | OxaPay Docs [](https://docs.oxapay.com/legacy/integrations/plugins/prestashop#what-is-prestashop) What is PrestaShop? -------------------------------------------------------------------------------------------------------------- PrestaShop is an open-source e-commerce platform used to create and manage online stores. It allows users to build a fully customizable online shop with features for inventory management, payment processing, and shipping. PrestaShop is popular for small to medium-sized businesses due to its flexibility and a large marketplace of add-ons and themes. [](https://docs.oxapay.com/legacy/integrations/plugins/prestashop#key-features-of-prestashop) Key Features of PrestaShop: ------------------------------------------------------------------------------------------------------------------------------ 1. **Customizable Storefront**: PrestaShop provides an extensive selection of themes and templates, enabling merchants to fully personalize the appearance of their online stores. From color schemes to layout designs, everything is customizable to create a unique brand experience. 2. **Product Management**: Managing your product catalog is made simple with robust tools that allow easy addition and organization of products. You can create detailed product listings with attributes such as size, color, and material, manage variations. 3. **Multi-Language Support**: PrestaShop is built to cater to global markets by offering support for multiple languages and currencies. This enables businesses to sell to international customers, improving accessibility and boosting sales. 4. **Payment Gateway Integration**: The platform integrates with a wide range of popular payment gateways, including OxaPay, PayPal, Stripe, and many others. This flexibility allows customers to choose their preferred payment method, improving conversion rates. 5. **Advanced Reporting & Analytics**: The platform includes powerful reporting and analytics tools that provide in-depth insights into your store’s performance. You can access detailed sales reports, track customer behavior, monitor key performance indicators (KPIs), and analyze customer data to make informed business decisions. [](https://docs.oxapay.com/legacy/integrations/plugins/prestashop#oxapay-plugin-for-prestashop) OxaPay Plugin For PrestaShop --------------------------------------------------------------------------------------------------------------------------------- Integrating OxaPay with PrestaShop is a powerful step to grow your business and reach new heights. The OxaPay plugin for PrestaShop allows merchants to seamlessly accept cryptocurrency payments, opening up new possibilities for expanding your customer base and offering greater payment flexibility. Enabling the OxaPay plugin on the PrestaShop platform improves operational efficiency and enhances customer experience by providing fast, low-fee crypto transactions as a fully integrated payment method. [](https://docs.oxapay.com/legacy/integrations/plugins/prestashop#how-to-set-up-oxapay-plugin-for-prestashop) How To Set Up OxaPay Plugin For PrestaShop? -------------------------------------------------------------------------------------------------------------------------------------------------------------- 1. First, after logging into your PrestaShop admin panel, locate the "Modules" tab. Click on it, then select "Module Manager" from the dropdown menu. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F517956072-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FAQc1OXMAl6RP5j6dwH6R%252Fuploads%252FjMA7V84doFz9dd6ByVr7%252FScreenshot%2520%281280%29.png%3Falt%3Dmedia%26token%3Deb38f894-01a1-49b6-860c-9b8999c56dc5&width=768&dpr=4&quality=100&sign=fd45ec44&sv=2) 1. Next, click on the "Upload a module" button and upload the OxaPay plugin file ([Click here to download it](https://github.com/OxaPay/oxapay-prestashop/archive/refs/tags/v1.0.0.zip) ). ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F517956072-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FAQc1OXMAl6RP5j6dwH6R%252Fuploads%252FDju2mwJ0UCY3VGH5hOxs%252FScreenshot%2520%281279%29.png%3Falt%3Dmedia%26token%3D03c12cfa-bcde-4a8d-a357-917772b6012d&width=768&dpr=4&quality=100&sign=3da15ef6&sv=2) 1. The module installation will begin automatically. Once you see the message "Module installed" and the "Configure" button appears, click it to proceed. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F517956072-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FAQc1OXMAl6RP5j6dwH6R%252Fuploads%252FVDnA48lMXNXaxD6mw3Op%252FScreenshot%2520%281281%29.png%3Falt%3Dmedia%26token%3Def127ce8-dedb-41a4-a2a2-4ad16b8772f3&width=768&dpr=4&quality=100&sign=fec1112a&sv=2) 1. Enter your OxaPay Merchant API key (You can find this key in your OxaPay dashboard. If you don't have an API key, [click here](https://docs.oxapay.com/legacy/integrations/merchant-api) for instructions on how to create one). Complete any other field. You can use the "sandbox" mode for testing. Once all the details are filled in, click "Save" to finalize the setup. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F517956072-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FAQc1OXMAl6RP5j6dwH6R%252Fuploads%252Fn8SwWpc5osiO5H9iD67w%252FScreenshot%2520%281284%29.png%3Falt%3Dmedia%26token%3D8473fcae-d8bf-4b45-95e0-2535ca588b40&width=768&dpr=4&quality=100&sign=4b6af18&sv=2) #### [](https://docs.oxapay.com/legacy/integrations/plugins/prestashop#you-can-download-the-oxapay-plugin-for-prestashop-by-clicking-on-the-file-below) You can download the OxaPay plugin for PrestaShop by clicking on the file below: 53KB [oxapay\_prestashop.zip](https://517956072-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAQc1OXMAl6RP5j6dwH6R%2Fuploads%2FFJlXUHDys9yxlZCwzPNi%2Foxapay_prestashop.zip?alt=media&token=80bcb5dc-6064-4b77-befa-97493c52fb91) archive Download[Open](https://517956072-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAQc1OXMAl6RP5j6dwH6R%2Fuploads%2FFJlXUHDys9yxlZCwzPNi%2Foxapay_prestashop.zip?alt=media&token=80bcb5dc-6064-4b77-befa-97493c52fb91) We hope you found this article helpful! The OxaPay plugin for PrestaShop is a powerful tool that can elevate your business to new heights. [PreviousWHMCS](https://docs.oxapay.com/legacy/integrations/plugins/whmcs) [NextEasy Digital Downloads](https://docs.oxapay.com/legacy/integrations/plugins/easy-digital-downloads) Last updated 1 month ago --- # WHMCS | Legacy | OxaPay Docs [](https://docs.oxapay.com/legacy/integrations/plugins/whmcs#what-is-whmcs) What is WHMCS? ----------------------------------------------------------------------------------------------- WHMCS (Web Host Manager Complete Solution) is a comprehensive web hosting management and billing software designed for online businesses. It automates various aspects of web hosting operations, such as client management, billing, support, and domain registration. [](https://docs.oxapay.com/legacy/integrations/plugins/whmcs#key-features-of-whmcs) Key Features of WHMCS : ---------------------------------------------------------------------------------------------------------------- 1. **Support System**: WHMCS includes a built-in support ticket system, knowledge base, and support department routing. This helps in managing customer support requests efficiently and provides a streamlined way for clients to get help. 2. **Billing Automation**: WHMCS automates invoicing, payment processing, and reminders. It supports multiple currencies and integrates with numerous payment gateways like PayPal, Stripe, and others, making it easier for web hosting companies to manage their billing. 3. **Domain Management**: The platform allows users to register, transfer, and manage domain names directly through WHMCS. It integrates with a wide range of domain registrars, enabling automated provisioning and management of domain services. 4. **Automation**: WHMCS automates many tasks related to provisioning hosting accounts and managing renewals. This reduces the workload on administrators and improves service delivery speed. 5. **Reporting and Analytics**: The platform provides detailed reports and analytics to track business performance, including sales, revenue, and customer activity. 6. **Client Management**: It offers a complete client management interface, allowing businesses to manage client accounts, track order history, and handle communications efficiently. Clients can also log into a self-service portal to manage their services, pay invoices, and contact support. [](https://docs.oxapay.com/legacy/integrations/plugins/whmcs#oxapay-plugin-for-whmcs) OxaPay Plugin For WHMCS ------------------------------------------------------------------------------------------------------------------ Integrating OxaPay with WHMCS is a smart move to elevate your business to new heights. The OxaPay plugin for WHMCS allows businesses to accept cryptocurrency as a fully integrated payment option, expanding your customer base and offering greater payment flexibility. The OxaPay plugin ensures that businesses can process payments quickly, with minimal transaction fees, and without the traditional delays associated with fiat currencies. This helps attract a broader audience, including customers who prefer using cryptocurrencies for their online purchases. Additionally, OxaPay's strong security features provide peace of mind, ensuring that every transaction is safe and reliable. [](https://docs.oxapay.com/legacy/integrations/plugins/whmcs#how-to-set-up-oxapay-plugin-for-whmcs) How To Set Up OxaPay Plugin For WHMCS? ----------------------------------------------------------------------------------------------------------------------------------------------- 1. First, unzip the downloaded OxaPay plugin archive ([Click here to download it](https://github.com/OxaPay/oxapay-whmcs/releases/download/v1.0.0/oxapay_whmcs.zip) ) to your computer or directly on your hosting server. 2. Locate the "oxapaygateway" folder and the "oxapaygateway.php" file from the unzipped archive. Move these to the following directory on your WHMCS installation: "_WHMCS → modules → gateways"._ 3. Transfer the Callback File: Next, find the **oxapaygateway.php** file located in the "callback" folder. Transfer this file to the following path on your WHMCS installation: _"WHMCS → modules → gateways → callback"._ 4. Now, hover over the settings icon, then select "Apps And Integrations" from the menu. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F517956072-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FAQc1OXMAl6RP5j6dwH6R%252Fuploads%252F5HWqj4oVs0fYoqFqXoen%252FScreenshot%2520%281242%29.png%3Falt%3Dmedia%26token%3D1b8706c0-cc11-421d-9caa-7e6d05ec9a37&width=768&dpr=4&quality=100&sign=233cdddd&sv=2) 1. Navigate to the "Search" tab and enter "OxaPay" in the search bar. In the results window that appears, click on "Activate" and proceed to the plugin settings. 2. Now, enter your “OxaPay Merchant API Key” in the designated field. You can find this key in your OxaPay panel. If you don't have an API key, [click here](https://docs.oxapay.com/legacy/integrations/merchant-api) to learn how to create one, or you can use the “sandbox” mode for testing purposes. After entering your API key, complete the remaining configuration settings and click on “Save Changes”. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F517956072-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FAQc1OXMAl6RP5j6dwH6R%252Fuploads%252FPBW3m2MLmJYlaU1fHtvJ%252FScreenshot%2520%281246%29.png%3Falt%3Dmedia%26token%3D239f2f80-8157-42a7-8162-0a2f07e35041&width=768&dpr=4&quality=100&sign=e6ddd640&sv=2) #### [](https://docs.oxapay.com/legacy/integrations/plugins/whmcs#you-can-download-the-oxapay-plugin-for-whmcs-by-clicking-on-the-file-below) You can download the OxaPay plugin for WHMCS by clicking on the file below: 44KB [oxapay\_whmcs.zip](https://517956072-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAQc1OXMAl6RP5j6dwH6R%2Fuploads%2FR3kGSfr0H04rQMVVv3g0%2Foxapay_whmcs.zip?alt=media&token=f69830d8-40c9-4a93-9da0-f73424fd41e1) archive Download[Open](https://517956072-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAQc1OXMAl6RP5j6dwH6R%2Fuploads%2FR3kGSfr0H04rQMVVv3g0%2Foxapay_whmcs.zip?alt=media&token=f69830d8-40c9-4a93-9da0-f73424fd41e1) We hope this article was helpful to you! The OxaPay plugin for WHMCS is a powerful and valuable tool that can elevate your business to the next level. [PreviousBlesta](https://docs.oxapay.com/legacy/integrations/plugins/blesta) [NextPrestaShop](https://docs.oxapay.com/legacy/integrations/plugins/prestashop) Last updated 1 month ago --- # WISECP | Legacy | OxaPay Docs [](https://docs.oxapay.com/legacy/integrations/plugins/wisecp#what-is-wisecp) What is WISECP? -------------------------------------------------------------------------------------------------- WISECP is a next generation hosting and digital solutions automation. It includes a client area, admin area and a website interface. It has been developed for companies operating in the field of information technologies. With WISECP, all invoicing transactions, accounting (cash, income, expense) records, client management, product management, support services and many other operations can be carried out easily. [](https://docs.oxapay.com/legacy/integrations/plugins/wisecp#key-features-of-wisecp) Key Features of WISECP: ------------------------------------------------------------------------------------------------------------------ 1. **Client Management**: WISECP allows you to easily manage your client information, issue invoices, and view payment history. 2. **Invoicing and Payments**: The platform enables automatic invoicing and payment management for clients, supporting various payment gateways. 3. **Service Automation**: WISECP can automate the provisioning of web hosting, domain registration, and other services to clients. It handles the necessary configurations and sends access information to clients automatically. 4. **Support and Ticketing**: WISECP includes a ticket management system that helps you respond to client requests and issues, ensuring more effective customer support. 5. **Client Portal**: Your clients can manage their services, pay invoices, and communicate with your support team through a web-based client portal. 6. **Reporting and Analytics**: WISECP provides various tools for generating reports on business performance, financial status, and client information, helping you make better decisions to improve your business. [](https://docs.oxapay.com/legacy/integrations/plugins/wisecp#oxapay-plugin-for-wisecp) OxaPay Plugin For WISECP --------------------------------------------------------------------------------------------------------------------- The integration of OxaPay with WISECP is a valuable opportunity to expand your business horizons and achieve new milestones. The OxaPay plugin for WISECP allows businesses to accept cryptocurrency as a complete payment method, thereby expanding the customer base and enhancing convenience. Using WISECP helps you automate your business operations in the most efficient way. By enabling the OxaPay plugin on the WISECP platform, you can increase effectiveness and customer engagement by facilitating all types of crypto transactions with minimal fees and in the shortest possible time. [](https://docs.oxapay.com/legacy/integrations/plugins/wisecp#how-to-set-up-oxapay-plugin-for-wisecp) How To Set Up OxaPay Plugin For WISECP? -------------------------------------------------------------------------------------------------------------------------------------------------- 1. To install the OxaPay plugin ([Click here to download it](https://github.com/OxaPay/oxapay-wisecp/archive/refs/tags/v1.0.0.zip) ) for WISECP, move the plugin folder to the following path _“WISECP → coremio → modules → payment”_. 2. Go to the WISECP admin panel and _“n_avigate to setting _→ billing → payment gateways”._ ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F517956072-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FAQc1OXMAl6RP5j6dwH6R%252Fuploads%252FGte3iBieCJ1yjNlmvOVl%252FScreenshot%2520%281162%29.png%3Falt%3Dmedia%26token%3Dc6263d29-c855-42ff-832b-9ec86892d9a9&width=768&dpr=4&quality=100&sign=30d9e501&sv=2) 1. Now, simply search for "OxaPay" in the "Enabled Module Selection" section and click on it. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F517956072-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FAQc1OXMAl6RP5j6dwH6R%252Fuploads%252FSDDOv01wBAPVZO05luf7%252FScreenshot%2520%281201%29.png%3Falt%3Dmedia%26token%3Dd866f6ba-97ae-4703-beeb-2d6be562a9f1&width=768&dpr=4&quality=100&sign=c1782705&sv=2) 1. Next, go to the "All Modules" section, type "OxaPay" in the search bar, and click on "OxaPay" in the search results. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F517956072-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FAQc1OXMAl6RP5j6dwH6R%252Fuploads%252FCxIhl0eVJy3O77QEZ1j7%252FScreenshot%2520%281164%29.png%3Falt%3Dmedia%26token%3D1c5de3b5-aa78-4429-a0b5-3d201a55c97f&width=768&dpr=4&quality=100&sign=a2c5dbc2&sv=2) 1. Now, enter your "OxaPay Merchant API Key" in the designated field (you can find it in your OxaPay panel. If you don’t have an API key, [click here](https://docs.oxapay.com/legacy/integrations/merchant-api) to learn how to create one, or you can use the "sandbox" mode for testing). Complete the remaining configurations, and then click on "Save Settings". ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F517956072-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FAQc1OXMAl6RP5j6dwH6R%252Fuploads%252FgZxBVqPZfIvqfaaJHBUq%252FScreenshot%2520%281165%29.png%3Falt%3Dmedia%26token%3D40521fae-0a67-4b88-b692-dc8d96450cb3&width=768&dpr=4&quality=100&sign=94092efd&sv=2) #### [](https://docs.oxapay.com/legacy/integrations/plugins/wisecp#you-can-download-the-oxapay-plugin-for-wisecp-by-clicking-on-the-file-below) You can download the OxaPay plugin for WISECP by clicking on the file below: 17KB [oxapay\_wisecp.zip](https://517956072-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAQc1OXMAl6RP5j6dwH6R%2Fuploads%2FqgNAnm2SsrXe2Ik1K3u9%2Foxapay_wisecp.zip?alt=media&token=0931d6c3-a722-4ee5-91e2-a37d76016cfd) archive Download[Open](https://517956072-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAQc1OXMAl6RP5j6dwH6R%2Fuploads%2FqgNAnm2SsrXe2Ik1K3u9%2Foxapay_wisecp.zip?alt=media&token=0931d6c3-a722-4ee5-91e2-a37d76016cfd) We hope this article was helpful to you! The WISECP plugin by OxaPay is a powerful and valuable tool to elevate your business to the next level. Last updated 1 month ago --- # Clientexec | Legacy | OxaPay Docs [](https://docs.oxapay.com/legacy/integrations/plugins/clientexec#what-is-clientexec) What is Clientexec? -------------------------------------------------------------------------------------------------------------- Clientexec is a comprehensive billing and client management platform designed specifically for web hosting businesses. It allows companies to automate and streamline various aspects of their operations, including invoicing, customer management, and support. [](https://docs.oxapay.com/legacy/integrations/plugins/clientexec#key-features-of-clientexec) Key Features of Clientexec: ------------------------------------------------------------------------------------------------------------------------------ 1. **Automated Billing**: Manages invoicing, recurring payments, and integrates with multiple payment gateways, streamlining financial transactions. 2. **Client Management**: Provides tools for customer support, including a ticketing system, and a customizable client portal where users can manage their accounts and services. 3. **Service Management**: Automates the provisioning of services such as hosting accounts and domain registrations. It also supports customizable order forms for different products. 4. **Customization and Extensibility**: Offers API access, plugin support, and custom fields to tailor the platform to specific business needs. 5. **Security**: Features robust user permissions and SSL support to ensure data security and controlled access. 6. **User Interface**: The platform is designed with a responsive, mobile-friendly interface for both admin and client areas, improving usability across devices. [](https://docs.oxapay.com/legacy/integrations/plugins/clientexec#oxapay-plugin-for-clientexec) OxaPay Plugin For Clientexec --------------------------------------------------------------------------------------------------------------------------------- Integrating OxaPay with Clientexec is a strategic move to expand your business and reach new milestones. The OxaPay plugin for Clientexec enables businesses to accept cryptocurrency as a full-fledged payment method, thereby broadening your customer base and enhancing payment convenience. By using Clientexec, you can automate various aspects of your business operations efficiently. Enabling the OxaPay plugin on the Clientexec platform increases operational effectiveness and boosts customer engagement by facilitating crypto transactions with minimal fees and in the shortest time possible. [](https://docs.oxapay.com/legacy/integrations/plugins/clientexec#how-to-set-up-oxapay-plugin-for-clientexec) How To Set Up OxaPay Plugin For Clientexec? -------------------------------------------------------------------------------------------------------------------------------------------------------------- 1. To install the OxaPay plugin ([Click here to download it](https://github.com/OxaPay/oxapay-clientexec/archive/refs/tags/v1.0.0.zip) ) for Clientexec, move the plugin folder to the following path _“Clientexec → plugins → gateways ”._ 2. The next step is to navigate to the web interface on Clientexec. Hover over the "Settings" tab in the top menu. Then, under the "Plugins" section, click on "Payment Processors." ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F517956072-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FAQc1OXMAl6RP5j6dwH6R%252Fuploads%252FaxUIiMM1b9Hcg5B3FJ0t%252FScreenshot%2520%281167%29.png%3Falt%3Dmedia%26token%3Ded42bd9e-dc1b-47b0-8359-5892182bab35&width=768&dpr=4&quality=100&sign=5ea83ca2&sv=2) 1. Now that you are on the “Payment Processors” page, type "OxaPay" in the dropdown menu. When "OxaPay" appears, click on it to proceed to the plugin settings page. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F517956072-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FAQc1OXMAl6RP5j6dwH6R%252Fuploads%252FyHfB6oV0gyht2wD926Fh%252FScreenshot%2520%281172%29.png%3Falt%3Dmedia%26token%3Da37bc1e2-fccd-47c2-a873-ac92f7c96c9a&width=768&dpr=4&quality=100&sign=5cc1ed85&sv=2) 1. Now, enter your "OxaPay merchant API key" in the designated field (you can find it in your OxaPay panel. If you don’t have an API key, [click here](https://docs.oxapay.com/legacy/integrations/merchant-api) to learn how to create one, or you can use the "sandbox" mode for testing). Complete the remaining configurations, and then click on "Update Settings". ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F517956072-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FAQc1OXMAl6RP5j6dwH6R%252Fuploads%252F3jofyosvXKj20UEsF1ha%252FScreenshot%2520%281170%29.png%3Falt%3Dmedia%26token%3D5c0dbac9-af23-4e8a-a51b-2eb94e667129&width=768&dpr=4&quality=100&sign=d9ae4832&sv=2) #### [](https://docs.oxapay.com/legacy/integrations/plugins/clientexec#you-can-download-the-oxapay-plugin-for-clientexec-by-clicking-on-the-file-below) You can download the OxaPay plugin for Clientexec by clicking on the file below: 5KB [oxapay\_clientexec.zip](https://517956072-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAQc1OXMAl6RP5j6dwH6R%2Fuploads%2F0iD5l3gCfslO9zjJ2XB6%2Foxapay_clientexec.zip?alt=media&token=8d1d216f-8242-4651-8410-353848bdaeaa) archive Download[Open](https://517956072-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAQc1OXMAl6RP5j6dwH6R%2Fuploads%2F0iD5l3gCfslO9zjJ2XB6%2Foxapay_clientexec.zip?alt=media&token=8d1d216f-8242-4651-8410-353848bdaeaa) We hope this article was helpful to you! The OxaPay plugin for Clientexec is a powerful and valuable tool to elevate your business to the next level. Last updated 1 month ago --- # Restrict Content Pro | Legacy | OxaPay Docs [](https://docs.oxapay.com/legacy/integrations/plugins/restrict-content-pro#what-is-restrict-content-pro) What is Restrict Content Pro? -------------------------------------------------------------------------------------------------------------------------------------------- Restrict Content Pro is a powerful WordPress membership plugin that allows you to monetize content access. As a content restriction plugin, Restrict Content gives you full control over who can and cannot view content on your WordPress site. As a design tool, Restrict Content helps you create pages that dynamically display content based on user role or membership level. [](https://docs.oxapay.com/legacy/integrations/plugins/restrict-content-pro#key-features-of-restrict-content-pro) Key Features of Restrict Content Pro: ------------------------------------------------------------------------------------------------------------------------------------------------------------ 1. **Membership Levels:** Set access level, duration (in days, months, years), number of renewals, price, signup fee, status, assign WordPress user role. Set any price (including free) or optionally set a sign up fee. Set the frequency and period, and specify a user role that will be assigned to members when they register. 2. **Auto-Created Member Pages:** Pages generated by the plugin include: Registration, Success, Account, Edit Profile and Update Billing Card. 3. **Auto Renewals:** Select to let customer choose whether to auto renew, always auto renew, or never auto renew. 4. **Payment Gateways:** The system supports various payment gateways including OxaPay, PayPal, Authorize.net, Braintree, and Manual Payments. This ensures secure and diverse options for processing transactions. 5. **Member Emails:** Paid membership activation email, free membership activation email, cancelled membership email, expired membership email, payment received email, renewal payment failed email 6. **Upgrade/Downgrade Membership:** Members can easily upgrade or downgrade their subscription at any time. This ensures they have control over their plan. [](https://docs.oxapay.com/legacy/integrations/plugins/restrict-content-pro#oxapay-plugin-for-restrict-content-pro) OxaPay Plugin For Restrict Content Pro --------------------------------------------------------------------------------------------------------------------------------------------------------------- Integrating OxaPay with Restrict Content is an excellent way to modernize your payment system and expand your reach. This integration allows businesses to effortlessly accept cryptocurrency payments for membership plans and flexible payment solution. OxaPay ensures that all transactions are handled with top-tier security, providing a safe and reliable payment experience for both businesses and customers. By enabling cryptocurrency payments in Restrict Content, you can attract an audience, simplify payment management, and enhance the overall experience for your members. [](https://docs.oxapay.com/legacy/integrations/plugins/restrict-content-pro#how-to-set-up-oxapay-plugin-for-restrict-content-pro) How To Set Up OxaPay Plugin For Restrict Content Pro? -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- 1. Log in to your WordPress control panel, navigate to the "Plugins" section, and click on "Add New". Select "Upload Plugin" then upload the "OxaPay" plugin ZIP file ([Click here to download it](https://oxapay.com/plugins/oxapay_restrictcontentpro.zip) ) and click on the"Install Now" button. ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F517956072-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FAQc1OXMAl6RP5j6dwH6R%252Fuploads%252Fv12XeV8lbmK7ekp0nPyw%252FScreenshot%2520%2866%29.png%3Falt%3Dmedia%26token%3Dd8ed13fa-8ab8-46fd-8127-94402c84a7ba&width=768&dpr=4&quality=100&sign=f8500951&sv=2) 1. After installing and activating the Oxapay plugin, go to the "**Restrict Content"** settings page and click on Payments to enter your OxaPay Merchant API key (You can find this key in your OxaPay dashboard. If you don't have an API key, [click here](https://docs.oxapay.com/legacy/integrations/merchant-api) for instructions on how to create one). Complete any other fields. You can use the "sandbox" mode for testing. Once all the details are filled in, click "Save Settings" to finalize the setup. (Make sure to check OxaPay in the "Enabled Gateways" section) ![](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F517956072-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FAQc1OXMAl6RP5j6dwH6R%252Fuploads%252FVKR2azSNpUP7hEnnPxF2%252FScreenshot%2520%2869%29.png%3Falt%3Dmedia%26token%3D1a4c5958-fbb3-4068-9473-c23c61cc56ad&width=768&dpr=4&quality=100&sign=18d0d8bb&sv=2) **You can download the OxaPay plugin for Restrict Content Pro by clicking on the file below:** 10KB [oxapay-crypto-payment-gateway-for-restrict-content.zip](https://517956072-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAQc1OXMAl6RP5j6dwH6R%2Fuploads%2F3rUlWDvBTXMJHePcS6cq%2Foxapay-crypto-payment-gateway-for-restrict-content.zip?alt=media&token=d5e9319c-3e3a-43b1-bc51-e0b1e7ab0367) archive Download[Open](https://517956072-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAQc1OXMAl6RP5j6dwH6R%2Fuploads%2F3rUlWDvBTXMJHePcS6cq%2Foxapay-crypto-payment-gateway-for-restrict-content.zip?alt=media&token=d5e9319c-3e3a-43b1-bc51-e0b1e7ab0367) We hope you found this article useful! The OxaPay plugin for Restrict Content is a powerful tool that can help elevate your business to new heights. Last updated 1 month ago --- # API Reference | Legacy | OxaPay Docs The API Reference provides detailed information on the various endpoints and functionalities available in the OxaPay API. This section serves as a comprehensive guide to help you integrate the OxaPay Crypto Payment Gateway seamlessly into your application or website. By referring to the API Reference, you can gain a comprehensive understanding of the OxaPay API and leverage its capabilities to create a seamless payment experience for your users. Whether you need to initiate payments, retrieve payment details, or manage transactions, the API Reference provides the necessary documentation to facilitate successful integration. Now, let's dive into the API Reference section, where you'll find detailed information on each endpoint, their request and response formats, and example code snippets to assist you in integrating the OxaPay Crypto Payment Gateway seamlessly. [PreviousMerchant and Payout Service with API](https://docs.oxapay.com/legacy/integrations/merchant-and-payout-service-with-api) [NextCreating an Invoice](https://docs.oxapay.com/legacy/api-reference/creating-an-invoice) Last updated 1 year ago --- # Payout Information | Legacy | OxaPay Docs Use the Payout Information endpoint to retrieve the details of a specific payment by its trackId. After creating an invoice, you will receive a TrackId, which you can use to make payment information requests. `POST` `https://api.oxapay.com/api/inquiry` #### [](https://docs.oxapay.com/legacy/api-reference/payout-information#request-body) Request Body Name Type Description key\* string Your payout API key for authentication and authorization. trackId\* integer The unique identifier of each payout request from OxaPay. Use this TrackId to query the payout status and obtain detailed payout information. 200: OK Copy { "result": integer, // The result code indicates the success or failure of the request. "message": string, // A message providing additional information about the result. "trackId": string, // The unique identifier of the payment session. "address": string, // The recipient's cryptocurrency address for the payout. "currency": string, // The cryptocurrency symbol of the payout. "network": string, // The blockchain network associated with the cryptocurrency. "amount": string, // The amount of cryptocurrency sent in the payout. "fee": string, // The transaction fee (if any) associated with the payout. "status": string, // The status of the payout transaction (e.g., \"Complete\", \"Processing\", \"Rejected\"). "type": string, // The type of the payout (e.g., \"internal\" or \"external\"). "txID": string, // The transaction ID of the payout on the blockchain (if available). "date": string, // The timestamp of the payout transaction in Unix time format. "description": string // Additional information or description related to the payout transaction. } Please note that a successful request will return a result code 100. In case of any issues or validation problems, refer to the corresponding [result codes](https://docs.oxapay.com/legacy/api-reference/result-code-table) for further details. ### [](https://docs.oxapay.com/legacy/api-reference/payout-information#example-codes) Example codes cURL PHP Node.js Python Copy curl -X POST https://api.oxapay.com/api/inquiry \ -d '{ "key": "YOUR_PAYOUT_API_KEY", "trackId": TRACK_ID }' Copy 'YOUR_PAUOUT_API_KEY', 'trackId' => 'TRACK_ID' ); $options = array( 'http' => array( 'header' => 'Content-Type: application/json', 'method' => 'POST', 'content' => json_encode($data), ), ); $context = stream_context_create($options); $response = file_get_contents($url, false, $context); $result = json_decode($response); var_dump($result); ?> Copy const axios = require('axios'); const url = 'https://api.oxapay.com/api/inquiry'; const data = JSON.stringify({ key: 'YOUR_PAYOUT_API_KEY', trackId: TRACK_ID }); axios.post(url, data) .then(response => { console.log(response.data); }) .catch(error => { console.error(error); }); Copy import requests import json url = 'https://api.oxapay.com/api/inquiry' data = { 'key': 'YOUR_PAYOUT_API_KEY', 'trackId': TRACK_ID } response = requests.post(url, data=json.dumps(data)) result = response.json() print(result) Please replace `YOUR_PAYOUT_API_KEY` with your actual payout API key, and`TRACK_ID` with the unique identifier of the payout session (TrackId) you want to inquire about. These code snippets demonstrate how to make a POST request to the Payout Information endpoint and handle the response in each respective programming language. [PreviousCreating Payout](https://docs.oxapay.com/legacy/api-reference/creating-payout) [NextPayout History](https://docs.oxapay.com/legacy/api-reference/payout-history) Last updated 2 months ago --- # Price | Legacy | OxaPay Docs By using this endpoint, you can instantly retrieve the current prices of all crypto currencies supported by OxaPay. `POST` `https://api.oxapay.com/api/prices` 200: OK Copy { "result": integer, // The result code indicates the success or failure of the request. "message": string, // A message providing additional information about the result. "data": object // The real-time price of all supported crypto currencies. } Please note that the price provided in the response may fluctuate over time due to the volatile nature of cryptocurrency markets. [PreviousAccepted Coins](https://docs.oxapay.com/legacy/api-reference/accepted-coins) [NextCreating Payout](https://docs.oxapay.com/legacy/api-reference/creating-payout) Last updated 1 year ago --- # Static Wallets List | Legacy | OxaPay Docs Use this endpoint to retrieve a list of static addresses associated with a specific business. The list can be filtered by various criteria, such as trackId, address, network, email and orderId. Pagination is also available to fetch the results in smaller sets. `POST` `https://api.oxapay.com/merchants/list/staticaddress` #### [](https://docs.oxapay.com/legacy/api-reference/static-wallets-list#request-body) Request Body Name Type Description merchant\* String Your merchant API key for authentication and authorization. trackId integer Filter payments by a specific invoice ID. page integer The page number of the results you want to retrieve. Possible values: from 1 to the total number of pages - default 1. size integer Number of records to display per page. Possible values: from 1 to 200. Default: 1. network string Filter payments by the expected [blockchain network](https://docs.oxapay.com/legacy/api-reference/supported-networks) for the specified crypto currency. address string Filter payments by the expected address. It’s better to filter static addresses. email string Filter payments by the email. orderId string Filter payments by a unique order ID for reference. 200: OK Copy { "result": integer, // The result code indicates the success or failure of the request. "message": string, // A message providing additional information about the result. "data": [\ {\ "trackId": string, // The unique identifier of each payment session of the OxaPay payment gateway, which can be used to query the payment status and report requests (if the request is successful).\ "address": string, // The static address.\ "network": string, // The blockchain network associated with the cryptocurrency.\ "callbackUrl": string, // The URL where payment information will be sent. Use this to receive notifications about the payment status.\ "email": string, // The specified email\ "orderId": string, // The specified orderId\ "description": string, // Additional information or description related to the static address.\ "date": string // The timestamp of the static address generation in Unix time format.\ }\ ], "meta": { "size": integer, // The number of static addresses returned in the current page. "page": integer, // The current page number of the result set. "pages": integer, // The total number of pages available based on the number of records and page size. "total": integer // The total number of static addresses available for the specified criteria. } } Please note that a successful request will return a result code 100. In case of any issues or validation problems, refer to the corresponding [result codes](https://docs.oxapay.com/legacy/api-reference/result-code-table) for further details. ### [](https://docs.oxapay.com/legacy/api-reference/static-wallets-list#example-codes) Example codes cURL PHP Node.js Python Copy curl -X POST https://api.oxapay.com/merchants/list/staticaddress \ -d '{ "merchant": "YOUR_MERCHANT_API_KEY", "size": 20, "page": 1 }' Copy 'YOUR_MERCHANT_API_KEY', 'size' => 20, 'page' => 1 ); $options = array( 'http' => array( 'header' => 'Content-Type: application/json', 'method' => 'POST', 'content' => json_encode($data), ), ); $context = stream_context_create($options); $response = file_get_contents($url, false, $context); $result = json_decode($response); var_dump($result); ?> Copy const axios = require('axios'); const url = 'https://api.oxapay.com/merchants/list/staticaddress'; const data = JSON.stringify({ merchant: 'YOUR_MERCHANT_API_KEY', size: 20, page: 1 }); axios.post(url, data) .then(response => { console.log(response.data); }) .catch(error => { console.error(error); }); Copy import requests import json url = 'https://api.oxapay.com/merchants/list/staticaddress' data = { 'merchant': 'YOUR_MERCHANT_API_KEY', 'size': 20, 'page': 1 } response = requests.post(url, data=json.dumps(data)) result = response.json() print(result) Now you have the example code snippets in cURL, PHP, Node.js, and Python for making a request to the Static Wallets List endpoint. [PreviousRevoking Static Wallet](https://docs.oxapay.com/legacy/api-reference/revoking-static-wallet) [NextPayment Information](https://docs.oxapay.com/legacy/api-reference/payment-information) Last updated 11 months ago --- # Payment Information | Legacy | OxaPay Docs Use the Payment Information endpoint to retrieve the details of a specific payment by its TrackId. After creating an invoice, you will receive a TrackId, which you can use to make payment information requests. `POST` `https://api.oxapay.com/merchants/inquiry` #### [](https://docs.oxapay.com/legacy/api-reference/payment-information#request-body) Request Body Name Type Description merchant\* string Your merchant API key for authentication and authorization. trackId\* integer The unique identifier of each payment session in the OxaPay payment gateway. Use this TrackId to query the payment status and obtain detailed payment information. 200: OK Copy { "result": integer, // The result code indicates the success or failure of the request. "message": string, // A message providing additional information about the result. "trackId": string, // The unique identifier of the payment session. "status": string, // The current status of the payment (e.g., \"New,\" \"Waiting,\" \"Confirming,\" \"Paid,\" \"Expired,\" etc.). "type": string, // The invoive type(Invoice or White-Label) "amount": string, // The total amount of the payment. "currency": string, // The currency in which the payment was made. "payAmount": string, // The actual amount paid by the payer. "payCurrency": string, // The currency in which the payment was made by the payer. "network": string, // The blockchain network on which the payment was made. "address": string, // The payment address where the payment was received. "txID": string, // The payment txID "email": string, // The customer email "orderId": string, // The invoice order id "description": string, // The invoice description "feePaidByPayer": integer, // feePaidByPayer of the invoice "underPaidCover": interger, // underPaidCover of the invoice "date": string, // Creation time of the invoice. "payDate": string // Payment time of the invoice. } Please note that a successful request will return a result code 100. In case of any issues or validation problems, refer to the corresponding [result codes](https://docs.oxapay.com/legacy/api-reference/result-code-table) for further details. ### [](https://docs.oxapay.com/legacy/api-reference/payment-information#example-codes) Example codes cURL PHP Node.js Python Copy curl -X POST https://api.oxapay.com/merchants/inquiry \ -d '{ "merchant": "YOUR_MERCHANT_API_KEY", "trackId": TRACK_ID }' Copy 'YOUR_MERCHANT_API_KEY', 'trackId' => 'TRACK_ID' ); $options = array( 'http' => array( 'header' => 'Content-Type: application/json', 'method' => 'POST', 'content' => json_encode($data), ), ); $context = stream_context_create($options); $response = file_get_contents($url, false, $context); $result = json_decode($response); var_dump($result); ?> Copy const axios = require('axios'); const url = 'https://api.oxapay.com/merchants/inquiry'; const data = JSON.stringify({ merchant: 'YOUR_MERCHANT_API_KEY', trackId: TRACK_ID }); axios.post(url, data) .then(response => { console.log(response.data); }) .catch(error => { console.error(error); }); Copy import requests import json url = 'https://api.oxapay.com/merchants/inquiry' data = { 'merchant': 'YOUR_MERCHANT_API_KEY', 'trackId': TRACK_ID } response = requests.post(url, data=json.dumps(data)) result = response.json() print(result) Please replace `YOUR_MERCHANT_API_KEY` with your actual merchant API key, and `PAYMENT_TRACK_ID` with the unique identifier of the payment session (TrackId) you want to inquire about. These code snippets demonstrate how to make a POST request to the Payment Information endpoint and handle the response in each respective programming language. [PreviousStatic Wallets List](https://docs.oxapay.com/legacy/api-reference/static-wallets-list) [NextPayment History](https://docs.oxapay.com/legacy/api-reference/payment-history) Last updated 11 months ago --- # Plugins | Legacy | OxaPay Docs OxaPay offers dedicated digital currency payment gateway plugins for various popular eCommerce platforms, making it easier for merchants to integrate cryptocurrency payments into their online stores. With these plugins, merchants can effortlessly add OxaPay's payment gateway functionality to their eCommerce platforms, allowing customers to choose cryptocurrencies as a payment option during the checkout process. The plugins are designed to ensure a smooth and secure payment experience for customers, while also providing merchants with real-time transaction updates and order management. [](https://docs.oxapay.com/legacy/integrations/plugins/woocommerce) ![Cover](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F517956072-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FAQc1OXMAl6RP5j6dwH6R%252Fuploads%252FYDeJjZbaYLxZL7k1imdq%252Fwoocommerce.jpg%3Falt%3Dmedia%26token%3D253d2380-410d-4fb3-97b0-51f470f42469&width=752&dpr=4&quality=100&sign=f7b81a71&sv=2) **WooCommerce** WooCommerce is an open-source e-commerce plugin for WordPress. It is designed for small to large-sized online merchants using WordPress. [Download Plugin](https://downloads.wordpress.org/plugin/oxapay.1.0.0.zip) [](https://docs.oxapay.com/legacy/integrations/plugins/wisecp) ![Cover](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F517956072-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FAQc1OXMAl6RP5j6dwH6R%252Fuploads%252FlR4ucz3RXVWZiIuSKsmI%252FScreenshot%2520%281219%29.png%3Falt%3Dmedia%26token%3D7835b805-fec9-458d-b3d0-0d8f1a5e41b5&width=752&dpr=4&quality=100&sign=94ce08fa&sv=2) **WISECP** WISECP is an all-in-one web hosting automation and management platform. It is designed for web hosting companies, domain registrars, and other online service providers [Download Plugin](https://github.com/OxaPay/oxapay-wisecp/archive/refs/tags/v1.0.0.zip) [](https://docs.oxapay.com/legacy/integrations/plugins/clientexec) ![Cover](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F517956072-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FAQc1OXMAl6RP5j6dwH6R%252Fuploads%252FTtfNko4LiHnDhg4pOGfv%252Fimages.png%3Falt%3Dmedia%26token%3D83ba210f-e9e9-4be4-a263-fa0bbe2de158&width=752&dpr=4&quality=100&sign=a94b62af&sv=2) **Clientexec** Clientexec is a comprehensive billing and client management platform designed specifically for web hosting businesses. [Download Plugin](https://github.com/OxaPay/oxapay-clientexec/archive/refs/tags/v1.0.0.zip) [](https://docs.oxapay.com/legacy/integrations/plugins/blesta) ![Cover](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F517956072-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FAQc1OXMAl6RP5j6dwH6R%252Fuploads%252FdS6d8UGGxHs0vraIyDu0%252Fblesta-installation-and-configuration-tutorial.png%3Falt%3Dmedia%26token%3D6d3532cb-029f-4563-930c-af4358285a33&width=752&dpr=4&quality=100&sign=672f0792&sv=2) **Blesta** Blesta is an open-source billing and client management platform. It is designed for web hosting companies and other service providers. [Download Plugin](https://github.com/OxaPay/oxapay-blesta/archive/refs/tags/v1.0.0.zip) [](https://docs.oxapay.com/legacy/integrations/plugins/whmcs) ![Cover](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F517956072-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FAQc1OXMAl6RP5j6dwH6R%252Fuploads%252FiPsfWuVD0S3XBD01RIbK%252Fwhmcs_ltd_cover.jpeg%3Falt%3Dmedia%26token%3D5c6f5856-f33a-4da8-a550-9478e2a587f6&width=752&dpr=4&quality=100&sign=44407474&sv=2) **WHMCS** WHMCS is a powerful billing and automation platform tailored for web hosting companies, enabling them to manage billing and client accounts. [Download Plugin](https://github.com/OxaPay/oxapay-whmcs/releases/download/v1.0.0/oxapay_whmcs.zip) [](https://docs.oxapay.com/legacy/integrations/plugins/prestashop) ![Cover](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F517956072-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FAQc1OXMAl6RP5j6dwH6R%252Fuploads%252FoCylCkltvXUeWZFoj86E%252FPrestaShop-Logo.png%3Falt%3Dmedia%26token%3De55efdc2-0733-4638-877b-08bef180f844&width=752&dpr=4&quality=100&sign=742f3c52&sv=2) **PrestaShop** PrestaShop is an open-source e-commerce platform that allows users to create and manage online stores with customizable features. [Download Plugin](https://github.com/OxaPay/oxapay-prestashop/archive/refs/tags/v1.0.0.zip) [](https://docs.oxapay.com/legacy/integrations/plugins/easy-digital-downloads) ![Cover](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F517956072-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FAQc1OXMAl6RP5j6dwH6R%252Fuploads%252Fa0zTJSBvQZPGNUuCKN4J%252Feasy-digital-downloads-banner.svg%3Falt%3Dmedia%26token%3D7ddd0f4c-2763-44e1-8f30-d9365073a421&width=752&dpr=4&quality=100&sign=26e3d92b&sv=2) **Easy Digital Downloads** Easy Digital Downloads (EDD) is a popular WordPress plugin designed for selling digital products like ebooks, software, and digital art. [Download Plugin](https://downloads.wordpress.org/plugin/oxapay-payment-gateway-for-easy-digital-downloads.1.0.0.zip) [](https://docs.oxapay.com/legacy/integrations/plugins/paid-memberships-pro) ![Cover](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F517956072-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FAQc1OXMAl6RP5j6dwH6R%252Fuploads%252FUFp76gKCuybTygefnqrD%252Fpaid-memberships-pro.svg%3Falt%3Dmedia%26token%3Dd9534d2d-764e-4df2-9420-57bcb902662c&width=752&dpr=4&quality=100&sign=478e485d&sv=2) **Paid Memberships Pro** Manage member subscriptions with recurring payments, user registration, custom profile fields, and robust member management. [Download Plugin](https://oxapay.com/plugins/oxapay_pmpro.zip) [](https://docs.oxapay.com/legacy/integrations/plugins/gravity-forms) ![Cover](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F517956072-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FAQc1OXMAl6RP5j6dwH6R%252Fuploads%252FLHJDoOlTMcNxyo7fQtAC%252FGravity-Forms-Integration.jpg%3Falt%3Dmedia%26token%3D03160bd1-8e19-4be9-a22d-bf66db076f45&width=752&dpr=4&quality=100&sign=554f96&sv=2) **Gravity Forms** Gravity Forms is a powerful WordPress plugin that allows users to create advanced and customizable forms with ease. [Download Plugin](https://downloads.wordpress.org/plugin/oxapay-crypto-payment-gateway-for-gravity-forms.1.0.0.zip) [](https://docs.oxapay.com/legacy/integrations/plugins/restrict-content-pro) ![Cover](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F517956072-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FAQc1OXMAl6RP5j6dwH6R%252Fuploads%252F5w9McmrI8EjM158Qd2L0%252Frestrict-content-pro-banner.svg%3Falt%3Dmedia%26token%3D285284cd-2791-4f5d-9c8f-4286dae889ef&width=752&dpr=4&quality=100&sign=a1af7304&sv=2) **Restrict Content Pro** Restrict Content Pro is a powerful WordPress membership plugin that allows you to monetize content access. [Download Plugin](https://github.com/OxaPay/oxapay-restrict-content/archive/refs/tags/v1.0.0.zip) [](https://docs.oxapay.com/legacy/integrations/plugins/virtuemart) ![Cover](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F517956072-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FAQc1OXMAl6RP5j6dwH6R%252Fuploads%252FcF6FmtYpnbBTCdGO0ojO%252Fmaxresdefault.jpg%3Falt%3Dmedia%26token%3D85b100ef-56dc-4d25-90e4-69ef75e5b140&width=752&dpr=4&quality=100&sign=b53d60be&sv=2) VirtueMart VirtueMart is a Free open-source eCommerce extension for Joomla! CMS has been active in development since 2002. [Downlaod Plugin](https://github.com/OxaPay/oxapay-virtuemart/archive/refs/tags/v1.0.0.zip) [](https://docs.oxapay.com/legacy/integrations/plugins/opencart) ![Cover](https://docs.oxapay.com/~gitbook/image?url=https%3A%2F%2F2150865118-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F0cdQgWk1yvwE7MR49PSn%252Fuploads%252FkQ7S7vOxBghl6DyYUsIF%252Fopencart.jpg%3Falt%3Dmedia%26token%3De6fa2678-b35f-4773-8736-849a0d5672da&width=376&dpr=3&quality=100&sign=c73fb3aa&sv=2) OpenCart OpenCart is a free, open-source e-commerce platform designed for building and managing online stores. [Download Plugin](https://github.com/OxaPay/oxapay-opencart/releases/download/v1.0.0/oxapay.ocmod.zip) [PreviousPayout API](https://docs.oxapay.com/legacy/integrations/payout-api) [NextWooCommerce](https://docs.oxapay.com/legacy/integrations/plugins/woocommerce) Last updated 1 month ago --- # System Status | Legacy | OxaPay Docs The endpoint allows users to check the current state of the OxaPay API. By making a request to this endpoint, users can verify if the API is functioning correctly. `POST` `https://api.oxapay.com/monitor` 200: OK Copy OK ### [](https://docs.oxapay.com/legacy/api-reference/system-status#usage) Usage This endpoint is primarily used to perform a health check on the OxaPay API. It helps users determine if the API is operational and responsive. A successful response with "OK" indicates that the API is functioning as expected. If there are any issues with the API, the response message will provide relevant details about the encountered error. Please note that this endpoint is useful for monitoring and diagnosing the overall health of the OxaPay API. It is commonly used by developers and administrators to ensure the stability and reliability of the payment gateway. [PreviousSupported Networks](https://docs.oxapay.com/legacy/api-reference/supported-networks) [NextResult code table](https://docs.oxapay.com/legacy/api-reference/result-code-table) Last updated 1 year ago --- # Webhook | Legacy | OxaPay Docs Merchants can set up a `callbackUrl` in their merchant requests, and upon processing payments, OxaPay will send you notifications in JSON format with all required information about the transaction, such as the amount and status, when the payment status is changed to Waiting, Confirming, Paid, Failed, or Expired. To receive webhook notifications, first, you should implement a standard HTTP POST (application/json) call over an HTTPS URL to a CGI script on your server. Insert your created endpoint address in the `callbackUrl` field of merchant requests. You will receive payment updates (statuses) to this URL address. However, you will initially receive a callback with the "Confirming" status. You should wait for a second callback where the "status" value will be "Paid". When we confirm the transaction, we are ready to manage all the risks concerning accepting real funds later. You should not be concerned about it. Merchant's `callbackUrl` must return an HTTP Response 200 with content: ok for OxaPay API to confirm the callback as successful. The system will try to deliver a webhook notification up to 5 times or until a successful delivery occurs, whichever happens first. If the first attempt fails, the second one is triggered after approximately 1 minute. The third one is delayed for 3 more minutes, the fourth for 30 minutes, and the last one for 3 hours. The payout webhook is similar to a merchant webhook exactly. But for withdrawals, you will receive different values of the "address" parameter in every callback. [](https://docs.oxapay.com/legacy/webhook#validating-callbacks) Validating Callbacks ----------------------------------------------------------------------------------------- Merchants must validate the signature of callbacks coming from OxaPay using their `MERCHANT_API_KEY` to prevent fraudulent activity. Also, for payout webhooks you must validate the signature using your `PAYOUT_API_KEY`. OxaPay uses your `MERCHANT_API_KEY` as the HMAC shared secret key to generate an HMAC(sha512) signature of the raw POST data. The HMAC signature is sent as an HTTP header called HMAC. The body of the request contains the callback data in JSON format, similar to the Payment Information API response body. [](https://docs.oxapay.com/legacy/webhook#testing-webhook) Testing Webhook ------------------------------------------------------------------------------- For payment callback handling, you can use tools like requestcatcher.com or [webhook.site](https://webhook.site/) to create a test `callback URL` and inspect the callback data sent from OxaPay. Note that OxaPay payment callbacks will not be sent to private networks (e.g., localhost). For local debugging, you can use services like https://ngrok.io to expose your local server to the internet and receive webhook callbacks. **To utilize the payment webhook, please follow these steps:** 1\. Create a web server and define an endpoint to handle POST requests. \- Ensure that the firewall software on your server (e.g., Cloudflare) allows incoming requests from OxaPay. You may need to whitelist OxaPay's IP addresses on your side. Please reach out to [\[email protected\]](https://docs.oxapay.com/cdn-cgi/l/email-protection) to obtain the list of IP addresses. 2\. Configure your server to receive POST requests at the specified endpoint URL. \- The POST request body will contain the necessary parameters sent by OxaPay in JSON format. 3\. Validate the HMAC signature of the request to ensure the authenticity of the callback. \- Use your API\_SECRET\_KEY to calculate the HMAC signature and compare it with the received HMAC header. 4\. Process the callback data accordingly based on the status and other parameters provided. [](https://docs.oxapay.com/legacy/webhook#sample-payment-ipn-data) Sample Payment IPN data ----------------------------------------------------------------------------------------------- In this section, we will provide examples of the data OxaPay sends to your system at various stages of the payment process. Copy // Waiting IPN // Payer selected the payment currency and getting address. Awaiting payment. { "status":"Waiting", "trackId":"35092972", "amount":"100", "currency":"TRX", "feePaidByPayer":0, "underPaidCover":2, "email":"", "orderId":"665673996", "description":"", "date":"1698107946", "payDate":0, "type":"payment" } Copy // Confirming IPN // Payer transferred the payment for the invoice. Awaiting blockchain network confirmation. { "status":"Confirming", "trackId":"35092972", "address":"TCue3HjMWfARcf1W5NK7MEqLyLcWtmbZcx", "senderAddress":"TH7Q7AVjwXRbC6hnJua8MFyfvkVnoyeHB6", "txID":"918341f6c280b3b4ca2f8e50d8a32054a20cc999fd94cfa5da6d1b9f0b3f9a1e", "amount":"100", "currency":"TRX", "price":"9.23", "payAmount":"14", "payCurrency":"TRX", "network":"TRC20", "feePaidByPayer":0, "underPaidCover":2, "email":"", "orderId":"665673996", "description":"","date":"1698156969", "payDate":"1698160515", "type":"payment" } Copy // Paid IPN // Payment is confirmed by the network and has been credited to the merchant. Purchased goods/services can be safely delivered to the payer. { "status":"Paid", "trackId":"35092972", "address":"TCue3HjMWfARcf1W5NK7MEqLyLcWtmbZcx", "senderAddress":"TH7Q7AVjwXRbC6hnJua8MFyfvkVnoyeHB6", "txID":"918341f6c280b3b4ca2f8e50d8a32054a20cc999fd94cfa5da6d1b9f0b3f9a1e", "amount":"100", "currency":"TRX", "price":"9.23", "payAmount":"100", "payCurrency":"TRX", "network":"TRC20", "feePaidByPayer":0, "underPaidCover":2, "email":"", "orderId":"665673996", "description":"", "date":"1698156969", "payDate":"1698160515", "type":"payment" } [](https://docs.oxapay.com/legacy/webhook#sample-payout-ipn-data) Sample Payout IPN data --------------------------------------------------------------------------------------------- In this section, we will provide examples of the data OxaPay sends to your system at various stages of the payout process. Copy // Confirming IPN // Your payout request sent and awaiting blockchain network confirmation. { "status": "Confirming", "trackId": "28156600", "txID": "x", "address": "x", "amount": "200", "currency": "DGB", "price": "1.53600000", "network": "DigiByte", "date": "1700847655", "description": "", "type": "payout" } Copy // Complete IPN // Payout is confirmed by the network. { "status": "Complete", "trackId": "28156600", "txID": "x", "address": "x", "amount": "200", "currency": "DGB", "price": "1.53600000", "network": "DigiByte", "date": "1700847655", "description": "", "type": "payout" } [](https://docs.oxapay.com/legacy/webhook#example-codes) Example codes --------------------------------------------------------------------------- PHP Node.js Python Copy Copy const http = require('http'); const crypto = require('crypto'); const server = http.createServer((req, res) => { if (req.url === '/callback' && req.method === 'POST') { // Validate HMAC signature let postData = ''; req.on('data', chunk => { postData += chunk; }); req.on('end', () => { // Parse the JSON data let data = null; try { data = JSON.parse(postData); } catch (error) { res.statusCode = 400; res.end('Invalid JSON data'); return; } const apiSecretKey = (data.type === 'payment') ? 'YOUR_MERCHANT_API_KEY' : 'YOUR_PAYOUT_API_KEY'; const hmacHeader = req.headers['hmac']; const calculatedHmac = crypto .createHmac('sha512', apiSecretKey) .update(postData) .digest('hex'); if (calculatedHmac === hmacHeader) { // HMAC signature is valid // Process the callback data based on the type if (data.type === 'payment') { console.log('Received payment callback:', data); // Process payment data here } else if (data.type === 'payout') { console.log('Received payout callback:', data); // Process payout data here } // Return HTTP Response 200 with content "OK" res.statusCode = 200; res.end('OK'); } else { // HMAC signature is not valid // Handle the error accordingly res.statusCode = 400; res.end('Invalid HMAC signature'); } }); } else { // Invalid path or method res.statusCode = 404; res.end('Not Found'); } }); server.listen(3000, () => { console.log('Server listening on port 3000'); }); Copy from flask import Flask, request import hmac import hashlib import json app = Flask(__name__) @app.route('/callback', methods=['POST']) def handle_callback(): post_data = request.get_data(as_text=True) data = json.loads(post_data) # Validate HMAC signature if data['type'] == 'payment': api_secret_key = 'YOUR_MERCHANT_API_KEY' elif data['type'] == 'payout': api_secret_key = 'YOUR_PAYOUT_API_KEY' else: return 'Invalid data.type', 400 hmac_header = request.headers.get('HMAC') post_data = request.get_data() calculated_hmac = hmac.new(api_secret_key.encode(), post_data, hashlib.sha512).hexdigest() if calculated_hmac == hmac_header: # HMAC signature is valid # Process the callback data if data['type'] == 'payment': print('Received payment callback:', data) # Process payment data here elif data['type'] == 'payout': print('Received payout callback:', data) # Process payout data here # Return HTTP Response 200 with content "OK" return 'OK', 200 else: # HMAC signature is not valid # Handle the error accordingly return 'Invalid HMAC signature', 400 if __name__ == '__main__': app.run(host='YOUR_HOST_ADDRESS',port=3000) Again, please note that these code snippets serve as examples and may require modifications based on your specific implementation and framework. [PreviousPayout status table](https://docs.oxapay.com/legacy/api-reference/payout-status-table) [NextUse Cases](https://docs.oxapay.com/legacy/use-cases) Last updated 2 months ago --- # Revoking Static Wallet | Legacy | OxaPay Docs You can revoke a static wallet by providing the merchant API key and the address associated with the static wallet. This action will disable the static wallet and prevent any further transactions from being credited to the specified address. `POST` `https://api.oxapay.com/merchants/revoke/staticaddress` #### [](https://docs.oxapay.com/legacy/api-reference/revoking-static-wallet#request-body) Request Body Name Type Description merchant\* String Your merchant API key for authentication and authorization. address\* String The address of the static wallet you want to revoke. 200: OK The response will contain the following fields: Copy { "result": integer, // The result code indicates the success or failure of the request. "message": string // A message providing additional information about the result. } Now, you can proceed with integrating this functionality into your application using the provided endpoint, parameters, and response codes. If you encounter any issues or have questions, feel free to reach out to our support team for assistance. Please note that a successful request will return a result code 100. In case of any issues or validation problems, refer to the corresponding [result codes](https://docs.oxapay.com/legacy/api-reference/result-code-table) for further details. ### [](https://docs.oxapay.com/legacy/api-reference/revoking-static-wallet#example-codes) Example codes cURL PHP Node.js Python Copy curl -X POST https://api.oxapay.com/merchants/revoke/staticaddress \ -d '{ "merchant": "YOUR_MERCHANT_API_KEY", "address": "WALLET_ADDRESS_TO_REVOKE" }' Copy 'YOUR_MERCHANT_API_KEY', 'address' => 'WALLET_ADDRESS_TO_REVOKE' ); $options = array( 'http' => array( 'header' => 'Content-Type: application/json', 'method' => 'POST', 'content' => json_encode($data), ), ); $context = stream_context_create($options); $response = file_get_contents($url, false, $context); $result = json_decode($response); var_dump($result); ?> Copy const axios = require('axios'); const url = 'https://api.oxapay.com/merchants/revoke/staticaddress'; const data = JSON.stringify({ merchant: 'YOUR_MERCHANT_API_KEY', address: 'WALLET_ADDRESS_TO_REVOKE' }); axios.post(url, data) .then(response => { console.log(response.data); }) .catch(error => { console.error(error); }); Copy import requests import json url = 'https://api.oxapay.com/merchants/revoke/staticaddress' data = { 'merchant': 'YOUR_MERCHANT_API_KEY', 'address': 'WALLET_ADDRESS_TO_REVOKE' } response = requests.post(url, data=json.dumps(data)) result = response.json() print(result) Please replace `YOUR_MERCHANT_API_KEY` with your actual merchant API key and `WALLET_ADDRESS_TO_REVOKE` with the address of the static wallet, you want to revoke. Each of these code snippets sends a POST request to the API endpoint with the specified parameters and checks the response to determine whether the revocation was successful or not. [PreviousCreating Static Wallet](https://docs.oxapay.com/legacy/api-reference/creating-static-wallet) [NextStatic Wallets List](https://docs.oxapay.com/legacy/api-reference/static-wallets-list) Last updated 11 months ago --- # Creating Static Wallet | Legacy | OxaPay Docs You can create a static address in a specific currency and network using this endpoint. The static address will be associated with a unique trackId, and if a `callbackUrl` is set, your server will be notified of any payments received to that address. This allows you to receive transactions to the static address regardless of the amount and time. > Please note that static addresses with no transactions for six months will be revoked. `POST` `https://api.oxapay.com/merchants/request/staticaddress` #### [](https://docs.oxapay.com/legacy/api-reference/creating-static-wallet#request-body) Request Body Name Type Description merchant\* string Your merchant API key for authentication and authorization. callbackUrl string The URL where payment information will be sent. Use this to receive notifications about payments made to the static address. network string The blockchain [network](https://docs.oxapay.com/legacy/api-reference/supported-networks) on which the static address should be created. If not specified, the default network will be used. currency\* string The specific [currency](https://docs.oxapay.com/legacy/api-reference/supported-currencies) for which you want to create a static address. email string Provide the payer's email address for reporting purposes. orderId string Specify a unique order ID for reference in your system. description string Provide order details or any additional information that will be shown in different reports. 200: OK Copy { "result": integer, // The result code indicates the success or failure of the request. "message": string, // A message providing additional information about the result. "address": string // The generated static address for the specified currency and network. } Please note that a successful request will return a result code 100. In case of any issues or validation problems, refer to the corresponding [result codes](https://docs.oxapay.com/legacy/api-reference/result-code-table) for further details. ### [](https://docs.oxapay.com/legacy/api-reference/creating-static-wallet#example-codes) Example codes cURL PHP Node.js Python Copy curl -X POST https://api.oxapay.com/merchants/request/staticaddress \ -d '{ "merchant": "YOUR_MERCHANT_API_KEY", "currency": "BTC", "callbackUrl": "https://example.com/callback", "description": "Order #12345", "orderId": "ORD-12345", "email": "[email protected]" }' Copy 'YOUR_MERCHANT_API_KEY', 'currency' => 'BTC', 'callbackUrl' => 'https://example.com/callback', 'description' => 'Order #12345', 'orderId' => 'ORD-12345', 'email' => '[email protected]' ); $options = array( 'http' => array( 'header' => 'Content-Type: application/json', 'method' => 'POST', 'content' => json_encode($data), ), ); $context = stream_context_create($options); $response = file_get_contents($url, false, $context); $result = json_decode($response); var_dump($result); ?> Copy const axios = require('axios'); const url = 'https://api.oxapay.com/merchants/request/staticaddress'; const data = JSON.stringify({ merchant: 'YOUR_MERCHANT_API_KEY', currency: 'BTC', callbackUrl: 'https://example.com/callback', description: 'Order #12345', orderId: 'ORD-12345', email: '[email protected]' }); axios.post(url, data) .then(response => { console.log(response.data); }) .catch(error => { console.error(error); }); Copy import requests import json url = 'https://api.oxapay.com/merchants/request/staticaddress' data = { 'merchant': 'YOUR_MERCHANT_API_KEY', 'currency': 'BTC', 'callbackUrl': 'https://example.com/callback', 'description': 'Order #12345', 'orderId': 'ORD-12345', 'email': '[email protected]' } response = requests.post(url, data=json.dumps(data)) result = response.json() print(result) Please note that you need to replace `YOUR_MERCHANT_API_KEY` with your actual merchant API key in the code snippets. [PreviousCreating White-Label Payment](https://docs.oxapay.com/legacy/api-reference/creating-white-label-payment) [NextRevoking Static Wallet](https://docs.oxapay.com/legacy/api-reference/revoking-static-wallet) Last updated 11 months ago --- # Supported Fiat Currencies | Legacy | OxaPay Docs This API request will return a comprehensive list of supported fiat currencies and their price. Each currency is represented by a key-value pair, where the key is the currency code (e.g., USD, AUD) and the value is an object containing details such as symbol, name, price, and display precision. This data can be used to populate a user interface and allows merchants to create invoices using fiat currencies. `POST` `https://api.oxapay.com/api/fiats` 200: OK Copy { "result": integer, // The result code indicates the success or failure of the request. "message": string, // A message providing additional information about the result. "data": array of Object // An array containing the supported fiat currencies in OxaPay. Each currency is represented as a object. } ### [](https://docs.oxapay.com/legacy/api-reference/supported-fiat-currencies#sample-output) Sample output Copy { "result": 100, "message": "Successful operation", "data": { "USD": { "symbol": "USD", "name": "United States Dollar", "price": "1", "displayPrecision": "0.001" }, "AMD": { "symbol": "AMD", "name": "Armenian Dram", "price": "0.00246243", "displayPrecision": "0.1" }, "AUD": { "symbol": "AUD", "name": "Australian Dollar", "price": "0.65220935", "displayPrecision": "0.001" }, "AZN": { "symbol": "AZN", "name": "Azerbaijani Manat", "price": "0.58823529", "displayPrecision": "0.001" }, ... } } [PreviousSupported Currencies](https://docs.oxapay.com/legacy/api-reference/supported-currencies) [NextSupported Networks](https://docs.oxapay.com/legacy/api-reference/supported-networks) Last updated 1 year ago --- # Accepted Coins | Legacy | OxaPay Docs The endpoint allows you to retrieve the list of cryptocurrencies that are available for payments through OxaPay. These cryptocurrencies are set by you as the merchant in the "Merchant" tab on your account, indicating the coins accepted for transactions on your platform or website. `POST` `https://api.oxapay.com/merchants/allowedCoins` #### [](https://docs.oxapay.com/legacy/api-reference/accepted-coins#request-body) Request Body Name Type Description merchant\* string Your merchant API key for authentication and authorization. 200: OK Copy { "result": integer, // The result code indicates the success or failure of the request. "message": string, // A message providing additional information about the result. "allowed": array // An array containing the cryptocurrency symbols that are accepted for payments. } By making a request to this endpoint with your valid merchant API key, you can obtain the list of accepted cryptocurrencies for OxaPay payments and tailor your payment options accordingly. Please note that a successful request will return a result code 100. In case of any issues or validation problems, refer to the corresponding [result codes](https://docs.oxapay.com/legacy/api-reference/result-code-table) for further details. ### [](https://docs.oxapay.com/legacy/api-reference/accepted-coins#example-codes) Example codes cURL PHP Node.js Python Copy curl -X POST https://api.oxapay.com/merchants/allowedCoins \ -d '{"merchant": "YOUR_MERCHANT_API_KEY"}' Copy 'YOUR_MERCHANT_API_KEY' ); $options = array( 'http' => array( 'header' => 'Content-Type: application/json', 'method' => 'POST', 'content' => json_encode($data), ), ); $context = stream_context_create($options); $response = file_get_contents($url, false, $context); $result = json_decode($response); var_dump($result); ?> Copy const axios = require('axios'); const url = 'https://api.oxapay.com/merchants/allowedCoins'; const data = JSON.stringify({ merchant: 'YOUR_MERCHANT_API_KEY' }); axios.post(url, data) .then(response => { console.log(response.data); }) .catch(error => { console.error(error); }); Copy import requests import json url = "https://api.oxapay.com/merchants/allowedCoins" data = { 'merchant': 'YOUR_MERCHANT_API_KEY' } response = requests.post(url, data=json.dumps(data)) result = response.json() print(result) Please replace `YOUR_MERCHANT_API_KEY` with your actual OxaPay merchant API key when using these code snippets. These snippets will send a POST request to the "Accepted Coins" endpoint and print the response containing the list of accepted cryptocurrencies for OxaPay payments. [PreviousPayment History](https://docs.oxapay.com/legacy/api-reference/payment-history) [NextPrice](https://docs.oxapay.com/legacy/api-reference/price) Last updated 7 months ago --- # Payout status table | Legacy | OxaPay Docs These are the possible payout statuses that you may encounter while using the OxaPay Payout API. Each status indicates the progress of the payout process and helps you track and manage the payouts effectively. Status Description Processing The payout is being processed and prepared for sending. Confirming The payout is sent to the recipient and awaiting blockchain network confirmation. Complete The payout has been successfully completed, and the cryptocurrency has been sent to the recipient. Rejected The payout has been rejected or encountered an error. [PreviousMerchant status table](https://docs.oxapay.com/legacy/api-reference/merchant-status-table) [NextWebhook](https://docs.oxapay.com/legacy/webhook) Last updated 2 months ago --- # Merchant status table | Legacy | OxaPay Docs These are the possible payment statuses that you may encounter while using the OxaPay Merchant API. Each status indicates the progress of the payment process and helps you track and manage the payments effectively. Status Description Expired Payer did not pay within the required time (default: 20 minutes) and the invoice expired. New Newly created invoice. The payer has not yet selected the payment currency. Waiting Payer selected the payment currency. Awaiting payment. Confirming Payer transferred the payment for the invoice. Awaiting blockchain network confirmation. Paid Payment is confirmed by the network and has been credited to the merchant. Purchased goods/services can be safely delivered to the payer. Failed The transaction failed. [PreviousResult code table](https://docs.oxapay.com/legacy/api-reference/result-code-table) [NextPayout status table](https://docs.oxapay.com/legacy/api-reference/payout-status-table) Last updated 1 year ago --- # Exchange Calculate | Legacy | OxaPay Docs This endpoint helps you instantly know how much cryptocurrency you'll get when exchanging from one type to another. Perfect for anyone interested in cryptocurrency, this feature is super easy to use. Just plug it into your app, and you'll always have the latest exchange rates at your fingertips. Whether you're buying or selling, the endpoint makes it simple to calculate the amount you'll receive in your desired cryptocurrency. `POST` `https://api.oxapay.com/exchange/calculate` #### [](https://docs.oxapay.com/legacy/api-reference/exchange-calculate#request-body) Request Body Name Type Description fromCurrency\* string The [currency](https://docs.oxapay.com/legacy/api-reference/supported-currencies) code of the cryptocurrency you want to convert from toCurrency\* string The [currency](https://docs.oxapay.com/legacy/api-reference/supported-currencies) code of the cryptocurrency you want to convert to amount\* decimal Amount you want to exchange 200: OK Copy { "result": integer, // The result code indicates the success or failure of the request. "message": string, // A message providing additional information about the result. "rate": string, // The real-time exchange rate representing the number of units of `fromCurrency` equivalent to `toCurrency`. "amount": string, // The amount you want to exchange "toAmount": string // The amount you'll receive in your desired cryptocurrency. } ### [](https://docs.oxapay.com/legacy/api-reference/exchange-calculate#example-codes) Example codes cURL PHP Node.js Python Copy curl -X POST https://api.oxapay.com/exchange/calculate \ -d '{ "amount": 12, "fromCurrency": "USDT", "toCurrency": "TRX" }' Copy 12, "fromCurrency" => "USDT", "toCurrency" => "TRX" ); $options = array( 'http' => array( 'header' => 'Content-Type: application/json', 'method' => 'POST', 'content' => json_encode($data), ), ); $context = stream_context_create($options); $response = file_get_contents($url, false, $context); $result = json_decode($response); var_dump($result); ?> Copy const axios = require('axios'); const url = 'https://api.oxapay.com/exchange/calculate'; const data = JSON.stringify({ amount: 12, fromCurrency: 'USDT', toCurrency: 'TRX' }); axios.post(url, data) .then(response => { console.log(response.data); }) .catch(error => { console.error('Error:', error); }); Copy import requests import json url = 'https://api.oxapay.com/exchange/calculate' data = { 'amount': 12, 'fromCurrency': 'USDT', 'toCurrency': 'TRX' } response = requests.post(url, data=json.dumps(data)) result = response.json() print(result) ### [](https://docs.oxapay.com/legacy/api-reference/exchange-calculate#usage) Usage By inputting the `amount`, `fromCurrency`, and `toCurrency` parameters, you can instantly fetch the exchange rate between your chosen cryptocurrencies and determine the amount in your desired currency. For instance, if you specify an `amount` of 0.2 with `fromCurrency` set to "BTC" and `toCurrency` set to "USDT," the response will furnish the current BTC to USDT rate, along with the corresponding amount of USDT you'll receive after exchanging the specified BTC quantity. This feature simplifies the process of calculating cryptocurrency exchanges, providing real-time insights for informed decision-making. Please note that the exchange rate provided in the response may fluctuate over time due to the volatile nature of cryptocurrency markets. [PreviousExchange Rate](https://docs.oxapay.com/legacy/api-reference/exchange-rate) [NextExchange Pairs](https://docs.oxapay.com/legacy/api-reference/exchange-pairs) Last updated 11 months ago --- # Exchange Request | Legacy | OxaPay Docs Effortlessly initiate currency conversions for a specific amount from one cryptocurrency to another in real-time, receiving your desired currency at the prevailing global market price. To explore the available conversion options, refer to the [exchange pairs](https://docs.oxapay.com/legacy/api-reference/exchange-pairs) endpoint, which provides a comprehensive list of supported currency pairs for seamless transactions. Whether you're swapping Bitcoin for Tether or Tether for Litecoin, this feature ensures quick and accurate conversions at the current market rates. `POST` `https://api.oxapay.com/exchange/request` To use this endpoint, you need to make a POST request to the specified URL with the required parameters. The typical parameters for this request include: #### [](https://docs.oxapay.com/legacy/api-reference/exchange-request#request-body) Request Body Name Type Description key\* string Your general API key for authentication and authorization. toCurrency\* string The [currency](https://docs.oxapay.com/legacy/api-reference/supported-currencies) code of the cryptocurrency you want to convert to fromCurrency\* string The [currency](https://docs.oxapay.com/legacy/api-reference/supported-currencies) code of the cryptocurrency you want to convert from amount\* decimal The amount of cryptocurrency to you want to exchange 200: OK After the payout request is made, the response will contain the following information: Copy { "result": integer, // The result code indicates the success or failure of the request. "message": string, // A message providing additional information about the result. "trackId": string, // The unique identifier for the payout request in the OxaPay payment gateway. "status": string, // The current status of the payout (Processing, Sending, Complete, or Rejected). "amount": string, // The amount you want to exchange "fromCurrency": string, // The currency code of the cryptocurrency you want to convert from "toCurrency": string, // The currency code of the cryptocurrency you want to convert to "toAmount": string, // The amount you'll receive in your desired cryptocurrency. "rate": string, // The real-time exchange rate representing the number of units of `fromCurrency` equivalent to `toCurrency`. "date": string // exchange time } Please ensure that you provide the necessary parameters accurately in the request to create a exchange request successfully. Please note that a successful request will return a result code 100. In case of any issues or validation problems, refer to the corresponding [result codes](https://docs.oxapay.com/legacy/api-reference/result-code-table) for further details. ### [](https://docs.oxapay.com/legacy/api-reference/exchange-request#example-codes) Example codes cURL PHP Node.js Python Copy curl -X POST https://api.oxapay.com/exchange/request \ -d '{ "key": "YOUR_GENERAL_API_KEY", "amount": 0.5, "fromCurrency": "BTC", "toCurrency": "USDT" }' Copy 'YOUR_GENERAL_API_KEY', 'amount": 0.5, 'fromCurrency': 'BTC', 'toCurrency': 'USDT' ); $options = array( 'http' => array( 'header' => 'Content-Type: application/json', 'method' => 'POST', 'content' => json_encode($data), ), ); $context = stream_context_create($options); $response = file_get_contents($url, false, $context); $result = json_decode($response); var_dump($result); ?> Copy const axios = require('axios'); const url = 'https://api.oxapay.com/exchange/request'; const data = { key: 'YOUR_GENERAL_API_KEY', amount: 0.5, fromCurrency: 'BTC', toCurrency: 'USDT' }; axios.post(url, data) .then(response => { console.log(response.data); }) .catch(error => { console.error(error.response.data); }); Copy import requests import json url = 'https://api.oxapay.com/exchange/request' data = { 'key': 'YOUR_GENERAL_API_KEY', 'amount': 0.5, 'fromCurrency': 'BTC', 'toCurrency': 'USDT' } response = requests.post(url, data=json.dumps(data)) result = response.json() print(result) Replace `YOUR_GENERAL_API_KEY` with your actual API key and adjust the parameters as needed for your specific use case. [PreviousExchange Pairs](https://docs.oxapay.com/legacy/api-reference/exchange-pairs) [NextExchange History](https://docs.oxapay.com/legacy/api-reference/exchange-history) Last updated 11 months ago --- # Exchange Pairs | Legacy | OxaPay Docs Easily access a comprehensive list of exchangeable cryptocurrencies along with their minimum conversion amounts. This resource reveals the available options for the `fromCurrency` and `toCurrency` fields when conducting cryptocurrency conversions. Whether you're exchanging Bitcoin for Tether or Tether for Litecoin, this list provides valuable insights into the supported pairs and ensures seamless transactions with the specified minimum conversion amount. `POST` `https://api.oxapay.com/exchange/pairs` 200: OK Copy { "result": integer, // The result code indicates the success or failure of the request. "message": string, // A message providing additional information about the result. "pairs": array of Object // An array containing the supported exchange pairs in OxaPay. Each currency is represented as a object with fromCurrency, toCurrency, minAmount. } ### [](https://docs.oxapay.com/legacy/api-reference/exchange-pairs#sample-output) Sample output Copy { "result": 100, "message": "Successful operation", "pairs": [\ { "fromCurrency": "BTC", "toCurrency": "USDT", "minAmount": "0.0003" }, \ { "fromCurrency": "ETH", "toCurrency": "USDT", "minAmount": "0.005" }, \ { "fromCurrency": "BNB", "toCurrency": "USDT", "minAmount": "0.01" }, \ { "fromCurrency": "LTC", "toCurrency": "USDT", "minAmount": "0.05" }, \ { "fromCurrency": "TRX", "toCurrency": "USDT", "minAmount": "1" }, \ { "fromCurrency": "DOGE", "toCurrency": "USDT", "minAmount": "1" }, \ { "fromCurrency": "MATIC", "toCurrency": "USDT", "minAmount": "0.1" }, \ { "fromCurrency": "TON", "toCurrency": "USDT", "minAmount": "0.1" }, \ { "fromCurrency": "XMR", "toCurrency": "USDT", "minAmount": "0.01" }, \ { "fromCurrency": "DGB", "toCurrency": "USDT", "minAmount": "50" }, \ { "fromCurrency": "BCH", "toCurrency": "USDT", "minAmount": "0.005" }, \ { "fromCurrency": "SHIB", "toCurrency": "USDT", "minAmount": "100000" }, \ { "fromCurrency": "SOL", "toCurrency": "USDT", "minAmount": "0.008" }, \ { "fromCurrency": "USDT", "toCurrency": "BTC", "minAmount": "1" }, \ { "fromCurrency": "USDT", "toCurrency": "ETH", "minAmount": "1" }, \ { "fromCurrency": "USDT", "toCurrency": "BNB", "minAmount": "1" }, \ { "fromCurrency": "USDT", "toCurrency": "LTC", "minAmount": "1" }, \ { "fromCurrency": "USDT", "toCurrency": "TRX", "minAmount": "1" }, \ { "fromCurrency": "USDT", "toCurrency": "DOGE", "minAmount": "1" }, \ { "fromCurrency": "USDT", "toCurrency": "MATIC", "minAmount": "1" }, \ { "fromCurrency": "USDT", "toCurrency": "TON", "minAmount": "1" }, \ { "fromCurrency": "USDT", "toCurrency": "XMR", "minAmount": "1" }, \ { "fromCurrency": "USDT", "toCurrency": "DGB", "minAmount": "1" }, \ { "fromCurrency": "USDT", "toCurrency": "BCH", "minAmount": "1" }, \ { "fromCurrency": "USDT", "toCurrency": "SHIB", "minAmount": "1" }, \ { "fromCurrency": "USDT", "toCurrency": "SOL", "minAmount": "1" }\ ] } [PreviousExchange Calculate](https://docs.oxapay.com/legacy/api-reference/exchange-calculate) [NextExchange Request](https://docs.oxapay.com/legacy/api-reference/exchange-request) Last updated 1 year ago --- # Exchange Rate | Legacy | OxaPay Docs The endpoint allows users to obtain real-time exchange rates for cryptocurrency pairs supported by OxaPay. This feature is particularly useful for applications that require up-to-date cryptocurrency prices. `POST` `https://api.oxapay.com/exchange/rate` #### [](https://docs.oxapay.com/legacy/api-reference/exchange-rate#request-body) Request Body Name Type Description fromCurrency\* string The [currency](https://docs.oxapay.com/legacy/api-reference/supported-currencies) code of the cryptocurrency you want to convert from toCurrency\* string The [currency](https://docs.oxapay.com/legacy/api-reference/supported-currencies) code of the cryptocurrency you want to convert to 200: OK Copy { "result": integer, // The result code indicates the success or failure of the request. "message": string, // A message providing additional information about the result. "rate": string // The real-time exchange rate representing the number of units of `fromCurrency` equivalent to `toCurrency`. } ### [](https://docs.oxapay.com/legacy/api-reference/exchange-rate#example-codes) Example codes cURL PHP Node.js Python Copy curl -X POST https://api.oxapay.com/exchange/rate \ -d '{ "fromCurrency": "USDT", "toCurrency": "TRX" }' Copy "USDT", "toCurrency" => "TRX" ); $options = array( 'http' => array( 'header' => 'Content-Type: application/json', 'method' => 'POST', 'content' => json_encode($data), ), ); $context = stream_context_create($options); $response = file_get_contents($url, false, $context); $result = json_decode($response); var_dump($result); ?> Copy const axios = require('axios'); const url = 'https://api.oxapay.com/exchange/rate'; const data = JSON.stringify({ fromCurrency: 'USDT', toCurrency: 'TRX' }); axios.post(url, data) .then(response => { console.log(response.data); }) .catch(error => { console.error('Error:', error); }); Copy import requests import json url = 'https://api.oxapay.com/exchange/rate' data = { 'fromCurrency': 'USDT', 'toCurrency': 'TRX' } response = requests.post(url, data=json.dumps(data)) result = response.json() print(result) ### [](https://docs.oxapay.com/legacy/api-reference/exchange-rate#usage) Usage By providing the \`fromCurrency\` and \`toCurrency\` parameters, you can retrieve the exchange rate between the specified cryptocurrencies. For example, if you set \`fromCurrency\` to "BTC" and \`toCurrency\` to "USDT," the response will provide the real-time exchange rate for converting Bitcoin (BTC) to Tether (USDT). Please note that the exchange rate provided in the response may fluctuate over time due to the volatile nature of cryptocurrency markets. [PreviousAccount Balance](https://docs.oxapay.com/legacy/api-reference/account-balance) [NextExchange Calculate](https://docs.oxapay.com/legacy/api-reference/exchange-calculate) Last updated 11 months ago --- # Account Balance | Legacy | OxaPay Docs This endpoint is used to get details about all wallets related to a user. The response contains a list of currencies with their corresponding amounts. `POST` `https://api.oxapay.com/api/balance` #### [](https://docs.oxapay.com/legacy/api-reference/account-balance#request-body) Request Body Name Type Description key\* string Your payout API key for authentication and authorization. currency string Specify a specific [currency](https://docs.oxapay.com/legacy/api-reference/supported-currencies) to get the balance for that currency. If not provided, the response will contain the balance for all available currencies. 200: OK Copy { "result": integer, // The result code indicates the success or failure of the request. "message": string, // A message providing additional information about the result. "data": object array // An array of objects containing the balances for each currency. Each key is the currency symbol, and its value is the corresponding amount in that currency. } Please note that the response will contain the balance for each currency as a string value. You may need to parse or convert these values to the appropriate data type based on your application's requirements. Please note that a successful request will return a result code 100. In case of any issues or validation problems, refer to the corresponding [result codes](https://docs.oxapay.com/legacy/api-reference/result-code-table) for further details. ### [](https://docs.oxapay.com/legacy/api-reference/account-balance#example-codes) Example codes cURL PHP Node.js Python Copy curl -X POST https://api.oxapay.com/api/balance \ -d 'key=YOUR_PAYOUT_API_KEY' Copy 'YOUR_PAYOUT_API_KEY' ); $options = array( 'http' => array( 'header' => 'Content-Type: application/json', 'method' => 'POST', 'content' => json_encode($data), ), ); $context = stream_context_create($options); $response = file_get_contents($url, false, $context); $result = json_decode($response); var_dump($result); ?> Copy const axios = require('axios'); const url = 'https://api.oxapay.com/api/balance'; const data = JSON.stringify({ key: 'YOUR_PAYOUT_API_KEY' }); axios.post(url, data) .then(response => { console.log(response.data); }) .catch(error => { console.error(error); }); Copy import requests import json url = 'https://api.oxapay.com/api/balance' data = { 'key': 'YOUR_PAYOUT_API_KEY' } response = requests.post(url, data=json.dumps(data)) result = response.json() print(result) Now the API key is included in the request body, and you can proceed to use the appropriate code snippet based on your preferred programming language. [PreviousPayout History](https://docs.oxapay.com/legacy/api-reference/payout-history) [NextExchange Rate](https://docs.oxapay.com/legacy/api-reference/exchange-rate) Last updated 11 months ago --- # Creating an Invoice | Legacy | OxaPay Docs This endpoint allows you to create a new payment link and receive a URL that can be used to complete the payment. By sending a request to this endpoint with the required parameters, you can generate a payment link for a specific amount and configure various options for the payment process. `POST` `https://api.oxapay.com/merchants/request` #### [](https://docs.oxapay.com/legacy/api-reference/creating-an-invoice#request-body) Request Body Name Type Description merchant\* string Your merchant API key for authentication and authorization. amount\* long The amount for the payment. If the `currency` field is not filled, the amount should be specified in dollars. If the \`currency\` field is filled, the amount should correspond to the specified currency. currency string Specify the [currency symbol](https://docs.oxapay.com/legacy/api-reference/supported-currencies) if you want the invoice amount calculated with a specific currency. You can also create invoices in [fiat currencies](https://docs.oxapay.com/legacy/api-reference/supported-fiat-currencies) . callbackUrl string The URL where payment information will be sent. Use this to receive notifications about the payment status. underPaidCover decimal Specify the acceptable inaccuracy in payment. Determines the maximum acceptable difference between the requested and paid amount (0-60.00). **Default:** Merchant setting feePaidByPayer decimal Specify whether the payer will cover the invoice commission. `1` indicates that the payer will pay the fee, while `0` indicates that the merchant will pay the fee. **Default**: Merchant setting. lifeTime integer Set the expiration time for the payment link in minutes (15-2880). **Default:** 60. email string Provide the payer's email address for reporting purposes. orderId string Specify a unique order ID for reference in your system. description string Provide order details or any additional information that will be shown in different reports. returnUrl string The URL where the payer will be redirected after a successful payment. 200 The response will contain the following fields Copy { "result": integer, // The result code indicates the outcome of the request. Refer to the Result Code table for more information. "message": string, // A message containing additional information about the result of the request. "trackId": string, // The unique identifier for the payment session in the OxaPay payment gateway. You can use this track ID to query the payment status and generate reports. "payLink": string, // The payment page link associated with the generated track ID. This link can be forwarded to the payer to complete the payment. "expiredAt": string // The expiration timestamp of the payment link. After this time, the payment link will no longer be valid. } ### [](https://docs.oxapay.com/legacy/api-reference/creating-an-invoice#additional-notes) Additional Notes \- If the payer does not submit a transaction within the specified time for payment (lifeTime), the invoice will expire. \- If the payer sends a lower amount, the payment will not be made. \- If the payer sends the exact amount or a higher amount, you will receive the paid amount. \- If the payer makes multiple payments for one invoice, you will receive the first acceptable payment. Please note that a successful request will return a result code 100 along with the payment track ID and payment link. In case of any issues or validation problems, refer to the corresponding [result codes](https://docs.oxapay.com/legacy/api-reference/result-code-table) for further details. This endpoint allows you to generate payment links with specific amounts and configure various options to tailor the payment process according to your requirements. ### [](https://docs.oxapay.com/legacy/api-reference/creating-an-invoice#example-codes) Example codes cURL PHP Node.js Python Copy curl -X POST https://api.oxapay.com/merchants/request \ -d '{ "merchant": "YOUR_MERCHANT_API_KEY", "amount": 100, "currency": "TRX", "lifeTime": 30, "feePaidByPayer": 0, "underPaidCover": 2.5, "callbackUrl": "https://example.com/callback", "returnUrl": "https://example.com/success", "description": "Order #12345", "orderId": "ORD-12345", "email": "[email protected]" }' Copy 'YOUR_MERCHANT_API_KEY', 'amount' => 100, 'currency' => 'TRX', 'lifeTime' => 30, 'feePaidByPayer' => 0, 'underPaidCover' => 2.5, 'callbackUrl' => 'https://example.com/callback', 'returnUrl' => 'https://example.com/success', 'description' => 'Order #12345', 'orderId' => 'ORD-12345', 'email' => '[email protected]' ); $options = array( 'http' => array( 'header' => 'Content-Type: application/json', 'method' => 'POST', 'content' => json_encode($data), ), ); $context = stream_context_create($options); $response = file_get_contents($url, false, $context); $result = json_decode($response); var_dump($result); ?> Copy const axios = require('axios'); const url = 'https://api.oxapay.com/merchants/request'; const data = JSON.stringify({ merchant: 'YOUR_MERCHANT_API_KEY', amount: 100, currency: 'TRX', lifeTime: 30, feePaidByPayer: 0, underPaidCover: 2.5, callbackUrl: 'https://example.com/callback', returnUrl: 'https://example.com/success', description: 'Order #12345', orderId: 'ORD-12345', email: '[email protected]' }); axios.post(url, data) .then(response => { console.log(response.data); }) .catch(error => { console.error(error); }); Copy import requests import json url = 'https://api.oxapay.com/merchants/request' data = { 'merchant': 'YOUR_MERCHANT_API_KEY', 'amount': 100, 'currency': 'TRX', 'lifeTime': 30, 'feePaidByPayer': 0, 'underPaidCover': 2.5, 'callbackUrl': 'https://example.com/callback', 'returnUrl': 'https://example.com/success', 'description': 'Order #12345', 'orderId': 'ORD-12345', 'email': '[email protected]' } response = requests.post(url, data=json.dumps(data)) result = response.json() print(result) Please make sure to replace `YOUR_MERCHANT_API_KEY` in the code snippets with your actual merchant API key, and `usd` with the appropriate currency symbol. These example code snippets demonstrate how to request the "Creating an invoice link" endpoint using different programming languages. You can customize the data parameters according to your specific requirements. [PreviousAPI Reference](https://docs.oxapay.com/legacy/api-reference) [NextCreating White-Label Payment](https://docs.oxapay.com/legacy/api-reference/creating-white-label-payment) Last updated 2 months ago --- # Supported Networks | Legacy | OxaPay Docs The endpoint allows users to retrieve the list of blockchain networks supported by OxaPay for cryptocurrency transactions. `POST` `https://api.oxapay.com/api/networks` 200: OK Copy { "result": integer, // The result code indicates the success or failure of the request. "message": string, // A message providing additional information about the result. "data": array of strings // An array containing the names of the supported blockchain networks. } [PreviousSupported Fiat Currencies](https://docs.oxapay.com/legacy/api-reference/supported-fiat-currencies) [NextSystem Status](https://docs.oxapay.com/legacy/api-reference/system-status) Last updated 1 year ago --- # Payout History | Legacy | OxaPay Docs Use this endpoint to retrieve a list of payout transactions for a specific business. The list can be filtered by various criteria, such as time range, status, amount, currency, network, type (internal or external), and more. Pagination is also available to fetch the results in smaller sets. `POST` `https://api.oxapay.com/api/list` #### [](https://docs.oxapay.com/legacy/api-reference/payout-history#request-body) Request Body Name Type Description key\* string Your Payout API key for authentication and authorization. orderBy string Display the list in ascending or descending order. Possible values: 'asc', 'desc' \[default 'desc'\]. sortBy string Sort the received list by a parameter. Set to 'create\_date' by default. Possible values: 'create\_date', 'pay\_date', 'amount' \[default 'create\_date'\]. page integer The page number of the results you want to retrieve. Possible values: from 1 to the total number of pages - default 1. size integer Number of records to be displayed on one page. Possible values: from 1 to 200 - default 10. status string Filter payouts based on their status (processing, complete, rejected, etc.). type string Filter payouts based on type (internal or external). network string Specify the blockchain [network](https://docs.oxapay.com/legacy/api-reference/supported-networks) for filtering payouts on a particular network. currency string Specify the [currency symbol](https://docs.oxapay.com/legacy/api-reference/supported-currencies) for filtering payouts in a specific currency. toAmount string Specify the maximum payout amount for filtering. fromAmount string Specify the minimum payout amount for filtering. toDate string The start of the date window to query for payouts in unix format fromDate string The start of the date window to query for payouts in unix format 200: OK Copy { "result": integer, // The result code indicates the success or failure of the request. "message": string, // A message providing additional information about the result. "data": [\ {\ "id": string, // The unique identifier of the payout transaction.\ "address": string, // The recipient's cryptocurrency address for the payout.\ "currency": string, // The cryptocurrency symbol of the payout.\ "network": string, // The blockchain network associated with the cryptocurrency.\ "amount": string, // The amount of cryptocurrency sent in the payout.\ "fee": string, // The transaction fee (if any) associated with the payout.\ "status": string, // The status of the payout transaction (e.g., \"complete\", \"processing\", \"rejected\").\ "type": string, // The type of the payout (e.g., \"internal\" or \"external\").\ "txID": string, // The transaction ID of the payout on the blockchain (if available).\ "date": string, // The timestamp of the payout transaction in Unix time format.\ "description": string // Additional information or description related to the payout transaction.\ }\ ], "meta": { "size": integer, // The number of payout transactions returned in the current page. "page": integer, // The current page number of the result set. "pages": integer, // The total number of pages available based on the number of records and page size. "total": integer // The total number of payout transactions available for the specified criteria. } } Please note that this response sample includes a list of payout transactions with their respective details and a metadata section providing information about the total number of records and pages available. Please note that a successful request will return a result code 100. In case of any issues or validation problems, refer to the corresponding [result codes](https://docs.oxapay.com/legacy/api-reference/result-code-table) for further details. ### [](https://docs.oxapay.com/legacy/api-reference/payout-history#example-codes) Example codes cURL PHP Node.js Python Copy curl -X POST https://api.oxapay.com/api/list \ -d '{ "key": "YOUR_PAYOUT_API_KEY", "fromDate": 1690848000, "toDate": 1691625600, "size": 20, "page": 1 }' Copy 'YOUR_MERCHANT_API_KEY', 'fromDate' => 1690848000, 'toDate' => 1691625600, 'size' => 20, 'page' => 1 ); $options = array( 'http' => array( 'header' => 'Content-Type: application/json', 'method' => 'POST', 'content' => json_encode($data), ), ); $context = stream_context_create($options); $response = file_get_contents($url, false, $context); $result = json_decode($response); var_dump($result); ?> Copy const axios = require('axios'); const url = 'https://api.oxapay.com/api/list'; const data = JSON.stringify({ key: 'YOUR_MERCHANT_API_KEY', fromDate: 1690848000, toDate: 1691625600, size: 20, page: 1 }); axios.post(url, data) .then(response => { console.log(response.data); }) .catch(error => { console.error(error); }); Copy import requests import json url = 'https://api.oxapay.com/api/list' data = { 'key': 'YOUR_MERCHANT_API_KEY', 'fromDate': 1690848000, 'toDate': 1691625600, 'size': 20, 'page': 1 } response = requests.post(url, data=json.dumps(data)) result = response.json() print(result) Please remember to replace `YOUR_PAYOUT_API_KEY` with your actual payout API key and adjust the parameters as needed for your specific use case. [PreviousPayout Information](https://docs.oxapay.com/legacy/api-reference/payout-information) [NextAccount Balance](https://docs.oxapay.com/legacy/api-reference/account-balance) Last updated 7 months ago --- # Creating Payout | Legacy | OxaPay Docs This resource allows users to submit cryptocurrency payouts to active recipients. It caters to various use cases such as offering cryptocurrency withdrawals to clients, facilitating payouts for marketplaces or affiliate networks, or managing payroll by creating multiple payouts at once. `POST` `https://api.oxapay.com/api/send` To use this endpoint, you need to make a POST request to the specified URL with the required parameters. The typical parameters for this request include: #### [](https://docs.oxapay.com/legacy/api-reference/creating-payout#request-body) Request Body Name Type Description key\* string Your payout API key for authentication and authorization. callbackUrl string The URL where payment information and status updates will be sent. You can include additional parameters in the URL if needed. network string The blockchain [network](https://docs.oxapay.com/legacy/api-reference/supported-networks) to be used for the payout. The field is required for external payment memo string You can set a memo for [networks](https://docs.oxapay.com/legacy/api-reference/supported-networks) that support this option. currency\* string The [symbol of the cryptocurrency](https://docs.oxapay.com/legacy/api-reference/supported-currencies) to be sent (e.g., BTC, ETH, LTC, etc.). amount\* decimal The amount of cryptocurrency to be sent as the payout. address\* string The cryptocurrency address of the recipient where the payout will be sent. description string Provide payout details or any additional information that will be shown in different reports. 200: OK Copy { "result": integer, // The result code indicates the success or failure of the request. "message": string, // A message providing additional information about the result. "trackId": string, // The unique identifier for the payout request in the OxaPay payment gateway. "status": string // The current status of the payout (Processing, Sending, Complete, or Rejected). } Please ensure that you provide the necessary parameters accurately in the request to create a payout successfully. Additionally, handle the response accordingly based on the \`result\` and \`status\` fields to track the progress and status of your payouts. Please note that a successful request will return a result code 100. In case of any issues or validation problems, refer to the corresponding [result codes](https://docs.oxapay.com/legacy/api-reference/result-code-table) for further details. ### [](https://docs.oxapay.com/legacy/api-reference/creating-payout#example-codes) Example codes cURL PHP Node.js Python Copy curl -X POST https://api.oxapay.com/api/send \ -d '{ "key": "YOUR_PAYOUT_API_KEY", "address": "RECEIVER_CRYPTO_ADDRESS", "amount": 0.5, "currency": "BTC", "callbackUrl": "https://example.com/callback" }' Copy 'YOUR_PAYOUT_API_KEY', 'address' => 'RECEIVER_CRYPTO_ADDRESS', 'amount' => 0.5, 'currency' => 'BTC', 'callbackUrl' => 'https://example.com/callback' ); $options = array( 'http' => array( 'header' => 'Content-Type: application/json', 'method' => 'POST', 'content' => json_encode($data), ), ); $context = stream_context_create($options); $response = file_get_contents($url, false, $context); $result = json_decode($response); var_dump($result); ?> Copy const axios = require('axios'); const url = 'https://api.oxapay.com/api/send'; const data = { key: 'YOUR_PAYOUT_API_KEY', address: 'RECEIVER_CRYPTO_ADDRESS', amount: 0.5, currency: 'BTC', callbackUrl: 'https://example.com/callback' }; axios.post(url, data) .then(response => { console.log(response.data); }) .catch(error => { console.error(error.response.data); }); Copy import requests import json url = 'https://api.oxapay.com/api/send' data = { 'key': 'YOUR_PAYOUT_API_KEY', 'address': 'RECEIVER_CRYPTO_ADDRESS', 'amount': 0.5, 'currency': 'BTC', 'callbackUrl': 'https://example.com/callback' } response = requests.post(url, data=json.dumps(data)) result = response.json() print(result) Replace `YOUR_PAYOUT_API_KEY` with your actual payout API key, and `RECEIVER_CRYPTO_ADDRESS` with the recipient's cryptocurrency address for the payout. ### [](https://docs.oxapay.com/legacy/api-reference/creating-payout#allowed-ips-for-transfers) Allowed IPs for Transfers To enhance security, you can configure allowed IPs to control who can initiate payout requests. If you set this restriction, only requests coming from the specified IPs will be permitted. Any transfer requests from other IPs will be failed. To use this feature, you can receive your server's IP address by using the following endpoint: `GET` `https://api.oxapay.com/api/myip` To determine which IP version works with the OxaPay endpoint, you can use the API provided. [PreviousPrice](https://docs.oxapay.com/legacy/api-reference/price) [NextPayout Information](https://docs.oxapay.com/legacy/api-reference/payout-information) Last updated 2 months ago --- # Result code table | Legacy | OxaPay Docs When interacting with OxaPay's APIs, various scenarios can arise that result in responses. These are identified by specific codes along with corresponding messages, providing valuable information about the result status. Below is a comprehensive list of OxaPay API codes and their descriptions: Result Code Error Message 100 Successful operation 101 Validation problem 102 Invalid merchant API key 103 Invalid Payout API key 104 Invalid IP address 105 Invalid currency 106 Invalid network 107 Invalid callbackUrl 108 Invalid returnUrl 109 Amount is too low 110 Amount is too high 111 lifeTime is too short (lifeTime must be > 15) 112 Lifetime is too long (lifeTime must be < 2880) 113 underPaidCover must be >= 0 114 underPaidCover must be <= 60 115 Invalid feePaidByPayer value 116 Invalid trackId 117 Invalid address 118 toAmount cannot be smaller than fromAmount 119 toDate cannot be earlier than fromDate 120 Invalid payCurrency or incorrect symbol 121 Invalid fromCurrency 122 Invalid toCurrency 123 fromCurrency cannot be the same as toCurrency 124 Limit exceeded 125 Receiver address is yours 126 Amount not provided 127 Amount is below the minimum limit 128 Transfer limit exceeded (per transaction) 129 Total daily transfer limit exceeded 130 Insufficient balance 131 An error occurred. 135 The transfer of this currency on the defined network is disabled. 500 Internal error [PreviousSystem Status](https://docs.oxapay.com/legacy/api-reference/system-status) [NextMerchant status table](https://docs.oxapay.com/legacy/api-reference/merchant-status-table) Last updated 2 months ago --- # Exchange History | Legacy | OxaPay Docs Use this endpoint to retrieve a list of exchange transactions for a specific business. The list can be filtered by various criteria, such as time range, currency, type (autoConvert or manualSwap or swapByApi), and more. Pagination is also available to fetch the results in smaller sets. `POST` `https://api.oxapay.com/exchange/list` #### [](https://docs.oxapay.com/legacy/api-reference/exchange-history#request-body) Request Body Name Type Description key\* string Your General API key for authentication and authorization. orderBy string Display the list in ascending or descending order. Possible values: 'asc', 'desc' \[default 'desc'\]. sortBy string Sort the received list by a parameter. Set to 'create\_date' by default. Possible values: 'create\_date', 'pay\_date', 'amount' \[default 'create\_date'\]. page integer The page number of the results you want to retrieve. Possible values: from 1 to the total number of pages - default 1. size integer Number of records to be displayed on one page. Possible values: from 1 to 200 - default 10. type string Filter exchanges based on type (autoConvert or manualSwap or swapByApi). toCurrency string Specify the [currency symbol](https://docs.oxapay.com/legacy/api-reference/supported-currencies) for filtering exchanges in a specific toCurrency. fromCurrency string Specify the [currency symbol](https://docs.oxapay.com/legacy/api-reference/supported-currencies) for filtering exchanges in a specific fromCurrency. toDate string The start of the date window to query for exchanges in unix format fromDate string The start of the date window to query for exchanges in unix format trackId integer Filter spesific exchange by it\`s trackId 200: OK Copy { "result": integer, // The result code indicates the success or failure of the request. "message": string, // A message providing additional information about the result. "data": [\ {\ "trackId": string, // The uniqe id for the exchange.\ "fromCurrency": string, // The currency code of the cryptocurrency you want to convert from\ "toCurrency": string, // The currency code of the cryptocurrency you want to convert to\ "fromAmount": string, // Amount you want to exchange\ "toAmount": string, // The amount you'll receive in your desired cryptocurrency.\ "rate": string, // The real-time exchange rate representing the number of units of `fromCurrency` equivalent to `toCurrency`.\ "type": string, // The type of the exchange (e.g., \"autoConvert\" or \"manualSwap\" or \"swapByApi\").\ "date": string // The timestamp of the exchange transaction in Unix time format.\ }\ ], "meta": { "size": integer, // The number of exchange transactions returned in the current page. "page": integer, // The current page number of the result set. "pages": integer, // The total number of pages available based on the number of records and page size. "total": integer // The total number of exchange transactions available for the specified criteria. } } Please note that this response sample includes a list of exchange transactions with their respective details and a metadata section providing information about the total number of records and pages available. Please note that a successful request will return a result code 100. In case of any issues or validation problems, refer to the corresponding [result codes](https://docs.oxapay.com/legacy/api-reference/result-code-table) for further details. ### [](https://docs.oxapay.com/legacy/api-reference/exchange-history#example-codes) Example codes cURL PHP Node.js Python Copy curl -X POST https://api.oxapay.com/exchange/list \ -d '{ "key": "YOUR_GENERAL_API_KEY", "fromDate": 1690848000, "toDate": 1691625600, "size": 20, "page": 0 }' Copy 'YOUR_GENERAL_API_KEY', 'fromDate' => 1690848000, 'toDate' => 1691625600, 'size' => 20, 'page' => 0 ); $options = array( 'http' => array( 'header' => 'Content-Type: application/json', 'method' => 'POST', 'content' => json_encode($data), ), ); $context = stream_context_create($options); $response = file_get_contents($url, false, $context); $result = json_decode($response); var_dump($result); ?> Copy const axios = require('axios'); const url = 'https://api.oxapay.com/exchange/list'; const data = JSON.stringify({ key: 'YOUR_GENERAL_API_KEY', fromDate: 1690848000, toDate: 1691625600, size: 20, page: 0 }); axios.post(url, data) .then(response => { console.log(response.data); }) .catch(error => { console.error(error); }); Copy import requests import json url = 'https://api.oxapay.com/exchange/list' data = { 'key': 'YOUR_GENERAL_API_KEY', 'fromDate': 1690848000, 'toDate': 1691625600, 'size': 20, 'page': 0 } response = requests.post(url, data=json.dumps(data)) result = response.json() print(result) Please remember to replace `YOUR_GENERAL_API_KEY` with your actual general API key and adjust the parameters as needed for your specific use case. [PreviousExchange Request](https://docs.oxapay.com/legacy/api-reference/exchange-request) [NextSupported Currencies](https://docs.oxapay.com/legacy/api-reference/supported-currencies) Last updated 11 months ago --- # Payment History | Legacy | OxaPay Docs Use this endpoint to retrieve a list of payments belonging to a specific business. You can apply filters to the list based on various criteria, such as time range, payment status, amount, payment method, and more. Additionally, you can paginate the results using the \`page\` and \`size\` parameters. `POST` `https://api.oxapay.com/merchants/list` #### [](https://docs.oxapay.com/legacy/api-reference/payment-history#request-body) Request Body Name Type Description merchant\* string Your merchant API key for authentication and authorization. orderBy string Display the list in ascending or descending order. Possible values: 'asc', 'desc'. Default: 'desc'. sortBy string Sort the received list by a parameter. Possible values: 'create\_date', 'pay\_date', 'amount'. Default: 'create\_date'. trackId integer Filter payments by a specific invoice ID. page integer The page number of the results you want to retrieve. Possible values: from 1 to the total number of pages - default 1. size integer Number of records to display per page. Possible values: from 1 to 200. Default: 10. orderId string Filter payments by a unique order ID for reference. status string Filter payments by status (e.g., "Paid", "Confirming"). feePaidByPayer decimal Filter payments based on whether the payer covers the invoice commission (1) or the merchant covers it (0). type string Filter payments by type (e.g. "invoice", "white\_label", "static\_address"). network string Filter payments by the expected [blockchain network](https://docs.oxapay.com/legacy/api-reference/supported-networks) for the specified crypto currency. payCurrency string Filter payments by a specific crypto [currency symbol](https://docs.oxapay.com/legacy/api-reference/supported-currencies) in which the pay amount is specified. currency string Filter payments by a specific [currency symbol](https://docs.oxapay.com/legacy/api-reference/supported-currencies) . toAmount float Filter payments with amounts less than or equal to the specified value. fromAmount float Filter payments with amounts greater than or equal to the specified value. toDate string The end of the date window to query for invoices in unix format fromDate string The start of the date window to query for invoices in unix format address string Filter payments by the expected address. It’s better to filter static addresses. txID string Filter the payment with your transaction hash 200: OK Copy { "result": integer, // The result code indicates the success or failure of the request. "message": string, // A message providing additional information about the result. "data": array, // An array containing the list of payment information if the request is successful. "meta": object // including size, page, pages, total. } Please note that a successful request will return a result code 100. In case of any issues or validation problems, refer to the corresponding [result codes](https://docs.oxapay.com/legacy/api-reference/result-code-table) for further details. ### [](https://docs.oxapay.com/legacy/api-reference/payment-history#example-codes) Example codes cURL PHP Node.js Python Copy curl -X POST https://api.oxapay.com/merchants/list \ -d '{ "merchant": "YOUR_MERCHANT_API_KEY", "fromDate": 1690848000, "toDate": 1691625600, "size": 20, "page": 1 }' Copy 'YOUR_MERCHANT_API_KEY', 'fromDate' => 1690848000, 'toDate' => 1691625600, 'size' => 20, 'page' => 1 ); $options = array( 'http' => array( 'header' => 'Content-Type: application/json', 'method' => 'POST', 'content' => json_encode($data), ), ); $context = stream_context_create($options); $response = file_get_contents($url, false, $context); $result = json_decode($response); var_dump($result); ?> Copy const axios = require('axios'); const url = 'https://api.oxapay.com/merchants/list'; const data = JSON.stringify({ merchant: 'YOUR_MERCHANT_API_KEY', fromDate: 1690848000, toDate: 1691625600, size: 20, page: 1 }); axios.post(url, data) .then(response => { console.log(response.data); }) .catch(error => { console.error(error); }); Copy import requests import json url = 'https://api.oxapay.com/merchants/list' data = { 'merchant': 'YOUR_MERCHANT_API_KEY', 'fromDate': 1690848000, 'toDate': 1691625600, 'size': 20, 'page': 1 } response = requests.post(url, data=json.dumps(data)) result = response.json() print(result) Now you have the example code snippets in cURL, PHP, Node.js, and Python for making a request to the Payment History endpoint. Feel free to use these examples to integrate the OxaPay API into your application or website and retrieve payment information based on your specified criteria. [PreviousPayment Information](https://docs.oxapay.com/legacy/api-reference/payment-information) [NextAccepted Coins](https://docs.oxapay.com/legacy/api-reference/accepted-coins) Last updated 7 months ago --- # Creating White-Label Payment | Legacy | OxaPay Docs This endpoint allows you to create white-labeled payments, providing a seamless payment experience while utilizing the OxaPay payment gateway behind the scenes. Rather than generating an Invoice, this method provides detailed payment information, including the payment address, currency, amount, expiration time, and more. To enhance flexibility and user convenience, you can utilize URI formats, such as the Bitcoin Improvement Proposal (BIP-0021). This format allows you to generate a payment link with the crypto address embedded within it. By using the generated URI link, the payer can initiate the payment directly from their preferred wallet application. Furthermore, you have the option to generate QR codes that contain the URI link. QR codes are easily scannable by wallet applications, allowing the payer to effortlessly open their wallet app and proceed with the payment by simply scanning the QR code. The simplest way to create a QR code is to use [Google Chart Service.](https://developers.google.com/chart/infographics/docs/qr_codes) Using URI formats and QR codes simplifies the payment process for the payer, as they can quickly open their wallet application with the specified address and amount pre-filled. This user-friendly approach enhances the convenience and efficiency of the payment experience. `POST` `https://api.oxapay.com/merchants/request/whitelabel` #### [](https://docs.oxapay.com/legacy/api-reference/creating-white-label-payment#request-body) Request Body Name Type Description merchant\* string Your merchant API key for authentication and authorization. payCurrency\* string Specify the [currency symbol](https://docs.oxapay.com/legacy/api-reference/supported-currencies) if you want the invoice to be paid in a specific currency. Defines the currency in which you wish to receive your settlements. amount\* long The amount for the payment. If the `currency` field is not filled, the amount should be specified in dollars. If the `currency` field is filled, the amount should correspond to the specified currency. email string Provide the payer's email address for reporting purposes. orderId string Specify a unique order ID for reference in your system. description string Provide order details or any additional information that will be shown in different reports. callbackUrl string The URL where payment information will be sent. Use this to receive notifications about the payment status. underPaidCover decimal Specify the acceptable inaccuracy in payment. Determines the maximum acceptable difference between the requested and paid amount (0-60.00). **Default:** Merchant setting. feePaidByPayer decimal Specify whether the payer will cover the invoice commission. `1` indicates that the payer will pay the fee, while `0` indicates that the merchant will pay the fee. **Default**: Merchant setting. lifeTime integer Set the expiration time for the payment link in minutes (15-2880). **Default**: 60. network string The blockchain [network](https://docs.oxapay.com/legacy/api-reference/supported-networks) on which the payment should be created. If not specified, the default network will be used. currency string Specify the [currency symbol](https://docs.oxapay.com/legacy/api-reference/supported-currencies) if you want the invoice amount calculated with a specific currency. You can also create invoices in [fiat currencies](https://docs.oxapay.com/legacy/api-reference/supported-fiat-currencies) . 200: OK Copy { "result": integer, // Request result. More information about this number can be found in the Result Code table. "message": string, // The message containing the result of the request. "trackId": string, // The unique identifier of each payment session of the OxaPay payment gateway, which can be used to query the payment status and report requests (if the request is successful). "amount": long, // The requested payment amount. "currency": string, // The requested payment currency. "payAmount": long, // The actual payment amount. "payCurrency": string, // The actual payment currency. "network": string, // The blockchain network on which the cryptocurrency is expected to be received. "address": string, // The generated cryptocurrency address for the payment. "callbackUrl": string, // The specified callback to receive payment notifications "description": string, // The specified description "email": string, // The specified email "feePaidByPayer": decimal, // The specified feePaidByPayer "lifeTime": integer, // The specified lifeTime "orderId": string, // The specified orderId "underPaidCover": decimal, // The specified underPaidCover "rate": decimal, // The exchange rate of the specified cryptocurrency. "expiredAt": string, // The expiration time of payment to the address. "createdAt": string, // The created invoice time "QRCode": string // the QRCode image link for coin and amount } Please note that a successful request will return a result code 100. In case of any issues or validation problems, refer to the corresponding [result codes](https://docs.oxapay.com/legacy/api-reference/result-code-table) for further details. ### [](https://docs.oxapay.com/legacy/api-reference/creating-white-label-payment#example-codes) Example codes cURL PHP Node.js Python Copy curl -X POST https://api.oxapay.com/merchants/request/whitelabel \ -d '{ "merchant": "YOUR_MERCHANT_API_KEY", "amount": 100, "currency": "USD", "payCurrency": "TRX", "lifeTime": 90, "feePaidByPayer": 1, "underPaidCover": 10, "callbackUrl": "https://example.com/callback", "description": "Order #12345", "orderId": "12345", "email": "[email protected]" }' Copy 'YOUR_MERCHANT_API_KEY', 'amount' => 100, 'currency' => 'USD', 'payCurrency' => 'TRX', 'lifeTime' => 90, 'feePaidByPayer' => 1, 'underPaidCover' => 10, 'callbackUrl' => 'https://example.com/callback', 'description' => 'Order #12345', 'orderId' => '12345', 'email' => '[email protected]' ); $options = array( 'http' => array( 'header' => 'Content-Type: application/json', 'method' => 'POST', 'content' => json_encode($data), ), ); $context = stream_context_create($options); $response = file_get_contents($url, false, $context); $result = json_decode($response); var_dump($result); ?> Copy const axios = require('axios'); const url = 'https://api.oxapay.com/merchants/request/whitelabel'; const data = JSON.stringify({ merchant: 'YOUR_MERCHANT_API_KEY', amount: 100, currency: 'USD', payCurrency: "TRX", lifeTime: 90, feePaidByPayer: 1, underPaidCover: 10, callbackUrl: 'https://example.com/callback', description: 'Order #12345', orderId: 'ORD-12345', email: '[email protected]' }); axios.post(url, data) .then(response => { console.log(response.data); }) .catch(error => { console.error(error); }); Copy import requests import json url = 'https://api.oxapay.com/merchants/request/whitelabel' data = { 'merchant': 'YOUR_MERCHANT_API_KEY', 'amount': 100, 'currency': 'USD', 'payCurrency': 'TRX', 'lifeTime': 90, 'feePaidByPayer': 1, 'underPaidCover': 10, 'callbackUrl': 'https://example.com/callback', 'description': 'Order #12345', 'orderId': '12345', 'email': '[email protected]' } response = requests.post(url, data=json.dumps(data)) result = response.json() print(result) [PreviousCreating an Invoice](https://docs.oxapay.com/legacy/api-reference/creating-an-invoice) [NextCreating Static Wallet](https://docs.oxapay.com/legacy/api-reference/creating-static-wallet) Last updated 11 months ago --- # Supported Currencies | Legacy | OxaPay Docs This API request will return a comprehensive list of supported currencies and their network details, including symbols, names, and withdrawal information. You can use this data to understand which networks are available for each currency, such as Bitcoin on the Bitcoin network, Ethereum on the Ethereum network, and so on. By utilizing this API endpoint, you can stay up-to-date with the latest information on supported currencies and their respective networks, ensuring smooth and accurate transactions on OxaPay. `POST` `https://api.oxapay.com/api/currencies` 200: OK Copy { "result": integer, // The result code indicates the success or failure of the request. "message": string, // A message providing additional information about the result. "data": array of Object // An array containing the supported currencies in OxaPay. Each currency is represented as a object with minConfirm, withdrawFee, withdrawMin. } ### [](https://docs.oxapay.com/legacy/api-reference/supported-currencies#sample-output) Sample output Copy { "result": 100, "message": "Successful operation", "data": { "BTC": { "symbol": "BTC", "name": "Bitcoin", "status": true, "networkList": { "Bitcoin": { "network": "Bitcoin", "name": "Bitcoin network", "minConfirm": 2, "withdrawFee": 9.0e-5, "withdrawMin": 0.0008, "depositMin": 0.0003, "staticFixedFee": 1.5e-5 } } }, "ETH": { "symbol": "ETH", "name": "Ethereum", "status": true, "networkList": { "ERC20": { "network": "ERC20", "name": "Ethereum network", "minConfirm": 10, "withdrawFee": 0.0012, "withdrawMin": 0.0001, "depositMin": 0, "staticFixedFee": 0 } } }, "USDC": { "symbol": "USDC", "name": "USD Coin", "status": true, "networkList": { "ERC20": { "network": "ERC20", "name": "Ethereum (ERC20)", "minConfirm": 10, "withdrawFee": 8, "withdrawMin": 5, "depositMin": 0, "staticFixedFee": 0 } } }, "TRX": { "symbol": "TRX", "name": "Tron", "status": true, "networkList": { "TRC20": { "network": "TRC20", "name": "Tron network", "minConfirm": 10, "withdrawFee": 1, "withdrawMin": 0.0001, "depositMin": 0, "staticFixedFee": 0 } } }, "BNB": { "symbol": "BNB", "name": "BNB", "status": true, "networkList": { "BEP20": { "network": "BEP20", "name": "BNB Smart Chain (Bep20)", "minConfirm": 15, "withdrawFee": 5.0e-5, "withdrawMin": 0.0004, "depositMin": 0, "staticFixedFee": 0 } } }, "BUSD": { "symbol": "BUSD", "name": "Binance USD", "status": false, "networkList": {} }, "DOGE": { "symbol": "DOGE", "name": "Dogecoin", "status": true, "networkList": { "Dogecoin": { "network": "Dogecoin", "name": "Dogecoin network", "minConfirm": 12, "withdrawFee": 0.01, "withdrawMin": 0.0001, "depositMin": 0, "staticFixedFee": 0 } } }, "LTC": { "symbol": "LTC", "name": "Litecoin", "status": true, "networkList": { "Litecoin": { "network": "Litecoin", "name": "Litecoin network", "minConfirm": 3, "withdrawFee": 0.0001, "withdrawMin": 0.002, "depositMin": 0, "staticFixedFee": 0 } } }, "DGB": { "symbol": "DGB", "name": "DigiByte", "status": true, "networkList": { "DigiByte": { "network": "DigiByte", "name": "Digibyte network", "minConfirm": 50, "withdrawFee": 0.005, "withdrawMin": 0.05, "depositMin": 0, "staticFixedFee": 0 } } }, "XMR": { "symbol": "XMR", "name": "Monero", "status": true, "networkList": { "Monero": { "network": "Monero", "name": "Monero network", "minConfirm": 3, "withdrawFee": 6.0e-5, "withdrawMin": 0.0001, "depositMin": 0, "staticFixedFee": 0 } } }, "USDT": { "symbol": "USDT", "name": "Tether", "status": true, "networkList": { "BEP20": { "network": "BEP20", "name": "BNB Smart Chain (Bep20)", "minConfirm": 15, "withdrawFee": 0.25, "withdrawMin": 0.01, "depositMin": 0, "staticFixedFee": 0 }, "ERC20": { "network": "ERC20", "name": "Ethereum (ERC20)", "minConfirm": 10, "withdrawFee": 8, "withdrawMin": 1, "depositMin": 0, "staticFixedFee": 0 }, "TRC20": { "network": "TRC20", "name": "Tron (TRC20)", "minConfirm": 10, "withdrawFee": 1, "withdrawMin": 0.01, "depositMin": 0, "staticFixedFee": 0.13 }, "Polygon": { "network": "Polygon", "name": "Polygon", "minConfirm": 250, "withdrawFee": 1, "withdrawMin": 0.01, "depositMin": 0, "staticFixedFee": 0 } } }, "TON": { "symbol": "TON", "name": "Toncoin", "status": true, "networkList": { "Ton": { "network": "Ton", "name": "The Open Network (TON)", "minConfirm": 3, "withdrawFee": 0.02, "withdrawMin": 0.05, "depositMin": 0, "staticFixedFee": 0 } } }, "MATIC": { "symbol": "MATIC", "name": "Polygon", "status": true, "networkList": { "Polygon": { "network": "Polygon", "name": "Polygon", "minConfirm": 250, "withdrawFee": 0.02, "withdrawMin": 0.001, "depositMin": 0, "staticFixedFee": 0 } } }, "BCH": { "symbol": "BCH", "name": "Bitcoin Cash", "status": true, "networkList": { "BitcoinCash": { "network": "BitcoinCash", "name": "BitcoinCash", "minConfirm": 4, "withdrawFee": 6.0e-5, "withdrawMin": 1.0e-5, "depositMin": 0, "staticFixedFee": 0 } } }, "SHIB": { "symbol": "SHIB", "name": "Shiba Inu", "status": true, "networkList": { "BEP20": { "network": "BEP20", "name": "BNB Smart Chain (Bep20)", "minConfirm": 15, "withdrawFee": 32000, "withdrawMin": 10000, "depositMin": 0, "staticFixedFee": 0 } } }, "SOL": { "symbol": "SOL", "name": "Solana", "status": true, "networkList": { "Solana": { "network": "Solana", "name": "Solana network", "minConfirm": 30, "withdrawFee": 0.0005, "withdrawMin": 0.01, "depositMin": 0, "staticFixedFee": 0 } } } } } [PreviousExchange History](https://docs.oxapay.com/legacy/api-reference/exchange-history) [NextSupported Fiat Currencies](https://docs.oxapay.com/legacy/api-reference/supported-fiat-currencies) Last updated 1 year ago --- # Email Protection | Cloudflare Please enable cookies. Email Protection ================ You are unable to access this email address docs.oxapay.com ----------------------------------------------------------- The website from which you got to this page is protected by Cloudflare. Email addresses on that page have been hidden in order to keep them from being accessed by malicious bots. **You must enable Javascript in your browser in order to decode the e-mail address**. If you have a website and are interested in protecting it in a similar way, you can [sign up for Cloudflare](https://www.cloudflare.com/sign-up?utm_source=email_protection) . * [How does Cloudflare protect email addresses on website from spammers?](https://developers.cloudflare.com/waf/tools/scrape-shield/email-address-obfuscation/) * [Can I sign up for Cloudflare?](https://developers.cloudflare.com/fundamentals/setup/account/create-account/) Cloudflare Ray ID: **9a95fd912f8ee5fc** • Your IP: Click to reveal 54.237.218.47 • Performance & security by [Cloudflare](https://www.cloudflare.com/5xx-error-landing) --- # Swap Request2 | OxaPay Docs This endpoint allows you to swap your account assets. You can swap one cryptocurrency for another instantly at the current market rate. To see the supported swap options, refer to the [swap pairs](https://docs.oxapay.com/api-reference/swap/swap-pairs2) endpoint. Whether you're swapping Bitcoin for Tether, Tether for Litecoin, or any other supported combination, this feature ensures secure and accurate asset swaps. Swaps are processed in real-time to provide you with the best available rates. `POST` `https://api.oxapay.com/v1/general/swap` #### [](https://docs.oxapay.com/api-reference/swap/swap-request2#authentication) Authentication You must include the **General API Key** in the request header to authenticate your access to the API. Name Type Description general\_api\_key\* string Your General API Key for authentication and authorization. #### [](https://docs.oxapay.com/api-reference/swap/swap-request2#request-body) Request Body Name Type Description from\_currency\* string Specify the [currency symbol](https://docs.oxapay.com/api-reference/common/supported-currencies2) you want to swap from. to\_currency\* string Specify the [currency symbol](https://docs.oxapay.com/api-reference/common/supported-currencies2) you want to swap to. amount\* decimal Specify the amount of currency you want to swap. 200: OK Copy { "data": { "track_id": string, // Unique identifier for the transaction, typically represented as a string (e.g., transaction ID or session ID). "from_currency": string, // The currency being exchanged from, e.g., 'USDT' (Tether). "to_currency": string, // The currency being exchanged to, e.g., 'BTC' (Bitcoin). "from_amount": decimal, // The amount of the "from_currency" being swapped, represented with high precision (e.g., 10 USDT). "to_amount": decimal, // The amount of the "to_currency" received after the swap, represented with high precision (e.g., 0.0001054 BTC). "rate": decimal, // The exchange rate between the "from_currency" and "to_currency" at the time of the transaction (e.g., 1 USDT = 94876.66034156 BTC). "date": integer // Timestamp (UNIX epoch) representing when the swap occurred, typically in seconds (e.g., 1736508792 for the time the swap was executed). }, "message": string, // A message containing additional information about the result of the request. "error": { "type": string, "key": string, "message": string } || {}, // An object that provides details about any errors that occurred. "status": integer, // The status of the request response. Typically provided as a numeric code (e.g., 200 for success or other codes for errors). "version": string // The version of the API being used. } Please note that a successful request will return status 200. In case of any issues or validation problems, refer to the corresponding [error](https://docs.oxapay.com/api-reference/error) for further details. ### [](https://docs.oxapay.com/api-reference/swap/swap-request2#api-request-sample-codes) API Request Sample Codes cURL PHP Node.js Python Copy curl -X POST https://api.oxapay.com/v1/general/swap \ -H "general_api_key: YOUR_GENERAL_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "amount": 0.5, "from_currency": "BTC", "to_currency": "USDT" }' Copy 0.5,\ "from_currency" => "BTC",\ "to_currency" => "USDT"\ ]; $headers = [\ 'Content-Type: application/json',\ 'general_api_key: YOUR_GENERAL_API_KEY'\ ]; $options = array( 'http' => array( 'header' => implode("\r\n", $headers), 'method' => 'POST', 'content' => json_encode($data), ), ); $context = stream_context_create($options); $response = file_get_contents($url, false, $context); if ($response === FALSE) { die('Error occurred'); } $result = json_decode($response, true); var_dump($result); ?> Copy const axios = require('axios'); const url = 'https://api.oxapay.com/v1/general/swap'; const data = { amount: 0.5, from_currency: "BTC", to_currency: "USDT", }; const headers = { 'general_api_key': `YOUR_GENERAL_API_KEY`, 'Content-Type': 'application/json', }; axios.post(url, data, { headers }) .then((response) => { console.log(response.data); }) .catch((error) => { console.error(error); }); Copy import requests import json url = 'https://api.oxapay.com/v1/general/swap' data = { "amount": 0.5, "from_currency": "BTC", "to_currency": "USDT" } headers = { 'general_api_key': 'YOUR_GENERAL_API_KEY', 'Content-Type': 'application/json' } response = requests.post(url, data=json.dumps(data), headers=headers) result = response.json() print(result) Please make sure to replace `YOUR_GENERAL_API_KEY` in the code snippets with your actual General API Key. These example code snippets demonstrate how to request the "Swap Request" endpoint using different programming languages. You can customize the data parameters according to your specific requirements. ### [](https://docs.oxapay.com/api-reference/swap/swap-request2#api-response-example) API Response Example Copy { "data": { "track_id": "393831199", "from_currency": "USDT", "to_currency": "BTC", "from_amount": 10.0000000000, "to_amount": 0.0001054000, "rate": 94876.66034156, "date": 1736508792 }, "message": "Operation completed successfully!", "error": {}, "status": 200, "version": "1.0.0" } The response example above is provided to help you understand the format and structure of the response. If you have any further questions or need assistance, please feel free to contact to your account manager. Last updated 10 months ago --- # Generate Invoice2 | OxaPay Docs This endpoint enables you to generate a new invoice and obtain a payment URL for completing the transaction. By providing the required parameters in your request, you can specify the invoice amount and customize various options for the payment process. `POST` `https://api.oxapay.com/v1/payment/invoice` #### [](https://docs.oxapay.com/api-reference/payment/generate-invoice2#authentication) Authentication You must include the **Merchant API Key** in the request header to authenticate your access to the API. Name Type Description merchant\_api\_key\* string Your merchant API Key for authentication and authorization. #### [](https://docs.oxapay.com/api-reference/payment/generate-invoice2#request-body) Request Body Name Type Description amount\* decimal The amount for the payment. If the `currency` field is not filled, the amount should be specified in dollars. If the \`currency\` field is filled, the amount should correspond to the specified currency. currency string Specify the [currency symbol](https://docs.oxapay.com/api-reference/common/supported-currencies2) if you want the invoice amount calculated with a specific currency. You can also generate invoices in [fiat currencies](https://docs.oxapay.com/api-reference/common/supported-fiat-currencies2) . lifetime integer Set the expiration time for the payment link in minutes (15-2880). **Default:** 60. fee\_paid\_by\_payer decimal Specify whether the payer will cover the invoice commission. `1` indicates that the payer will pay the fee, while `0` indicates that the merchant will pay the fee. **Default**: Merchant setting. under\_paid\_coverage decimal Specify the acceptable inaccuracy in payment. Determines the maximum acceptable difference between the requested and paid amount (0-60.00). **Default:** Merchant setting to\_currency string The [currency](https://docs.oxapay.com/api-reference/common/supported-currencies2) symbol of the cryptocurrency you want to convert to. You only can convert paid crypto currencies to USDT. auto\_withdrawal boolean `1` indicates that the received currency will be sent to the address specified in your Address List on the Settings page and `0` indicates that the amount will be credited to your OxaPay balance. mixed\_payment boolean Specify whether the payer can cover the remaining amount with another currency if they pay less than the invoice amount. `1` allows the user to pay the remainder with a different coin, while `0` doesn't allow it. **Default**: Merchant setting. callback\_url string The URL where payment information will be sent. Use this to receive notifications about the payment status. return\_url string The URL where the payer will be redirected after a successful payment. email string Provide the payer's email address for reporting purposes. order\_id string Specify a unique order ID for reference in your system. thanks\_message string A thanks message that brief note displayed to the payer after a successful payment. description string Provide order details or any additional information that will be shown in different reports. sandbox boolean The sandbox field is a boolean that specifies whether the API request should operate in sandbox mode (test environment). Set it to true for testing and false for live transactions. 200 OK Copy { "data": { "track_id": string, // Unique identifier for the payment session in the OxaPay gateway. It is used to track the payment status, query details, and generate reports. "payment_url": string, // The URL of the payment page linked to the track ID. This link is shared with the payer to complete the payment process. "expired_at": integer, // The expiration timestamp (UNIX epoch) of the payment link. After this time, the link becomes invalid. "date": integer // The creation timestamp (UNIX epoch) of the payment session. }, "message": string, // A message containing additional information about the result of the request. "error": { "type": string, "key": string, "message": string } || {}, // An object that provides details about any errors that occurred. "status": integer, // The status of the request response. Typically provided as a numeric code (e.g., 200 for success or other codes for errors). "version": string // The version of the API being used. } If the payer sends the exact amount or a higher amount, you will receive the paid amount. Please note that a successful request will return status 200. In case of any issues or validation problems, refer to the corresponding [error](https://docs.oxapay.com/api-reference/error) for further details. ### [](https://docs.oxapay.com/api-reference/payment/generate-invoice2#api-request-sample-codes) API Request Sample Codes cURL PHP Node.js Python Copy curl -X POST https://api.oxapay.com/v1/payment/invoice \ -H "merchant_api_key: YOUR_MERCHANT_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "amount": 100, "currency": "USD", "lifetime": 30, "fee_paid_by_payer": 1, "under_paid_coverage": 2.5, "to_currency": "USDT", "auto_withdrawal": false, "mixed_payment": true, "callback_url": "https://example.com/callback", "return_url": "https://example.com/success", "email": "[email protected]", "order_id": "ORD-12345", "thanks_message": "Thanks message", "description": "Order #12345", "sandbox": false }' Copy 100,\ "currency" => "USD",\ "lifetime" => 30,\ "fee_paid_by_payer" => 1,\ "under_paid_coverage" => 2.5,\ "to_currency" => "USDT",\ "auto_withdrawal" => false,\ "mixed_payment" => true,\ "callback_url" => "https://example.com/callback",\ "return_url" => "https://example.com/success",\ "email" => "[email protected]",\ "order_id" => "ORD-12345",\ "thanks_message" => "Thanks message",\ "description" => "Order #12345",\ "sandbox" => false\ ]; $headers = [\ 'Content-Type: application/json',\ 'merchant_api_key: YOUR_MERCHANT_API_KEY'\ ]; $options = array( 'http' => array( 'header' => implode("\r\n", $headers), 'method' => 'POST', 'content' => json_encode($data), ), ); $context = stream_context_create($options); $response = file_get_contents($url, false, $context); if ($response === FALSE) { die('Error occurred'); } $result = json_decode($response, true); var_dump($result); ?> Copy const axios = require('axios'); const url = 'https://api.oxapay.com/v1/payment/invoice'; const data = { amount: 100, currency: "USD", lifetime: 30, fee_paid_by_payer: 1, under_paid_coverage: 2.5, to_currency: "USDT", auto_withdrawal: false, mixed_payment: true, callback_url: "https://example.com/callback", return_url: "https://example.com/success", email: "[email protected]", order_id: "ORD-12345", thanks_message: "Thanks message", description: "Order #12345", sandbox: false }; const headers = { 'merchant_api_key': `YOUR_MERCHANT_API_KEY`, 'Content-Type': 'application/json', }; axios.post(url, data, { headers }) .then((response) => { console.log(response.data); }) .catch((error) => { console.error(error); }); Copy import requests import json url = 'https://api.oxapay.com/v1/payment/invoice' data = { "amount": 100, "currency": "USD", "lifetime": 30, "fee_paid_by_payer": 1, "under_paid_coverage": 2.5, "to_currency": "USDT", "auto_withdrawal": False, "mixed_payment": True, "callback_url": "https://example.com/callback", "return_url": "https://example.com/success", "email": "[email protected]", "order_id": "ORD-12345", "thanks_message": "Thanks message", "description": "Order #12345", "sandbox": False } headers = { 'merchant_api_key': 'YOUR_MERCHANT_API_KEY', 'Content-Type': 'application/json' } response = requests.post(url, data=json.dumps(data), headers=headers) result = response.json() print(result) Please make sure to replace `YOUR_MERCHANT_API_KEY` in the code snippets with your actual merchant API Key. These example code snippets demonstrate how to request the "Generate Invoice" endpoint using different programming languages. You can customize the data parameters according to your specific requirements. ### [](https://docs.oxapay.com/api-reference/payment/generate-invoice2#api-response-example) API Response Example Copy { "data": { "track_id": "184747701", "payment_url": "http://pay.oxapay.com/12373985/184747701", "expired_at": 1734546589, "date": 1734510589 }, "message": "Operation completed successfully!", "error": {}, "status": 200, "version": "1.0.0" } The response example above is provided to help you understand the format and structure of the response. If you have any further questions or need assistance, please feel free to contact to your account manager. Last updated 7 months ago --- # Generate Payout2 | OxaPay Docs This endpoint enables you to generate a cryptocurrency payout request, allowing you to transfer funds to a specified address. It is designed to facilitate seamless and secure transactions by generating a payout request within your account. `POST` `https://api.oxapay.com/v1/payout` #### [](https://docs.oxapay.com/api-reference/payout/generate-payout2#authentication) Authentication You must include the **Payout API Key** in the request header to authenticate your access to the API. Name Type Description payout\_api\_key\* string Your Payout API Key for authentication and authorization. #### [](https://docs.oxapay.com/api-reference/payout/generate-payout2#request-body) Request Body Name Type Description address\* string The recipient's cryptocurrency address where the payout will be sent. currency\* string The symbol of the cryptocurrency to be sent (e.g., BTC, ETH, LTC, etc.). amount\* decimal The exact amount of cryptocurrency to be sent as the payout. network string The blockchain network to be used for the payout. Required for currencies with multi supported networks. callback\_url string The URL for sending payment status updates. memo string A memo or tag for transactions on supported networks (e.g., for TON). description string A description or additional information for the payout, useful for reports. 200: OK Copy { "data": { "track_id": string, // The unique identifier for the pay in the OxaPay payment gateway. You can use this track ID to query the payment status and generate reports. "status": string // The status of payout transaction. }, "message": string, // A message containing additional information about the result of the request. "error": { "type": string, "key": string, "message": string } || {}, // An object that provides details about any errors that occurred. "status": integer, // The status of the request response. Typically provided as a numeric code (e.g., 200 for success or other codes for errors). "version": string // The version of the API being used. } Please note that a successful request will return status 200. In case of any issues or validation problems, refer to the corresponding [error](https://docs.oxapay.com/api-reference/error) for further details. ### [](https://docs.oxapay.com/api-reference/payout/generate-payout2#api-request-sample-codes) API Request Sample Codes cURL PHP Node.js Python Copy curl -X POST https://api.oxapay.com/v1/payout \ -H "payout_api_key: YOUR_PAYOUT_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "address": "RECEIVER_ADDRESS", "amount": 5, "currency": "TRX", "network": "TRC20", "callback_url": "https://example.com/callback", "memo": "Memo12345", "description": "Order #12345" }' Copy "RECEIVER_ADDRESS",\ "amount" => 5,\ "currency" => "TRX",\ "network" => "TRC20",\ "callback_url" => "https://example.com/callback",\ "memo" => "Memo12345",\ "description" => "Order #12345"\ ]; $headers = [\ 'Content-Type: application/json',\ 'payout_api_key: YOUR_PAYOUT_API_KEY'\ ]; $options = array( 'http' => array( 'header' => implode("\r\n", $headers), 'method' => 'POST', 'content' => json_encode($data), ), ); $context = stream_context_create($options); $response = file_get_contents($url, false, $context); if ($response === FALSE) { die('Error occurred'); } $result = json_decode($response, true); var_dump($result); ?> Copy const axios = require('axios'); const url = 'https://api.oxapay.com/v1/payout'; const data = { address: "RECEIVER_ADDRESS", amount: 5, currency: "TRX", network: "TRC20", callback_url: "https://example.com/callback", memo: "Memo12345", description: "Order #12345" }; const headers = { 'payout_api_key': `YOUR_PAYOUT_API_KEY`, 'Content-Type': 'application/json', }; axios.post(url, data, { headers }) .then((response) => { console.log(response.data); }) .catch((error) => { console.error(error); }); Copy import requests import json url = 'https://api.oxapay.com/v1/payout' data = { "address": "RECEIVER_ADDRESS", "amount": 5, "currency": "TRX", "network": "TRC20", "callback_url": "https://example.com/callback", "memo": "Memo12345", "description": "Order #12345" } headers = { 'payout_api_key': 'YOUR_PAYOUT_API_KEY', 'Content-Type': 'application/json' } response = requests.post(url, data=json.dumps(data), headers=headers) result = response.json() print(result) Please make sure to replace `YOUR_PAYOUT_API_KEY` in the code snippets with your actual Payout API Key. These example code snippets demonstrate how to request the "Generate Payout" endpoint using different programming languages. You can customize the data parameters according to your specific requirements. ### [](https://docs.oxapay.com/api-reference/payout/generate-payout2#api-response-example) API Response Example Copy { "data": { "track_id": "258298451", "status": "processing" }, "message": "Operation completed successfully!", "error": {}, "status": 200, "version": "1.0.0" } The response example above is provided to help you understand the format and structure of the response. If you have any further questions or need assistance, please feel free to contact to your account manager. Last updated 10 months ago --- # Generate Static Address2 | OxaPay Docs This endpoint allows you to generate a static address for a specific currency and network. The static address will be linked to a unique track\_id, and if a callback\_url is provided, your server will receive notifications for any payments made to the address. This enables you to track and receive transactions to the static address, regardless of the amount or timing. > Please note that static addresses with no transactions for six months will be revoked. `POST` `https://api.oxapay.com/v1/payment/static-address` #### [](https://docs.oxapay.com/api-reference/payment/generate-static-address2#authentication) Authentication You must include the **Merchant API Key** in the request header to authenticate your access to the API. Name Type Description merchant\_api\_key\* string Your merchant API Key for authentication and authorization. #### [](https://docs.oxapay.com/api-reference/payment/generate-static-address2#request-body) Request Body Name Type Description network\* string The blockchain [network](https://docs.oxapay.com/api-reference/common/supported-networks2) on which the static address should be created. to\_currency string The [currency](https://docs.oxapay.com/api-reference/common/supported-currencies2) symbol of the cryptocurrency you want to convert to. auto\_withdrawal decimal `1` indicates that the received currency will be sent to the address specified in your Address List on the Settings page and `0` indicates that the amount will be credited to your OxaPay balance. callback\_url string The URL where payment information will be sent. Use this to receive notifications about payments made to the static address. email string Provide the payer's email address for reporting purposes. order\_id string Specify a unique order ID for reference in your system. description string Provide order details or any additional information that will be shown in different reports. 200: OK Copy { "data": { "track_id": "string, // Unique identifier for each payment session in the OxaPay payment gateway. It can be used to query the payment status and generate reports. "network": string, // The blockchain network where the cryptocurrency payment is expected to be received (e.g., "Bitcoin Network"). "address": string, // The generated cryptocurrency address where the payer should send the payment. "qr_code": string, // URL to a QR code image containing the cryptocurrency address and payment amount for easier transactions. "date": integer // Timestamp (UNIX epoch) indicating when the static payment address was created. } "message": string, // A message containing additional information about the result of the request. "error": { "type": string, "key": string, "message": string } || {}, // An object that provides details about any errors that occurred. "status": integer, // The status of the request response. Typically provided as a numeric code (e.g., 200 for success or other codes for errors). "version": string // The version of the API being used. } Please note that a successful request will return status 200. In case of any issues or validation problems, refer to the corresponding [error](https://docs.oxapay.com/api-reference/error) for further details. ### [](https://docs.oxapay.com/api-reference/payment/generate-static-address2#api-request-sample-codes) API Request Sample Codes cURL PHP Node.js Python Copy curl -X POST https://api.oxapay.com/v1/payment/static-address \ -H "merchant_api_key: YOUR_MERCHANT_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "network": "TRON", "to_currency": "USDT", "auto_withdrawal": false, "callback_url": "https://example.com/callback", "email": "[email protected]", "order_id": "ORD-12345", "description": "Order #12345" }' Copy "TRON",\ "to_currency" => "USDT",\ "auto_withdrawal" => false,\ "callback_url" => "https://example.com/callback",\ "email" => "[email protected]",\ "order_id" => "ORD-12345",\ "description" => "Order #12345"\ ]; $headers = [\ 'Content-Type: application/json',\ 'merchant_api_key: YOUR_MERCHANT_API_KEY'\ ]; $options = array( 'http' => array( 'header' => implode("\r\n", $headers), 'method' => 'POST', 'content' => json_encode($data), ), ); $context = stream_context_create($options); $response = file_get_contents($url, false, $context); if ($response === FALSE) { die('Error occurred'); } $result = json_decode($response, true); var_dump($result); ?> Copy const axios = require('axios'); const url = 'https://api.oxapay.com/v1/payment/static-address'; const data = { network: "TRON", to_currency: "USDT", auto_withdrawal: false, callback_url: "https://example.com/callback", email: "[email protected]", order_id: "ORD-12345", description: "Order #12345" }; const headers = { 'merchant_api_key': `YOUR_MERCHANT_API_KEY`, 'Content-Type': 'application/json', }; axios.post(url, data, { headers }) .then((response) => { console.log(response.data); }) .catch((error) => { console.error(error); }); Copy import requests import json url = 'https://api.oxapay.com/v1/payment/static-address' data = { "network": "TRON", "to_currency": "USDT", "auto_withdrawal": False, "callback_url": "https://example.com/callback", "email": "[email protected]", "order_id": "ORD-12345", "description": "Order #12345" } headers = { 'merchant_api_key': 'YOUR_MERCHANT_API_KEY', 'Content-Type': 'application/json' } response = requests.post(url, data=json.dumps(data), headers=headers) result = response.json() print(result) Please make sure to replace `YOUR_MERCHANT_API_KEY` in the code snippets with your actual merchant API Key. These example code snippets demonstrate how to request the "Generate Static Address" endpoint using different programming languages. You can customize the data parameters according to your specific requirements. ### [](https://docs.oxapay.com/api-reference/payment/generate-static-address2#api-response-example) API Response Example Copy { "data": { "track_id": "182796736", "network": "Tron Network", "address": "TX7U8wnnafXeXED3ChjeuiZFznL3BU1gX3", "qr_code": "https://api.qrserver.com/v1/create-qr-code/?data=tron:TX7U8wnnafXeXED3ChjeuiZFznL3BU1gX3&size=150x150", "date": 1734511347 }, "message": "Operation completed successfully!", "error": {}, "status": 200, "version": "1.0.0" } The response example above is provided to help you understand the format and structure of the response. If you have any further questions or need assistance, please feel free to contact to your account manager. Last updated 10 months ago --- # Generate White Label2 | OxaPay Docs This endpoint allows you to generate white-labeled payment solutions, delivering a fully branded payment experience powered by the OxaPay gateway. Instead of generating an invoice URL, this endpoint provides comprehensive payment details, including the payment address, currency, amount, expiration time, and other relevant information, enabling you to manage the payment process within your own interface. `POST` `https://api.oxapay.com/v1/payment/white-label` #### [](https://docs.oxapay.com/api-reference/payment/generate-white-label2#authentication) Authentication You must include the **Merchant API Key** in the request header to authenticate your access to the API. Name Type Description merchant\_api\_key\* string Your merchant API Key for authentication and authorization. #### [](https://docs.oxapay.com/api-reference/payment/generate-white-label2#request-body) Request Body Name Type Description pay\_currency\* string Specify the [currency symbol](https://docs.oxapay.com/api-reference/common/supported-currencies2) if you want the invoice to be paid in a specific currency. Defines the currency in which you wish to receive your settlements. amount\* decimal The amount for the payment. If the `currency` field is not filled, the amount should be specified in dollars. If the `currency` field is filled, the amount should correspond to the specified currency. currency string Specify the [currency symbol](https://docs.oxapay.com/api-reference/common/supported-currencies2) if you want the invoice amount calculated with a specific currency. You can also create invoices in [fiat currencies](https://docs.oxapay.com/api-reference/common/supported-fiat-currencies2) . network string The blockchain [network](https://docs.oxapay.com/api-reference/common/supported-networks2) on which the payment should be created. If not specified, the default network will be used. lifetime integer Set the expiration time for the payment link in minutes (15-2880). **Default**: 60. fee\_paid\_by\_payer decimal Specify whether the payer will cover the invoice commission. `1` indicates that the payer will pay the fee, while `0` indicates that the merchant will pay the fee. **Default**: Merchant setting. under\_paid\_coverage decimal Specify the acceptable inaccuracy in payment. Determines the maximum acceptable difference between the requested and paid amount (0-60.00). **Default:** Merchant setting. to\_currency string he [currency](https://docs.oxapay.com/api-reference/common/supported-currencies2) symbol of the cryptocurrency you want to convert to. You only can convert paid crypto currencies to USDT. auto\_withdrawal boolean `1` indicates that the received currency will be sent to the address specified in your Address List on the Settings page and `0` indicates that the amount will be credited to your OxaPay balance. callback\_url string The URL where payment information will be sent. Use this to receive notifications about the payment status. email string Provide the payer's email address for reporting purposes. order\_id string Specify a unique order ID for reference in your system. description string Provide order details or any additional information that will be shown in different reports. 200: OK Copy { "data": { "track_id": string, // Unique identifier for the payment "amount": decimal, // The amount of currency for the invoice "currency": string, // The currency in which the amount is specified (e.g., "usd") "pay_amount": decimal, // The amount to be paid in the payment currency (e.g., BTC value) "pay_currency": string, // The currency in which the payment is made (e.g., "btc") "network": string, // The blockchain network being used (e.g., "Bitcoin Network") "address": string, // The wallet address where the payment will be sent "callback_url": string, // The URL to which payment status updates will be sent "description": string, // A description for the invoice "email": string, // The email address of the payer "fee_paid_by_payer": decimal, // Indicates if the payer is responsible for paying the network fees (1 = yes, 0 = no) "lifetime": integer, // The lifetime of the invoice in minutes before it expires "order_id": string, // A unique identifier for the order associated with this invoice "under_paid_coverage": decimal, // The percentage of underpayment that will still be considered valid "rate": decimal, // The exchange rate between the base currency and the payment currency "qr_code": string, // URL to a QR code representing the payment address and amount "expired_at": integer, // Timestamp (UNIX epoch) when the invoice will expire "date": integer // Timestamp (UNIX epoch) of when the invoice was created }, "message": string, // A message containing additional information about the result of the request. "error": { "type": string, "key": string, "message": string } || {}, // An object that provides details about any errors that occurred. "status": integer, // The status of the request response. Typically provided as a numeric code (e.g., 200 for success or other codes for errors). "version": string // The version of the API being used. } If the payer sends the exact amount or a higher amount, you will receive the paid amount. Please note that a successful request will return status 200. In case of any issues or validation problems, refer to the corresponding [error](https://docs.oxapay.com/api-reference/error) for further details. ### [](https://docs.oxapay.com/api-reference/payment/generate-white-label2#api-request-sample-codes) API Request Sample Codes cURL PHP Node.js Python Copy curl -X POST https://api.oxapay.com/v1/payment/white-label \ -H "merchant_api_key: YOUR_MERCHANT_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "amount": 100, "currency": "USD", "pay_currency": "TRX", "network": "TRC20", "lifetime": 60, "fee_paid_by_payer": 1, "under_paid_coverage": 20, "to_currency": "USDT", "auto_withdrawal": false, "callback_url": "https://example.com/callback", "email": "[email protected]", "order_id": "ORD-12345", "description": "Order #12345", }' Copy 100,\ "currency" => "USD",\ "pay_currency" => "TRX",\ "network" => "TRC20",\ "lifetime" => 60,\ "fee_paid_by_payer" => 1,\ "under_paid_coverage" => 20,\ "to_currency" => "USDT",\ "auto_withdrawal" => false,\ "callback_url" => "https://example.com/callback",\ "email" => "[email protected]",\ "order_id" => "ORD-12345",\ "description" => "Order #12345"\ ]; $headers = [\ 'Content-Type: application/json',\ 'merchant_api_key: YOUR_MERCHANT_API_KEY'\ ]; $options = array( 'http' => array( 'header' => implode("\r\n", $headers), 'method' => 'POST', 'content' => json_encode($data), ), ); $context = stream_context_create($options); $response = file_get_contents($url, false, $context); if ($response === FALSE) { die('Error occurred'); } $result = json_decode($response, true); var_dump($result); ?> Copy const axios = require('axios'); const url = 'https://api.oxapay.com/v1/payment/white-label'; const data = { amount: 100, currency: "USD", pay_currency: "TRX", network: "TRC20", lifetime: 60, fee_paid_by_payer: 1, under_paid_coverage: 20, to_currency: "USDT", auto_withdrawal: false, callback_url: "https://example.com/callback", email: "[email protected]", order_id: "ORD-12345", description: "Order #12345" }; const headers = { 'merchant_api_key': `YOUR_MERCHANT_API_KEY`, 'Content-Type': 'application/json', }; axios.post(url, data, { headers }) .then((response) => { console.log(response.data); }) .catch((error) => { console.error(error); }); Copy import requests import json url = 'https://api.oxapay.com/v1/payment/white-label' data = { "amount": 100, "currency": "USD", "pay_currency": "TRX", "network": "TRC20", "lifetime": 60, "fee_paid_by_payer": 1, "under_paid_coverage": 20, "to_currency": "USDT", "auto_withdrawal": False, "callback_url": "https://example.com/callback", "email": "[email protected]", "order_id": "ORD-12345", "description": "Order #12345", } headers = { 'merchant_api_key': 'YOUR_MERCHANT_API_KEY', 'Content-Type': 'application/json' } response = requests.post(url, data=json.dumps(data), headers=headers) result = response.json() print(result) Please make sure to replace `YOUR_MERCHANT_API_KEY` in the code snippets with your actual merchant API Key. These example code snippets demonstrate how to request the "Generate White Label" endpoint using different programming languages. You can customize the data parameters according to your specific requirements. ### [](https://docs.oxapay.com/api-reference/payment/generate-white-label2#api-response-example) API Response Example Copy { "data": { "track_id": "197218291", "amount": 1, "currency": "usd", "pay_amount": 3.6819352872888, "pay_currency": "trx", "network": "Tron Network", "address": "TQraad2MBFgYUYhTFYeXS5jVpaLZuBwr3w", "callback_url": "https://example.com/callback", "description": "Order #12345", "email": "[email protected]", "fee_paid_by_payer": 1, "lifetime": 60, "order_id": "ORD-12345", "under_paid_coverage": 20, "rate": 3.67376929, "qr_code": "https://api.qrserver.com/v1/create-qr-code/?data=tron:TQraad2MBFgYUYhTFYeXS5jVpaLZuBwr3w?amount=3&size=150x150", "expired_at": 1734514150, "date": 1734510550 }, "message": "Operation completed successfully!", "error": {}, "status": 200, "version": "1.0.0" } The response example above is provided to help you understand the format and structure of the response. If you have any further questions or need assistance, please feel free to contact to your account manager. Last updated 10 months ago --- # Swap Pairs2 | OxaPay Docs This endpoint allows you to access a list of swappable cryptocurrencies along with their minimum swap amounts. It provides the available options for the from\_currency and to\_currency fields when performing cryptocurrency swaps. Whether you're swapping Bitcoin for Tether or Tether for Litecoin, this list ensures clarity on supported pairs and their minimum swap requirements, helping you plan seamless transactions. `GET` `https://api.oxapay.com/v1/general/swap/pairs` #### [](https://docs.oxapay.com/api-reference/swap/swap-pairs2#authentication) Authentication You must include the **General API Key** in the request header to authenticate your access to the API. Name Type Description general\_api\_key\* string Your General API Key for authentication and authorization. 200: OK Copy { "data": { "list": { "from_currency": string, // The currency being swapped from, e.g., 'BTC' (Bitcoin). "to_currency": string, // The currency being swapped to, e.g., 'USDT' (Tether). "min_amount": decimal // The minimum amount of the "from_currency" required for the swap, represented with high precision (e.g., 0.01 BTC). }[], "meta": { "page": integer, // The current page number of the result set. "last_page": integer, // The total number of pages available based on the number of records and page size. "total": integer // The total number of payments available for the specified criteria. }, }, "message": string, // A message containing additional information about the result of the request. "error": { "type": string, "key": string, "message": string } || {}, // An object that provides details about any errors that occurred. "status": integer, // The status of the request response. Typically provided as a numeric code (e.g., 200 for success or other codes for errors). "version": string // The version of the API being used. } Please note that a successful request will return status 200. In case of any issues or validation problems, refer to the corresponding [error](https://docs.oxapay.com/api-reference/error) for further details. ### [](https://docs.oxapay.com/api-reference/swap/swap-pairs2#api-request-sample-codes) API Request Sample Codes cURL PHP Node.js Python Copy curl -X GET https://api.oxapay.com/v1/general/swap/pairs \ -H "general_api_key: YOUR_GENERAL_API_KEY" \ -H "Content-Type: application/json" Copy array( 'header' => implode("\r\n", $headers), 'method' => 'GET' ), ); $context = stream_context_create($options); $response = file_get_contents($url, false, $context); if ($response === FALSE) { die('Error occurred'); } $result = json_decode($response, true); var_dump($result); ?> Copy const axios = require('axios'); const url = 'https://api.oxapay.com/v1/general/swap/pairs'; const headers = { 'general_api_key': `YOUR_GENERAL_API_KEY`, 'Content-Type': 'application/json', }; axios.get(url, { headers }) .then((response) => { console.log(response.data); }) .catch((error) => { console.error(error); }); Copy import requests url = 'https://api.oxapay.com/v1/general/swap/pairs' headers = { 'general_api_key': 'YOUR_GENERAL_API_KEY', 'Content-Type': 'application/json' } response = requests.get(url, headers=headers) result = response.json() print(result) These example code snippets demonstrate how to request the "Swap Calculate" endpoint using different programming languages. You can customize the data parameters according to your specific requirements. Please make sure to replace `YOUR_GENERAL_API_KEY` in the code snippets with your actual General API Key. ### [](https://docs.oxapay.com/api-reference/swap/swap-pairs2#api-response-example) API Response Example Copy { "data":{ "list": [\ { "fromCurrency": "BTC", "toCurrency": "USDT", "minAmount": 0.0003 }, \ { "fromCurrency": "ETH", "toCurrency": "USDT", "minAmount": 0.005 }, \ { "fromCurrency": "BNB", "toCurrency": "USDT", "minAmount": 0.01 }, \ { "fromCurrency": "LTC", "toCurrency": "USDT", "minAmount": 0.05 }, \ { "fromCurrency": "TRX", "toCurrency": "USDT", "minAmount": 1 }, \ { "fromCurrency": "DOGE", "toCurrency": "USDT", "minAmount": 1 }, \ { "fromCurrency": "MATIC", "toCurrency": "USDT", "minAmount": 0.1 }, \ { "fromCurrency": "TON", "toCurrency": "USDT", "minAmount": 0.1 }, \ { "fromCurrency": "XMR", "toCurrency": "USDT", "minAmount": 0.01 }, \ { "fromCurrency": "BCH", "toCurrency": "USDT", "minAmount": 0.005 }, \ { "fromCurrency": "SHIB", "toCurrency": "USDT", "minAmount": 100000 }, \ { "fromCurrency": "SOL", "toCurrency": "USDT", "minAmount": 0.008 }, \ { "fromCurrency": "USDT", "toCurrency": "BTC", "minAmount": 1 }, \ { "fromCurrency": "USDT", "toCurrency": "ETH", "minAmount": 1 }, \ { "fromCurrency": "USDT", "toCurrency": "BNB", "minAmount": 1 }, \ { "fromCurrency": "USDT", "toCurrency": "LTC", "minAmount": 1 }, \ { "fromCurrency": "USDT", "toCurrency": "TRX", "minAmount": 1 }, \ { "fromCurrency": "USDT", "toCurrency": "DOGE", "minAmount": 1 }, \ { "fromCurrency": "USDT", "toCurrency": "MATIC", "minAmount": 1 }, \ { "fromCurrency": "USDT", "toCurrency": "TON", "minAmount": 1 }, \ { "fromCurrency": "USDT", "toCurrency": "XMR", "minAmount": 1 }, \ { "fromCurrency": "USDT", "toCurrency": "BCH", "minAmount": 1 }, \ { "fromCurrency": "USDT", "toCurrency": "SHIB", "minAmount": 1 }, \ { "fromCurrency": "USDT", "toCurrency": "SOL", "minAmount": 1 }\ ] }, "message": "Operation completed successfully!", "error": {}, "status": 200, "version": "1.0.0" } The response example above is provided to help you understand the format and structure of the response. If you have any further questions or need assistance, please feel free to contact to your account manager. Last updated 10 months ago --- # Supported Currencies2 | OxaPay Docs This endpoint allows you to access a comprehensive list of supported cryptocurrencies, including their network details, symbol, name, and withdrawal information, enabling you to identify the appropriate network for each currency. `GET` `https://api.oxapay.com/v1/common/currencies` 200: OK Copy { "data": { [currencySymbol: string]: { "symbol": string, "name": string, "status": boolean, "networks": { ["networkName": string]: { "network": string, "name": string, "keys": array, "required_confirmations": integer, "withdraw_fee": decimal, "withdraw_min": decimal, "deposit_min": decimal, "static_fixed_fee": decimal, }; } // Represents dynamic keys (currency symbol) with object values. }, "message": string, // A message containing additional information about the result of the request "error": { "type": string, "key": string, "message": string } || {}, // An object that provides details about any errors that occurred. "status": integer, // The status of the request response. Typically provided as a numeric code (e.g., 200 for success or other codes for errors). "version": string // The version of the API being used. } Please note that a successful request will return status 200. In case of any issues or validation problems, refer to the corresponding [error](https://docs.oxapay.com/api-reference/error) for further details. ### [](https://docs.oxapay.com/api-reference/common/supported-currencies2#api-request-sample-codes) API Request Sample Codes cURL PHP Node.js Python Copy curl -X GET https://api.oxapay.com/v1/common/currencies Copy array( 'method' => 'GET' ), ); $context = stream_context_create($options); $response = file_get_contents($url, false, $context); if ($response === FALSE) { die('Error occurred'); } $result = json_decode($response, true); var_dump($result); ?> Copy const axios = require('axios'); const url = 'https://api.oxapay.com/v1/common/currencies'; axios.get(url) .then((response) => { console.log(response.data); }) .catch((error) => { console.error(error); }); Copy import requests url = 'https://api.oxapay.com/v1/common/currencies' response = requests.get(url) result = response.json() print(result) These example code snippets demonstrate how to request the "Supported Currencies" endpoint using different programming languages. You can customize the data parameters according to your specific requirements. ### [](https://docs.oxapay.com/api-reference/common/supported-currencies2#api-response-example) API Response Example Copy { "data": { "BTC": { "symbol": "BTC", "name": "Bitcoin", "status": true, "networks": { "Bitcoin": { "network": "Bitcoin", "name": "Bitcoin Network", "keys": [\ "Bitcoin",\ "BTC"\ ], "required_confirmations": 2, "withdraw_fee": 0.00011, "withdraw_min": 4.5e-5, "deposit_min": 9.28e-8, "static_fixed_fee": 2.0e-6 } } }, "ETH": { "symbol": "ETH", "name": "Ethereum", "status": true, "networks": { "Ethereum": { "network": "Ethereum", "name": "Ethereum Network", "keys": [\ "Ethereum",\ "ERC20",\ "ETH"\ ], "required_confirmations": 10, "withdraw_fee": 0.0002, "withdraw_min": 0.0001, "deposit_min": 4.0832e-6, "static_fixed_fee": 0 }, "Base": { "network": "Base", "name": "Base Network", "keys": [\ "Base"\ ], "required_confirmations": 10, "withdraw_fee": 8.0e-7, "withdraw_min": 0.0002, "deposit_min": 4.0832e-6, "static_fixed_fee": 0 } } }, "USDT": { "symbol": "USDT", "name": "Tether", "status": true, "networks": { "Ethereum": { "network": "Ethereum", "name": "Ethereum Network", "keys": [\ "Ethereum",\ "ERC20",\ "ETH"\ ], "required_confirmations": 10, "withdraw_fee": 5, "withdraw_min": 1, "deposit_min": 0.01, "static_fixed_fee": 0 }, "Tron": { "network": "Tron", "name": "Tron Network", "keys": [\ "Tron",\ "TRC20",\ "TRX"\ ], "required_confirmations": 10, "withdraw_fee": 1, "withdraw_min": 0.01, "deposit_min": 0.01, "static_fixed_fee": 0.3 }, "BSC": { "network": "BSC", "name": "Binance Smart Chain", "keys": [\ "BSC",\ "BEP20",\ "BNB",\ "Binance"\ ], "required_confirmations": 15, "withdraw_fee": 0.25, "withdraw_min": 0.01, "deposit_min": 0.01, "static_fixed_fee": 0 }, "Polygon": { "network": "Polygon", "name": "Polygon Network", "keys": [\ "Polygon",\ "POL"\ ], "required_confirmations": 50, "withdraw_fee": 0.25, "withdraw_min": 0.01, "deposit_min": 0.01, "static_fixed_fee": 0 }, "The Open Network": { "network": "The Open Network", "name": "TON Network", "keys": [\ "The Open Network",\ "TON"\ ], "required_confirmations": 3, "withdraw_fee": 0.25, "withdraw_min": 0.01, "deposit_min": 0.01, "static_fixed_fee": 0 } } }, "USDC": { "symbol": "USDC", "name": "USD Coin", "status": true, "networks": { "Ethereum": { "network": "Ethereum", "name": "Ethereum Network", "keys": [\ "Ethereum",\ "ERC20",\ "ETH"\ ], "required_confirmations": 10, "withdraw_fee": 5, "withdraw_min": 5, "deposit_min": 0.0100020004, "static_fixed_fee": 0 } } }, "BNB": { "symbol": "BNB", "name": "BNB", "status": true, "networks": { "BSC": { "network": "BSC", "name": "Binance Smart Chain", "keys": [\ "BSC",\ "BEP20",\ "BNB",\ "Binance"\ ], "required_confirmations": 15, "withdraw_fee": 1.26e-5, "withdraw_min": 0.0004, "deposit_min": 1.51999e-5, "static_fixed_fee": 0 } } }, "DOGE": { "symbol": "DOGE", "name": "Dogecoin", "status": true, "networks": { "Dogecoin": { "network": "Dogecoin", "name": "Dogecoin Network", "keys": [\ "Dogecoin",\ "DOGE"\ ], "required_confirmations": 12, "withdraw_fee": 0.009, "withdraw_min": 0.01, "deposit_min": 0.0620039683, "static_fixed_fee": 0 } } }, "POL": { "symbol": "POL", "name": "Polygon", "status": true, "networks": { "Polygon": { "network": "Polygon", "name": "Polygon Network", "keys": [\ "Polygon",\ "POL"\ ], "required_confirmations": 50, "withdraw_fee": 0.005, "withdraw_min": 0.001, "deposit_min": 0.0554323725, "static_fixed_fee": 0 } } }, "LTC": { "symbol": "LTC", "name": "Litecoin", "status": true, "networks": { "Litecoin": { "network": "Litecoin", "name": "Litecoin Network", "keys": [\ "Litecoin",\ "LTC"\ ], "required_confirmations": 3, "withdraw_fee": 0.00014, "withdraw_min": 0.002, "deposit_min": 0.0001189343, "static_fixed_fee": 0 } } }, "SOL": { "symbol": "SOL", "name": "Solana", "status": true, "networks": { "Solana": { "network": "Solana", "name": "Solana Network", "keys": [\ "Solana",\ "SOL"\ ], "required_confirmations": 30, "withdraw_fee": 3.0e-5, "withdraw_min": 0.01, "deposit_min": 6.71006e-5, "static_fixed_fee": 0 } } }, "TRX": { "symbol": "TRX", "name": "Tron", "status": true, "networks": { "Tron": { "network": "Tron", "name": "Tron Network", "keys": [\ "Tron",\ "TRC20",\ "TRX"\ ], "required_confirmations": 10, "withdraw_fee": 1, "withdraw_min": 0.0001, "deposit_min": 0.0355745286, "static_fixed_fee": 0 } } }, "SHIB": { "symbol": "SHIB", "name": "Shiba Inu", "status": true, "networks": { "BSC": { "network": "BSC", "name": "Binance Smart Chain", "keys": [\ "BSC",\ "BEP20",\ "BNB",\ "Binance"\ ], "required_confirmations": 15, "withdraw_fee": 3000, "withdraw_min": 1000, "deposit_min": 880.2816901408, "static_fixed_fee": 0 } } }, "TON": { "symbol": "TON", "name": "Toncoin", "status": true, "networks": { "The Open Network": { "network": "The Open Network", "name": "TON Network", "keys": [\ "The Open Network",\ "TON"\ ], "required_confirmations": 3, "withdraw_fee": 0.008, "withdraw_min": 0.05, "deposit_min": 0.003550632, "static_fixed_fee": 0 } } }, "XMR": { "symbol": "XMR", "name": "Monero", "status": true, "networks": { "Monero": { "network": "Monero", "name": "Monero Network", "keys": [\ "Monero",\ "XMR"\ ], "required_confirmations": 3, "withdraw_fee": 9.0e-5, "withdraw_min": 0.0001, "deposit_min": 3.13853e-5, "static_fixed_fee": 0 } } }, "DAI": { "symbol": "DAI", "name": "DAI", "status": true, "networks": { "Polygon": { "network": "Polygon", "name": "Polygon Network", "keys": [\ "Polygon",\ "POL"\ ], "required_confirmations": 50, "withdraw_fee": 1, "withdraw_min": 0.01, "deposit_min": 0.01, "static_fixed_fee": 0 } } }, "BCH": { "symbol": "BCH", "name": "Bitcoin Cash", "status": true, "networks": { "BitcoinCash": { "network": "BitcoinCash", "name": "Bitcoin Cash Network", "keys": [\ "BitcoinCash",\ "BCH"\ ], "required_confirmations": 4, "withdraw_fee": 2.4e-5, "withdraw_min": 1.0e-5, "deposit_min": 1.99045e-5, "static_fixed_fee": 0 } } }, "NOT": { "symbol": "NOT", "name": "NotCoin", "status": true, "networks": { "The Open Network": { "network": "The Open Network", "name": "TON Network", "keys": [\ "The Open Network",\ "TON"\ ], "required_confirmations": 3, "withdraw_fee": 14, "withdraw_min": 5, "deposit_min": 5.681172594, "static_fixed_fee": 0 } } }, "DOGS": { "symbol": "DOGS", "name": "Dogs", "status": true, "networks": { "The Open Network": { "network": "The Open Network", "name": "TON Network", "keys": [\ "The Open Network",\ "TON"\ ], "required_confirmations": 3, "withdraw_fee": 210, "withdraw_min": 5, "deposit_min": 80.5152979066, "static_fixed_fee": 0 } } } }, "message": "Operation completed successfully!", "error": {}, "status": 200, "version": "1.0.0" } The response example above is provided to help you understand the format and structure of the response. If you have any further questions or need assistance, please feel free to contact to your account manager. Last updated 5 months ago --- # Supported Fiat Currencies2 | OxaPay Docs This endpoint allows you to retrieve a list of supported fiat currencies, with details including currency code (e.g., USD, AUD), symbol, name, price, and display precision. Merchants can use this data to create invoices in fiat currencies. `GET` `https://api.oxapay.com/v1/common/fiats` 200: OK Copy { "data": { [key: string]: { "symbol": string, "name": string, "price": decimal, "display_precision": decimal, } // Represents dynamic keys (currency symbol) with object values. }, "message": string, // A message containing additional information about the result of the request. "error": { "type": string, "key": string, "message": string } || {}, // An object that provides details about any errors that occurred. "status": integer, // The status of the request response. Typically provided as a numeric code (e.g., 200 for success or other codes for errors). "version": string // The version of the API being used. } Please note that a successful request will return status 200. In case of any issues or validation problems, refer to the corresponding [error](https://docs.oxapay.com/api-reference/error) for further details. ### [](https://docs.oxapay.com/api-reference/common/supported-fiat-currencies2#api-request-sample-codes) API Request Sample Codes cURL PHP Node.js Python Copy curl -X GET https://api.oxapay.com/v1/common/fiats Copy array( 'method' => 'GET' ), ); $context = stream_context_create($options); $response = file_get_contents($url, false, $context); if ($response === FALSE) { die('Error occurred'); } $result = json_decode($response, true); var_dump($result); ?> Copy const axios = require('axios'); const url = 'https://api.oxapay.com/v1/common/fiats'; axios.get(url) .then((response) => { console.log(response.data); }) .catch((error) => { console.error(error); }); Copy import requests url = 'https://api.oxapay.com/v1/common/fiats' response = requests.get(url) result = response.json() print(result) These example code snippets demonstrate how to request the "Supported Fiat Currencies" endpoint using different programming languages. You can customize the data parameters according to your specific requirements. ### [](https://docs.oxapay.com/api-reference/common/supported-fiat-currencies2#api-response-example) API Response Example Copy { "data": { "USD": { "symbol": "USD", "name": "United States Dollar", "price": 1.0000000000, "display_precision": 0.00100000 }, "AMD": { "symbol": "AMD", "name": "Armenian Dram", "price": 0.0025214600, "display_precision": 0.10000000 }, "AUD": { "symbol": "AUD", "name": "Australian Dollar", "price": 0.6441713400, "display_precision": 0.00100000 }, "AZN": { "symbol": "AZN", "name": "Azerbaijani Manat", "price": 0.5882352900, "display_precision": 0.00100000 }, "BRL": { "symbol": "BRL", "name": "Brazilian Real", "price": 0.1929038700, "display_precision": 0.00100000 }, "CAD": { "symbol": "CAD", "name": "Canadian Dollar", "price": 0.7252846500, "display_precision": 0.00100000 }, "CHF": { "symbol": "CHF", "name": "Swiss Franc", "price": 1.0969049700, "display_precision": 0.00010000 }, "CNH": { "symbol": "CNH", "name": "Chinese Yuan (Offshore)", "price": 0.1377564900, "display_precision": 0.01000000 }, "CNY": { "symbol": "CNY", "name": "Chinese Yuan", "price": 0.1381584300, "display_precision": 0.00100000 }, "CZK": { "symbol": "CZK", "name": "Czech Republic Koruna", "price": 0.0420012800, "display_precision": 0.01000000 }, "DKK": { "symbol": "DKK", "name": "Danish Krone", "price": 0.1424081900, "display_precision": 0.00100000 }, "EUR": { "symbol": "EUR", "name": "Euro", "price": 1.0624553700, "display_precision": 0.00010000 }, "GBP": { "symbol": "GBP", "name": "British Pound Sterling", "price": 1.2445643600, "display_precision": 0.00010000 }, "GHS": { "symbol": "GHS", "name": "Ghanaian Cedi", "price": 0.0743720600, "display_precision": 0.01000000 }, "HKD": { "symbol": "HKD", "name": "Hong Kong Dollar", "price": 0.1277318100, "display_precision": 0.01000000 }, "HUF": { "symbol": "HUF", "name": "Hungarian Forint", "price": 0.0026962900, "display_precision": 0.10000000 }, "IDR": { "symbol": "IDR", "name": "Indonesian Rupiah", "price": 0.0000621600, "display_precision": 1.00000000 }, "ILS": { "symbol": "ILS", "name": "Israeli New Sheqel", "price": 0.2663094500, "display_precision": 0.00100000 }, "INR": { "symbol": "INR", "name": "Indian Rupee", "price": 0.0119749500, "display_precision": 0.01000000 }, "ISK": { "symbol": "ISK", "name": "Icelandic Króna", "price": 0.0070613100, "display_precision": 0.10000000 }, "JPY": { "symbol": "JPY", "name": "Japanese Yen", "price": 0.0064821000, "display_precision": 0.10000000 }, "KRW": { "symbol": "KRW", "name": "South Korean Won", "price": 0.0007204800, "display_precision": 1.00000000 }, "KZT": { "symbol": "KZT", "name": "Kazakhstani Tenge", "price": 0.0022311200, "display_precision": 0.10000000 }, "MXN": { "symbol": "MXN", "name": "Mexican Peso", "price": 0.0598135800, "display_precision": 0.01000000 }, "MYR": { "symbol": "MYR", "name": "Malaysian Ringgit", "price": 0.2094855000, "display_precision": 0.00100000 }, "NOK": { "symbol": "NOK", "name": "Norwegian Krone", "price": 0.0914139400, "display_precision": 0.01000000 }, "NZD": { "symbol": "NZD", "name": "New Zealand Dollar", "price": 0.5903546600, "display_precision": 0.00100000 }, "PHP": { "symbol": "PHP", "name": "Philippine Peso", "price": 0.0175658300, "display_precision": 0.01000000 }, "PKR": { "symbol": "PKR", "name": "Pakistani Rupee", "price": 0.0035969100, "display_precision": 0.10000000 }, "PLN": { "symbol": "PLN", "name": "Polish Zloty", "price": 0.2468242900, "display_precision": 0.00100000 }, "RUB": { "symbol": "RUB", "name": "Russian Ruble", "price": 0.0107071300, "display_precision": 0.01000000 }, "SEK": { "symbol": "SEK", "name": "Swedish Krona", "price": 0.0919065000, "display_precision": 0.01000000 }, "SGD": { "symbol": "SGD", "name": "Singapore Dollar", "price": 0.7338081500, "display_precision": 0.00100000 }, "THB": { "symbol": "THB", "name": "Thai Baht", "price": 0.0272183500, "display_precision": 0.01000000 }, "TMT": { "symbol": "TMT", "name": "Turkmenistani Manat", "price": 0.2857142800, "display_precision": 0.00100000 }, "TRY": { "symbol": "TRY", "name": "Turkish Lira", "price": 0.0308383100, "display_precision": 0.01000000 }, "UAH": { "symbol": "UAH", "name": "Ukrainian Hryvnia", "price": 0.0252792700, "display_precision": 0.01000000 }, "UZS": { "symbol": "UZS", "name": "Uzbekistan Som", "price": 0.0000789200, "display_precision": 0.10000000 }, "VND": { "symbol": "VND", "name": "Vietnamese Dong", "price": 0.0000397200, "display_precision": 1.00000000 }, "ZAR": { "symbol": "ZAR", "name": "South African Rand", "price": 0.0525925600, "display_precision": 0.01000000 } }, "message": "Operation completed successfully!", "error": {}, "status": 200, "version": "1.0.0" } The response example above is provided to help you understand the format and structure of the response. If you have any further questions or need assistance, please feel free to contact to your account manager. Last updated 10 months ago --- # Supported Networks2 | OxaPay Docs This endpoint allows you to retrieve a list of blockchain networks supported by OxaPay for cryptocurrency transactions. `GET` `https://api.oxapay.com/v1/common/networks` 200: OK Copy { "data": { "list": string[] // Array of networks name }, "message": string, // A message containing additional information about the result of the request. "error": { "type": string, "key": string, "message": string } || {}, // An object that provides details about any errors that occurred. "status": integer, // The status of the request response. Typically provided as a numeric code (e.g., 200 for success or other codes for errors). "version": string // The version of the API being used. } Please note that a successful request will return status 200. In case of any issues or validation problems, refer to the corresponding [error](https://docs.oxapay.com/api-reference/error) for further details. ### [](https://docs.oxapay.com/api-reference/common/supported-networks2#api-request-sample-codes) API Request Sample Codes cURL PHP Node.js Python Copy curl -X GET https://api.oxapay.com/v1/common/networks Copy array( 'method' => 'GET' ), ); $context = stream_context_create($options); $response = file_get_contents($url, false, $context); if ($response === FALSE) { die('Error occurred'); } $result = json_decode($response, true); var_dump($result); ?> Copy const axios = require('axios'); const url = 'https://api.oxapay.com/v1/common/networks'; axios.get(url) .then((response) => { console.log(response.data); }) .catch((error) => { console.error(error); }); Copy import requests url = 'https://api.oxapay.com/v1/common/networks' response = requests.get(url) result = response.json() print(result) These example code snippets demonstrate how to request the "Supported Networks" endpoint using different programming languages. You can customize the data parameters according to your specific requirements. ### [](https://docs.oxapay.com/api-reference/common/supported-networks2#api-response-example) API Response Example Copy { "data": { "list": [\ "Bitcoin Network",\ "Ethereum Network",\ "Tron Network",\ "Binance Smart Chain",\ "Dogecoin Network",\ "Solana Network",\ "Polygon Network",\ "Litecoin Network",\ "DigiByte Network",\ "Monero Network",\ "TON Network",\ "Bitcoin Cash Network",\ "Base"\ ] }, "message": "Operation completed successfully!", "error": {}, "status": 200, "version": "1.0.0" } The response example above is provided to help you understand the format and structure of the response. If you have any further questions or need assistance, please feel free to contact to your account manager. Last updated 10 months ago ---