Merchant API
Last updated
Last updated
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.
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):
On the Merchants page (you can find it in your OxaPay panel menu), you can view the details of your Merchants keys.
1- Enter a desired name for your Merchant, which should be between 3 to 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 to 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.
In this section, you can see the total value of the merchant’s transactions for today, this week, this month, and overall.
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.
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”.
After obtaining the merchant key, you can After acquiring the merchant key, you can create an invoice, static address, and white-label Payment with the guidance provided in the API references.
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.
You can create your invoice link with the guidance provided in the Creating an Invoice in the API references.
A static address is an address that remains valid indefinitely and has no restrictions on the amount or time of use.
You can create your static address with the guidance provided in the Creating Static Wallet in the API references.
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.
You can create your own white-label with the guidance provided in the Creating White-Label Payment in the API references.
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.
