Integration Guide

When talking about cryptocurrencies as a payment method, we should remember that their payment workflow differs from classic payment methods like bank cards or e-wallets. As a result, when clients use this payment method in a web service or application, they should know some tips on making the payment process comfortable and simple.

First steps

All kinds of integrations are available: APIs, plugins, buttons, payment links, and any crypto-payment solution for your business.

Regardless of which type of integration you choose, you'll first need to follow the three most manageable steps:

Step 1

Sign up – Enter your email or phone number. Once you confirm it, you'll be logged into your account.

Step 2

Create a project (Merchant) – Click the Create Merchant button and enter a name for your project.

Step 3

Select the type of integration, or skip this step for now.

You have successfully created your new project! Now you have two wallets.

The personal wallet is your wallet, where you can simply store, convert, and transfer your cryptocurrency.

The business wallet is a wallet in which you can create new projects, make invoices for payment, install widgets, see statistics on payments, and use many other features.

Now, let's talk about types of integration.

Types of Integration

How do you know which type of integration is right for you?

Payment by link

This is the easiest way to start accepting cryptocurrency payments with Cryptomus.

The feature allows users to create an account without creating a site and connecting Cryptomus to it. You can just choose a cryptocurrency and click "Create Account." Anyone can do this from anywhere. There is no need to go through the integration process - just create your account and generate invoices right there.

This makes it easy to receive funds, especially if you're waiting for a money transfer or a paycheck or just need a link with a user-friendly payment interface. Generate an invoice, send the link via email, in a messenger, or just leave it somewhere and get paid! This method can also be used in regular stores and offline businesses.

Plugins

• WooCommerce: WooCommerce crypto gateway

• OpenCart: add payment gateway to Opencart

• PrestaShop: add PrestaShop payment gateway

• Shopify

• BillManager

• RootPanel

• XenForo

• PHPShop

• Tilda

And many others, all accessible on the Cryptomus Plugin Page.

API

Read our API documentation and perform the integration using your API key.

To release the API key to accept funds, go to your project ➜ Settings ➜ Enter your website address and a short description ➜ Done!

The API key for withdrawal is in the internal settings.

Please keep in mind that Cryptomus provides complete support to assist you with any problems you may encounter during the integration process. You can access our support team through the website or on Telegram using the username @cryptomussupport, or you can email us at [email protected].

Cryptomus now offers a personal agent option. After registering and connecting your Telegram account, an agent will act as your personal assistant and help you with any problem you will face.

Typical flow for the API

You create a payment with "Create invoice" and show "address" to the user. Users send money to "address". You can check the payment status with "Get payment status" or via IPN. Just specify "url_callback" in the "Create invoice" request to get IPN messages. We will send a POST request to this URL when finalizing the payment status. The IPN message is similar to the "Get payment status" message.

Here's when these status messages appear:

• Expired transaction

State flow: pending ➜ expired

• Completed transaction

State flow: pending ➜ paid ➜ completed

• Partially paid transaction

Status stream: pending ➜ pay ➜ partially_paid

After completing the payment, you can start using the service.

Static address

A static address is an individual solution that allows you to get a lot of deposit addresses for your clients when, for example, you have a private office on your site, and the user has his personal balance.

Let's look more specifically at the example of an online store:

1. Customers register and get permanent deposit addresses;

2. Buyers send funds to the Cryptomus deposit address. Using IPN, Cryptomus sends the amount and currency information to the online store;

3. We send funds to the balance of the online store within our system. Funds are held in the currency sent by the buyer;

4. The buyer or store then requests a payment from the balance;

5. We withdraw the funds and send them to the store or buyer's address.

6. No conversion for static addresses yet. This feature is in development.

How is a commission formed?

1. The buyer sends funds to the permanent deposit address and pays the transaction fee.

2. We send funds from the deposit address to the balance - the network commission is paid by Cryptomus.

3. We withdraw funds and send them to buyers or shop wallets - network commission is always paid by the shop in both cases.

Note: For payouts, the network commission is paid by the shop.

Any questions left?

We will be glad to help you and answer all your questions. Just ask a question on the website by emailing [email protected]or by Telegram using the username @cryptomussupport.