This documentation is for merchants who want to integrate Bitinvestor Checkout into their website. Bitinvestor Checkout is a widget that allows your customers to deposit cryptocurrency on your website, paid for by the customer in fiat. The widget is embedded in an iFrame and is fully customizable. The widget is designed to be simple to use and easy to integrate into your website.
- Bitinvestor Merchant Checkout Documentation
apiKey: Your publishable API key for customer and transaction assignment. Also known as the public key.currencyCode: The cryptocurrency code (e.g., BTC, ETH, BCH) for purchase. See Supported Cryptocurrencies for more options. If multiple walletAddress are set, this will be the default cryptocurrency.walletAddress: The destination cryptocurrency wallet address for purchased funds. For instance, if you want to accept Bitcoin, Litecoin, and Dogecoin, format the walletAddress parameter as follows:walletAddress=BTC:yourBitcoinAddress,LTC:yourLitecoinAddress,DOGE:yourDogecoinAddress. Note that the code is case sensitive so ensure the code you use for your default cryptocurrency matches what you used incurrencyCodefield.
language: Specify the widget's language using an ISO 639 Set 1 code. The language will default to EN (English) if the parsed language is not supported. Currently supported languages: EN, DA, TR, ES, PT-BRbaseCurrencyCode: The fiat currency code for transactions (e.g., USD, EUR, GBP). See Supported Fiat currencies for more options.lockBaseCurrency: (True/False) Locks the currency selection to the specifiedbaseCurrencyCodebaseCurrencyAmount: The fiat currency amount to be spent, in integer form. 2 decimals max. Cannot be zero if set.quoteCurrencyAmount: The cryptocurrency amount to be purchased, in integer form. 3 decimals max.email: The email address of the customer.externalTransactionId: Your unique identifier for the transaction.externalCustomerId: Your unique identifier for the customer.redirectUrl: The URL for redirection after purchase completion. Must be URLencoded, e.g. https%3A%2F%2Fwww.myurl.com.responseUrl: The URL for receiving order notifications. See more under the section Order Notifications. Must be URLencoded, e.g. https%3A%2F%2Fwww.myurl.com.customerKYC: The level of Know Your Customer (KYC) verification. customerKYC = 0 means the customer has not completed KYC. customerKYC = 1 means the customer has completed Proof of ID + Liveness Check. customerKYC = 2 means the customer has completed Proof of ID + Liveness Check + Proof of Address.style: The styling ID provided by Bitinvestor for customization.destinationTag: Adds a destination tag to the transaction. Only supported for XRP and TON.coverFees: (True/False) Sets processing and handling fees to zero for the customer. Fees will be included through the spread.minAmount: Sets the minimum order amount in EUR.lockAmount: (True/False) Locks the fiat and crypto fields for the user.
- Compute an HMAC with SHA-256 using your secret API key and the original query string.
import crypto from 'crypto';
const publicKey = 'your_public_key';
const secretKey = 'your_secret_key';
const currencyCode = 'currency_code';
const walletAddress = 'your_wallet_address';
const originalUrl = `https://checkout.bitinvestor.net?apiKey=${publicKey}¤cyCode=${currencyCode}&walletAddress=${walletAddress}`;
const signature = crypto.createHmac('sha256', secretKey).update(new URL(originalUrl).search).digest('base64');
const urlWithSignature = `${originalUrl}&signature=${encodeURIComponent(signature)}`;
console.log(urlWithSignature);The iFrame has been optimized for height: 585px; width: 445px;.
https://checkout.bitinvestor.net?apiKey={pk_live_key}¤cyCode=btc&signature=loremipsum
<iframe allow="accelerometer; autoplay; camera; encrypted-media; gyroscope; payment; clipboard-read; clipboard-write" src="https://checkout.bitinvestor.net?apiKey={pk_live_key}¤cyCode=btc&signature=lorem" title="Buy crypto with Bitinvestor" style="height: 585px; width: 445px; border-radius:
0.75rem; margin: auto;"></iframe>To receive order notifications you must provide a responseUrl. You will receive the notification on the provided url. In the header of the HTTP request, there’s a signature to make sure the data comes from Bitinvestor. Order notifications are sent to the responseUrl you specify. These notifications inform you of the status of each order. Below are the types of notifications you can receive.
Indicates that the transaction has been created but the customer hasn't completed payment.
{
"order_status": "payment_pending",
"external_transaction_id": "1234567",
"external_customer_id": "1234567",
"order_crypto": "LTC",
"order_amount_usd": "25",
"order_amount_usd_plus_fees": "25.5",
"order_amount_eur": "21",
"order_amount_eur_plus_fees": "22.5",
"order_id": "9fcc45a5-4def-4953-9bd8-9ff75d9aaa9c"
}Indicates that the order is cancelled for any reason, such as payment failure, or user cancellation.
{
"order_status": "order_cancelled",
"external_transaction_id": "1234567",
"external_customer_id": "1234567",
"order_id": "9fcc45a5-4def-4953-9bd8-9ff75d9aaa9c"
}Indicates that the order has been processed, and the cryptocurrency purchase was successful.
{
"order_id": "9fcc45a5-4def-4953-9bd8-9ff75d9aaa9c",
"order_crypto_amount": 0.347764,
"order_crypto": "LTC",
"order_status": "order_completed",
"order_crypto_address": "ltc1qlec2yfpkdvn4lr0vpf27qggrxtu34zeu5l6g2u",
"external_transaction_id": "1234567",
"external_customer_id": "1234567",
"order_amount_usd": "25",
"order_amount_usd_plus_fees": "25.5",
"order_amount_eur": "21",
"order_amount_eur_plus_fees": "22.5",
"network": "litecoin"
}Indicates that the cryptocurrency transaction has been broadcasted to the blockchain.
{
"order_id": "9fcc45a5-4def-4953-9bd8-9ff75d9aaa9c",
"order_crypto_amount": 0.347764,
"order_crypto": "LTC",
"order_status": "order_broadcasted",
"transaction_id": "ea458dda0ff8583199bdd4d9b9a69a2813694764a633fd40b27de22a868cebec"
"order_crypto_address": "ltc1qlec2yfpkdvn4lr0vpf27qggrxtu34zeu5l6g2u",
"external_transaction_id": "1234567",
"external_customer_id": "1234567",
"order_amount_usd": "25",
"order_amount_usd_plus_fees": "25.5",
"order_amount_eur": "21",
"order_amount_eur_plus_fees": "22.5",
"network": "litecoin"
}order_id: The order id on Bitinvestor.order_crypto_amount: The exact cryptocurrency amount you will receive.order_crypto: The cryptocurrency you receive.order_status: The current status of the order.order_crypto_address: The cryptocurrency address where you receive the cryptocurrency.external_transaction_id: Your transaction id (If provided in the URL).external_customer_id: Your customer's id (If provided in the URL).order_amount_usd: Theorder_crypto_amountconverted to USD (Mid-market rates without spread). This does not include the platform fee.order_amount_usd_plus_fees: Theorder_amount_usdplus the platform fee.network: The network used to send transaction via.
Compute an HMAC with a SHA-256 hash function. Use your secret API key as the key and use the request body as the message. Compare this to the signature sent in the request header.
import crypto from 'crypto';
const serverKey = 'sk_test_key'; // Replace with your server key
const requestBody = '{ "order_id": "9fcc45a5-4def-4953-9bd8-9ff75d9aaa9c"}'
const signature =
crypto
.createHmac('sha256', serverKey)
.update(requestBody)
.digest('base64'); The following are all currencies supported for iFrame initalization.
| Currency | ||||
|---|---|---|---|---|
| BTC | LTC | ETH | XRP | USDC_ETHEREUM |
| DAI_ETHEREUM | LINK_ETHEREUM | BCH | DOGE | USDT_ETHEREUM |
| USDT_TRON | USDT_SOLANA | TRX | SOL | TON |
| Currency | ||||
|---|---|---|---|---|
| EUR | USD | PLN | SEK | SGD |
| KZT | RON | ZAR | UAH | TWD |
| MXN | IDR | JPY | AUD | HKD |
| NZD | THB | CZK | TRY | DKK |
| CHF | CAD | INR | BGN | ILS |
| BRL | HUF | GBP |
It's currently only possible to make test orders with Visa/MasterCard as the payment method and EUR + USD as the payment currency.
Card number:
4242 4242 4242 4242
Expiration date:
10/31
CVC/CVV:
123
All payment methods & their supported countries can be retrieved with a GET request.
URL: https://eosdj3ojuf31557.m.pipedream.net/
Response:
{
{
"id": 2,
"name": "PIX",
"fee": 2,
"slug": "pix",
"area": [
"BR"
],
"currency": [
"BRL"
],
"excluded": [
]
},
}id: The payment method id.name: The name of the payment method.fee: The fee in percentage.slug: The payment method slug.area: The areas where the payment method is available. These use ISO 639 Set 1 code.currency: The currencies the payment method supports.excluded: Countries not supported by this payment method.
Allows for retrieving the status of a payment.
URL: https://eocb95pk8c29bt6.m.pipedream.net
Request Data:
{
"order_id": "bitinvestor_order_id",
"api_key": "your_secret_key"
}Response:
{
"order_id": "bitinvestor_order_id",
"order_crypto": "LTC",
"external_transaction_id": "",
"external_customer_id": "123456",
"order_status": "order_broadcasted",
"transaction_id": "fada834ba9f1b398bacf6153e44e320dfe1821bffe03a68d29ca76cb3bbc60c5"
}order_id: The order id on Bitinvestor.order_crypto: The cryptocurrency you receive.external_transaction_id: Your transaction id (If provided in the URL).external_customer_id: Your customer's id (If provided in the URL).order_status: The current status of the order.transaction_id: The transaction id on the blockchain.