Create payment & make payout via API Reference

Payment and payout creation via the API Reference is the fastest way to test the Bitnbox platform. Here's a guide on how to do that.

You can find the currencies and network codes in the API Glossary.

Make free transactions on test networks — guide.

Payment

1. Create a payment

1. Go to the API Reference page

2. Click on “Test it”

3. Insert your API Key in the “x-api-key” field

4. Fill in the required invoice properties

   { // example
     "amount": 123, // min 5.00
     "customerId": "<string>", // payer IP
     "customerIp": "<string>",// payer IP
     "orderId": "<string>",// any input
     "platformFeeByUser": false, // who pays the processing fee
     "currency": "usdt", // we recommend using USDT for test payments
     "network": "sepolia" // we recommend using Sepolia or Amoy for test payments
     "webhookUrl": "", // URL for webhook
   }

5. Click on “Send”

6. Get the payment address

   { // example
     "amount": 123,
     "payAmount": 123,
     "currency": "usdt",
     "network": "sepolia",
     "payAddress": "0xaf38220a2f436bc6bd3b5a7cb67afc4dfb47f7ae",
     "payQrCodeUri": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAJQAAACUCAYAAAB1PADUAAAAAklEQVR4AewaftIAAAS7SURBVO3BQY4bSRAEwfAC//9lXx3zVECjk7MjIczwj1QtOaladFK16KRq0UnVopOqRSdVi06qFp1ULTqpWnRSteikatFJ1aKTqkUnVYtOqhZ98hKQn6RmAjKpuQHyhJobIDdqboBMaiYgP0nNGydVi06qFp1ULfpkmZpNQN4AcqNmAvKEmieAvKFmE5BNJ1WLTqoWnVQt+uTLgDyh5m8CZFJzo2YTkCfUfNNJ1aKTqkUnVYs++cupmYBsAjKpuQEyqbkBMqn5m51ULTqpWnRSteiTvxyQSc0EZFJzo2YTkBs1/5KTqkUnVYtOqhZ98mVqvknNBGRScwPkCTVvqJmATGqeUPObnFQtOqladFK16JNlQH4SkEnNBGRSc6NmAvKEmgnIJiC/2UnVopOqRSdVi/CP/MOAvKFmAnKj5gkgk5q/2UnVopOqRSdVi/CPvABkUnMD5P+kZgIyqZmA/J/U3ACZ1ExAnlDzxknVopOqRSdViz55Sc03qZmAvAFkUvOGmieAfBOQGzXfdFK16KRq0UnVok9eAjKpmYA8oWYCMqm5ATKpeQLIpGYC8oaaCcik5gbIpOY3OaladFK16KRq0ScvqZmATGpugNyouQFyA2RSMwGZ1NyouQEyqXkDyKRmAjKpuQFyo+aNk6pFJ1WLTqoWffISkCeATGomIDdqbtRsAvKEmhsgN0BugExqfpOTqkUnVYtOqhZ9skzNE0AmNTdAJjUTkEnNE0AmNROQJ4BMam6APAHkCTUTkE0nVYtOqhadVC365CU1E5An1ExAbtQ8AeRGzQ2QJ4DcAJnUPKHmCSA/6aRq0UnVopOqRZ/8MDUTkBs1E5An1ExAJiCTmknNJiATkBs1N0AmNf+nk6pFJ1WLTqoWffLLAZnUTEAmNROQSc0EZAIyqZmA3Ki5UTMBeUPNBGRSMwH5ppOqRSdVi06qFn3yEpAbNW+ouVHzhppNQL4JyI2aCciNmk0nVYtOqhadVC365JdRMwGZ1NwAmdRMQDapuQHyhJoJyKRmAjIBuVEzAZnUvHFSteikatFJ1aJPvgzIpGZSMwGZ1ExAbtRMQCY1N0AmNROQN9T8Jmo2nVQtOqladFK1CP/IC0Bu1ExANqmZgNyoeQLI30TNBOQJNW+cVC06qVp0UrXok5fUPKFmE5AngNyoeULNE0Bu1DwB5A01m06qFp1ULTqpWvTJS0B+kpobNTdAJjU3aiYgPwnIpOYJNROQbzqpWnRSteikatEny9RsAvIEkE1AngByo2YCcqNmk5pvOqladFK16KRq0SdfBuQJNZvU3AB5A8ikZgIyAbkB8k1AJjWbTqoWnVQtOqla9Mk/DsiNmgnIJjVPAJnUPAHkRs0EZFLzxknVopOqRSdViz75y6mZgExqboDcqJmATGomIJOaCcik5gkgbwD5ppOqRSdVi06qFn3yZWp+kpobIJOaJ9RMQCY1N2pu1ExAJjUTkEnNBGRSMwHZdFK16KRq0UnVIvwjLwD5SWomIJOaCcikZgIyqbkBMql5AshPUvOTTqoWnVQtOqlahH+kaslJ1aKTqkUnVYtOqhadVC06qVp0UrXopGrRSdWik6pFJ1WLTqoWnVQtOqladFK16D/VQB1MuGoyqAAAAABJRU5ErkJggg==",
     "platformFeeByUser": false,
     "fee": 0.5,
     "id": 8,
     "status": "waiting",
     "additionalData": "test",
     "createdAt": "2024-02-20T14:27:15.729Z"
   }

After this, you can send the crypto to the payment address.

2. Get payment status

1. Go to the API Reference page

2. Scroll down to the “Get payment status by ID” section

3. Click on the “Test it” button

4. Insert your API Key in the “x-api-key” field

5. Type the payment ID

6. Click on “Send”

7. Get the payment status

Also, you can see the payment status on the Transaction History page in the web app.

Payout

1.1. Create a payout via API

1. Go to the API Reference page

2. Click on “Test it”

3. Insert your API Key in the “x-api-key” field

4. Fill in the required payout properties

   {
     "method": "direct"
     "walletAddress" or "binanceId"
     "amount": 50
     "currency": "usdt", // any available currency
     "customerId": "<string>"
     "customerIp": "<string>"
     "feeByUser": false
     "network": "sepolia"
     "walletAddress": "<string>" // recipient's wallet address
   }

5. Click on “Send”

6. You will also see the payout status in the app

1.2. Create a payout via the App

1. Go to the payout page - New Payout

2. Fill out the required properties

3. Click on "Transfer"

2. Get payout status

1. Go to the API Reference page

2. Scroll down

3. Click on the “Test it” button

4. Insert your API Key in the “x-api-key” field

5. Type the payout ID

6. Click on “Send”

7. Get the payout status

Also, you can see the payout status on the Transaction History page in the web app.