Our products:
Our products:
CoinPayments offers different integration options to suit various business needs, whether you’re processing crypto payments for products, services, or other use cases. With these flexible solutions, you can choose from:
In this guide, we’ll explore these use cases in detail, including:
By the end of this guide, you’ll have a clear understanding of the capabilities of each integration type and how to apply them effectively to your business operations.
The Integrated Checkout Flow is a pre-built solution offered by CoinPayments, providing a seamless and efficient payment process for businesses. This flow requires minimal setup and is available across a variety of integration types.
Supported Integration Types:
Note: Transactions generated via the CoinPayments Invoicing Tool or Plugins are categorized as “Invoice”, while those generated using Payment Buttons are categorized as “Payment” in your transaction history.
The CoinPayments API offers powerful tools for businesses to automate payment processing. Using API-generated invoices and payment buttons, you can integrate seamless checkout flows tailored to specific use cases, such as subscription models or online purchases.
Use Case: Subscription Payments with API-Generated Invoices
Let us consider a subscription use case, where you have a platform that provides services with a subscription payment model. Every month you need to send out invoices to your users with the reminder to pay for the subscription and ability to collect this payment in crypto.
CoinPayments API can automate the invoicing process. Here’s how it works:
"payment": {
"paymentCurrency": "4:0xdac17f958d2ee523a2206206994597c13d831ec7"
"refundEmail": "jane_doe@hotmail.com"
} 
Let us consider another case. Imagine you run an online shop and want to accept crypto payments for your goods or services. To make the process quick and seamless for your clients, you can add a Buy-Now button next to each item. Using the CoinPayments API, you can enable your clients to complete their purchases with just a few clicks. Here’s how the process works:
{
...
"Payment": {
"RefundEmail": "jane_doe@hotmail.com"
}
} 
The Whitelabeled Checkout Flow allows you to fully customize the payment process using the CoinPayments API, enabling you to offer a branded experience on your platform. This method is ideal for businesses that want to keep the checkout process entirely within their own ecosystem.
For an online shop accepting cryptocurrency payments, the White-labeled Checkout Flow ensures that your customers can browse, shop, and pay without leaving your branded environment. Here’s how it works:
{
...
"Payment": {
"RefundEmail": "jane_doe@hotmail.com"
}
} {
...
"Payment": {
"RefundEmail": "jane_doe@hotmail.com",
"PaymentCurrency": "4:0xdac17f958d2ee523a2206206994597c13d831ec7"
}
} "invoices": [
{
...
"checkoutLink": "https://checkout.coinpayments.com/checkout/?invoice-id=56284ebf-8daf-4eed-a3a4-00a3ba255788",
...
}
]
} 
Commercial deposits allow merchants to receive funds for services such as subscription payments or gambling accounts. With CoinPayments API, merchants can manage and sweep these deposits using various types of addresses tailored to their specific needs.
CoinPayments provides flexibility in managing commercial funds through three types of addresses: UTXO Addresses, Temporary Account-Based Addresses, and Permanent Account-Based Addresses. Each address type caters to different business needs, offering options for fund management, fee optimization, and customer-specific deposits.
UTXO (Unspent Transaction Output) addresses are designed for accumulating funds and minimizing network fees by allowing bulk withdrawals. They are particularly beneficial for merchants who process large volumes of transactions or manage multiple customer accounts.
A temporary address is an address that is not specifically assigned to any user of the CoinPayments platform. Such address exists in CoinPayments pool of addresses and is temporarily used for a particular commercial deposit.
The merchant can decide to use permanent account-based addresses if it is important to manage funds/balances deposited by their customers individually.
The tradeoff of the permanent address vs. temporary address design is fees. To be able to use the funds from permanent addresses, merchant must consolidate addresses balances at some wallet balance of the currency. For this each new commercial address created within the API wallet must be activated.
A common case for merchants is to use wallets and addresses created via API for receiving payments from customers, e.g. top-up a subscription or casino account. You can simplify the deposit process for the customer by incorporating transaction details such as deposit amount, currency, and address into a QR code. This will decrease the possibility of an error when sending funds.
Below is an example script you can use to generate a QR code for deposits:
```javascript
<div id="canvas"></div>
<script type="text/javascript" src="https://unpkg.com/qr-code-styling@1.5.0/lib/qr-code-styling.js"></script>
<script type="text/javascript">
const generateQRData = (currency, address, tag, amount) => {
switch (currency.name) {
case 'Bitcurrency SV':
return `bitcurrency:${address}?sv&amount=${amount}`;
case 'Tether USD (Omni)':
return `bitcurrency:${address}?amount=${amount}&req-asset=${currency.id}`;
case 'BinanceCoin':
return `bnb:${address}?sv&amount=${amount}&req-asset=${currency.id}`;
case 'Tether USD (ERC20)':
return `ethereum:${address}?value=${amount}&req-asset=${currency.id.slice(currency.id.indexOf(':') + 1)}`;
case 'Tether USD (TRC20)':
return `tron:${address}?value=${amount}&req-asset=${currency.id.slice(currency.id.indexOf(':') + 1)}`;
default:
return `${currency?.name?.toLowerCase().replace(/ /g, '')}:${address}?amount=${amount}${tag ? `&tag=${tag}` : ''}`;
}
};
const color = "#2A5ED5";
const corner = "#000000";
const margin = 5;
const qrCode = new QRCodeStyling({
width: 200,
height: 200,
dotsOptions: {
color: color,
type: "square"
},
backgroundOptions: {
color: "transparent",
gradient: null
},
cornersSquareOptions: {
type: "square",
color: corner
},
cornersDotOptions: {
type: "square",
color: corner
},
imageOptions: {
crossOrigin: "anonymous",
imageSize: 0.5,
margin: margin
}
});
qrCode.append(document.querySelector('#canvas'));
qrCode.update({
data: generateQRData(currency, address, tag, amount)
});
</script>
``` UTXO (Unspent Transaction Output) addresses are highly efficient for managing commercial deposits due to their ability to accumulate funds and minimize network fees. Below is the process for setting up and using UTXO addresses for commercial deposits.
Note: You can choose to convert funds during the withdrawal process if required.
Receive Commercial Deposits and Sweep Funds from Temporary Addresses
The flow for receiving deposits to the temporary account-based addresses and withdrawing funds from account-based wallets is the same as for UTXO addresses. Although, there are a few things to note:
Permanent account-based addresses offer merchants the ability to manage individual customer balances with a higher level of control. These addresses are assigned to specific customers indefinitely, making them suitable for businesses that need to track deposits and balances for each customer separately.
Below is the process to Use Permanent Account-Based Addresses
usePermanentAddresses attribute to true to enable the use of permanent addresses. Once you are ready to sweep funds from the permanent addresses, you first need to consolidate the funds from the addresses at the wallet of the same currency that does not own permanent addresses (either Primary (UI) Balance of the currency or any other API wallet of the same currency within your account that has usePermanentAddresses attribute set to false).
You have two options to consolidate addresses:
a. Use the createWalletConsolidation API endpoint to consolidate funds from the addresses that belong to one API wallet into a wallet balance. You can consolidate funds to the balance of the wallet where the addresses belong or to any other wallet of the same currency within your account:
walletIdStr path parameter indicate the API wallet which addresses you want to consolidatetoWalletIdStr path parameter indicate the API wallet where funds from the addresses should be consolidated. If not provided, funds will be consolidated to the Primary Balance of the currency.addressIds query parameters indicate the addresses corresponding to walletIdStr that should be consolidated
NOTE: Before actually executing the consolidation you have an opportunity to make a preview of the expected consolidation results by using getWalletConsolidation API endpoint. The result will provide you the breakdown of all fees associated with the consolidation of all the addresses within the wallet and the final amount to be consolidated on the wallet balance. You can use this endpoint to decide which addresses to consolidate to make the sweep most cost-effective.
b. Use the createWalletsConsolidation API endpoint to consolidate funds from the addresses that belong to different API wallets of the same currency into a single wallet balance. You can consolidate funds to the balance of any wallet of the same currency within your account:
toWalletIdStr path parameter indicate the API wallet where funds from the addresses should be consolidated. If not provided, funds will be consolidated to the Primary Balance of the currency.walletId and addresses request body attributes indicate wallets and their addresses that should be consolidatedNOTE: Before actually executing the consolidation you have an opportunity to make a preview of the expected consolidation results by using createWalletsConsolidationPreview API endpoint. The preview result will provide you the breakdown of all fees associated with the consolidation and the final amount to be consolidated on the wallet balance. You can use this endpoint to check whether the consolidation outcome is what you actually expect and if any adjustments to the list of addresses to be consolidated is necessary to make the sweep most cost-effective.
toCurrency request body attribute of the spend request.toCurrency must be the same as the currency of the walletIdStr path parameter.CoinPayments separates funds between the Primary balance and API balances to enhance flexibility and security. This separation allows businesses to efficiently manage funds for different purposes while maintaining strict control over access.
This approach provides several key benefits:
In this tutorial you will learn how to top up your API balance via Dashboard UI.
Transferring Funds to API Wallets with Permanent Addresses
For API wallets using permanent addresses, funds must be deposited directly into an address within the wallet rather than into the wallet balance itself:
That’s it — congratulations on successfully integrating CoinPayments into your business!
If you need any assistance, our customer support team is always here to help.
