Getting Started with Bitnbox

API Payment Flow

1. Purchase Initiation

   A user visits the merchant’s site to purchase a product or top up their account balance.

2. Payment Method Selection The user selects cryptocurrency as their preferred payment method.

3. Payment Creation The merchant calls the Create a Payment endpoint using the Bitnbox API to initiate the payment process.

4. Parameter Validation Bitnbox verifies the parameters provided in the API request:

   1. If the parameters are invalid or incomplete, an error response is returned to the merchant.

   2. If validation is successful, the process proceeds to the next step.

5. Payment Link Generation Once validated, Bitnbox generates a payment link and/or wallet address and returns them to the merchant.

6. Payment Initiation The user transfers the required amount of cryptocurrency to the specified wallet address.

7. Payment Monitoring Bitnbox monitors the blockchain for the transaction to confirm receipt of funds.

8. Transaction Confirmation Callback Upon successful confirmation and KYT verification, Bitnbox sends a callback to the merchant, notifying them of the completed transaction.

9. Service Fulfillment The merchant fulfills the user’s request by:

   1. Delivering the purchased goods, or

   2. Crediting the user’s account balance as specified.

Welcome to Merchant Dashboard

Merchant Dashboard is a web app where you do the following:

• See your current balance

• See transaction history

• Make single payouts

• Enable test mode

• Access Account and API settings

Account setup

To start using the platform, you need to enable 2FA and generate the API Key

1. 2FA: Settings → User → Security → Google Authenticator

2. API Key: Settings → Merchant → API Settings → API Key

Learn more about API Key and Webhooks Set Up here.

Make your first API request

You can make your first transaction using Binance Pay (requires a funded Binance account) or by making an on-chain transaction on a test blockchain network. Test networks function like main networks (e.g., Ethereum, Tron), but you can obtain free USDT and native tokens (for network fees) via the links below.

You can find a detailed guide on payment and payout creation here.

About Payments Processing

Specifics of onchain payments

• The wallet address for payments is reserved for a limited time, typically 3 hours by default (customizable). The sender must complete the transaction within this time frame for it to be processed.

• Each onchain transaction has two key details: currency and network. For example, USDT (currency) on Ethereum (network). Invoices are created with a specific currency and network, so the sender must use the correct combination for successful processing.

  Learn what to do if the wrong currency or network is used here.

Understand compliance requirements

• KYC: We require all merchants to complete the KYC process for all applicable customers.

• KYT (know-your-transaction) and AML (anti-money laundering) services are provided by Crystal Intelligence. The scan for sanctioned wallets is provided by Chainanlysis.

  We evaluate the risk of (1) every incoming transaction for payments and the risk of (2) the recipient's wallet address before processing a payout. Each wallet is checked for sanctioned or stolen funds to make sure it is safe to process the payment. If the wallet address is marked as risky, the payment is blocked. After that, each case is reviewed on an individual basis.

List of Prohibited Jurisdictions

1. United States of America

2. Canada

3. European Economic Area

4. United Kingdom of Great Britain and Northern Ireland Islamic

5. Republic of Afghanistan

6. Islamic Republic of Iran

7. Republic of Iraq

8. Syrian Arab Republic

9. Republic of the Sudan

10. Republic of Yemen

11. Democratic People's Republic of Korea