Download OpenAPI specification:Download
Documentation for BlockBee:
Before you start using our API, you will need an API key.
To obtain one, register at BlockBee's Dashboard.
Build a custom payment experience using these endpoints for receiving payments, which simplify the process of generating unique payment addresses for each transaction and allow you to track and manage payments more efficiently.
How to automatically confirm the payment:
To confirm a payment you can use our callbacks. These callbacks are dispatched by our API to your platform when a user sends a payment to the address generated by our system.
Your platform should be able to handle these callbacks, which are requests made to the URL provided in the callback
parameter.
Each callback is sent with an additional header, x-ca-signature
.
This is a base64-encoded 1024-bit RSA-SHA256 signature of the callback.
The specific data signed depends on the type of callback you're receiving.
For callbacks sent via GET, the entire request URL to your system (including all GET parameters) is signed.
If the callback is sent via POST, then the entire body of the request is signed.
The Public Key
for verification can be retrieved from this this endpoint.
Check our knowledge base to learn how to verify the callback with code samples.
BlockBee API will stop sending callbacks under one of these two circumstances:
*ok*
message or an HTTP 200
status code, indicating that the callback has been successfully received and processed.Callbacks are sent everytime funds are received in a generated address. If you're having issues receiving our callbacks it might be due to these factors:
callback
parameter is not reachable online.Note: We advise whitelisting our server IPs in order to avoid issues with the callbacks: 145.239.119.223
and 135.125.112.47
This method is used to generate a new address to give your clients, where they can send payments.
Please keep in mind that before making any transaction, you should check the minimum transfer limit for the specific cryptocurrency or token you want to use. If you transfer an amount that's less than the minimum limit set by BlockBee, your transaction will be rejected.
To save time and energy, it's recommended to check the pre-existing libraries for the features or functions you need before delving into the documentation.
Notice: The length of this request should not exceed 8192
characters.
ticker required | string The ticker parameter in this API request refers to the unique identifier of the cryptocurrency to which you are making the request.
It is included in the URL of the request and helps to specify the exact cryptocurrency that you want to retrieve data for. The ticker is typically a short code that uniquely identifies the cryptocurrency, or the token and it's network/blockchain.
For example, Notes:
Example: btc |
apikey required | string |
callback required | string The URL where the callbacks will be sent to. Must be a valid URL. Notes:
Example: callback=https://example.com?user_id=1124 |
address | string By default, addresses are set in BlockBee's Dashboard, and to be able to set them in this parameter you need to enable the option "Address Override" when creating the API Key. If you wish to use the addresses set in the Dashboard, you can ignore this parameter and leave it empty. The If you're using multiple addresses, you will need to format them like this: Addresses must be valid for the Notes:
Example: address=bc1qhfn0lw2kdu6umgf08x54y0ha7wclsj3g5sp6t3 |
pending | integer Default: 0 Set to pending=1 to enable. If enabled you will be notified of pending transactions (transactions that were sent by the customer, but yet to be confirmed by the blockchain).
Notes:
Example: pending=1 |
confirmations | integer Default: 1 Example: confirmations=3 |
post | |
json | |
priority | string Default: "default" Allows you to set the priority with which funds should be forwarded to the provided address . It reflects the amount of fees paid to the blockchain network and can affect the speed of transaction confirmation.
Notes:
Example: priority=fast |
multi_token | integer Default: 0 Allows customers to pay with any token supported by BlockBee API, even if the token is different from what the user initially specified. However, you should ensure that your Wallet supports the tokens you expect customers to pay with and that your system can handle price conversions. For example, if a customer wishes to receive 1000 USDT (or equivalent) and a client sends 1000 TRX, the system should be able to handle that scenario. Notes:
Example: multi_token=1 |
convert | integer Default: 0 If enabled, returns the converted value converted to FIAT in the callback, with the parameters value_coin_convert
and value_forwared_coin_convert .
Notes:
Example: convert=1 |
Address was created.
Error creating address.
{- "address_in": "14PqCsA7KMgseZMPwg6mJy754MtQkrgszu",
- "address_out": "1H6ZZpRmMnrw8ytepV3BYwMjYYnEkWDqVP (single address)\n\n{1H6ZZpRmMnrw8ytepV3BYwMjYYnEkWDqVP: 0.70, 1PE5U4temq1rFzseHHGE2L8smwHCyRbkx3: 0.30} (multiple addresses)\n",
- "priority": "default",
- "status": "success"
}
ticker required | string The ticker parameter in this API request refers to the unique identifier of the cryptocurrency to which you are making the request.
It is included in the URL of the request and helps to specify the exact cryptocurrency that you want to retrieve data for. The ticker is typically a short code that uniquely identifies the cryptocurrency, or the token and it's network/blockchain.
For example, Notes:
Example: btc |
List of payments sent to this callback.
address_in | string Generated address for the callback URL provided. |
address_out | string Your address(es), where the payment will be forwarded to, should be the same address(es) you provided. Notes:
|
callback_url | string The callback URL you provided. |
status | string Status of the request. Should be `success` if the request didn't fail. |
notify_pending | boolean Shows if you enabled the pending callback when creating the address. |
notify_confirmations | integer Number of confirmations required before sending the confirmed callback. |
priority | string The confirmation priority you requested. |
Array of objects (log_items) List of payments made to this address, together with the logs of the callbacks to your system. |
Your request couldn't be processed, please try again later.
No request or no payment callbacks found.
{- "address_in": "14PqCsA7KMgseZMPwg6mJy754MtQkrgszu",
- "address_out": "1H6ZZpRmMnrw8ytepV3BYwMjYYnEkWDqVP",
- "status": "success",
- "notify_pending": true,
- "notify_confirmations": 1,
- "priority": "default",
- "callbacks": [
- {
- "txid_in": "33f11611f863d7475eb10daada2f225f0877561cf58cdfff175e99635dfd9120",
- "txid_out": "5ea53d5e728bfdb56b54c0b945990b69ae1e66cec56ab24679c9a622c4695276",
- "value_coin": 0.1,
- "value_forwarded_coin": 0.1,
- "confirmations": 13,
- "last_update": "15/02/2018 21:23:42",
- "result": "done",
- "fee_percent": 1,
- "fee_coin": 0.02,
- "logs": [
- {
- "responses": "*ok*",
- "response_status": "200",
- "next_try": "14/10/2022 12:47:18",
- "pending": "0",
- "confirmed": 1
}
]
}
]
}
Callback issued when a client's transaction is pending confirmation.
Notes:
post
parameter is set to 1
, when creating a new address.POST
if post=1
parameter set, else sent via GET
.uuid | string This is an unique identifier to each payment your clients have made, so you can easily track any duplicate callbacks sent, in the case our system doesn't mark the callback as successful. Example: uuid=dbfcb40e-5a6b-4305-9fa2-b0fbda6e3ff2 |
address_in | string Address generated by BlockBee, where your customer sent the payment. Example: address_in=3PFoGK63cVVUWnd2vu7W1kM83NXUfvzMqM |
address_out | string Address(es) where BlockBee forwarded the payment. Example: address_out=1H6ZZpRmMnrw8ytepV3BYwMjYYnEkWDqVP (single address)<br/>
{1H6ZZpRmMnrw8ytepV3BYwMjYYnEkWDqVP: 0.70, 1PE5U4temq1rFzseHHGE2L8smwHCyRbkx3: 0.30} (multiple addresses)
|
txid_in | string Transaction hash of your customer's payment. Example: txid_in=a2174ffd39289100709f2a07b129cdbba69df2e22e5be1830221dab1fd4e332c |
confirmations | integer Number of confirmations of the current transaction. Example: confirmations=1 |
value_coin | number This is the payment amount sent by your customer before any fees are deducted. Notes:
Example: value_coin=0.05 |
value_coin_convert | string Converted value to various FIAT currencies of the value_coin .
Notes:
Example: value_coin_convert={"USD": "3.20", "EUR": "3.05", "GBP": "2.62", "CAD": "4.16", "JPY": "431.90", "AED": "11.77", "DKK": "22.67", "BRL": "16.52", "CNY": "21.43", "HKD": "25.16", "INR": "249.97", "MXN": "64.95", "UGX": "11975.46", "PLN": "14.25", "PHP": "173.14", "CZK": "75.37", "HUF": "1220.10", "BGN": "5.94", "RON": "15.02", "LKR": "1153.30", "TRY": "55.54", "ZAR": "51.36", "RUB": "181.24"} |
coin | string Ticker of the coin used for the payment: ['btc', 'bch', 'ltc'', 'eth', 'trx'] For ERC-20 (ETH) Tokens, this parameter will be For TRC-20 (Tron) Tokens, this parameter will be For BEP-20 (BSC) Tokens, this parameter will be For Polygon Tokens, this parameter will be Example: coin=btc |
price | number Coin price in USD at the time of the callback. Example: price=55.59 |
pending | integer Being the pending callback, this value should be 1 .
Example: pending=1 |
Expected response from your server.
*ok*
Callback issued when a client's transaction has been confirmed by the network.
uuid | string This is an unique identifier to each payment your clients have made, so you can easily track any duplicate callbacks sent, in the case our system doesn't mark the callback as successful. Example: uuid=dbfcb40e-5a6b-4305-9fa2-b0fbda6e3ff2 |
address_in | string Address generated by BlockBee, where your customer sent the payment. Example: address_in=3PFoGK63cVVUWnd2vu7W1kM83NXUfvzMqM |
address_out | string Address(es) where BlockBee forwarded the payment. Example: address_out=1H6ZZpRmMnrw8ytepV3BYwMjYYnEkWDqVP (single address)<br/>
{1H6ZZpRmMnrw8ytepV3BYwMjYYnEkWDqVP: 0.70, 1PE5U4temq1rFzseHHGE2L8smwHCyRbkx3: 0.30} (multiple addresses)
|
txid_in | string Transaction hash of your customer's payment. Example: txid_in=a2174ffd39289100709f2a07b129cdbba69df2e22e5be1830221dab1fd4e332c |
txid_out | string Transaction hash of the payment forwarded to your address(es) by BlockBee. Example: txid_out=a2174ffd39289100709f2a07b129cdbba69df2e22e5be1830221dab1fd4e332c |
confirmations | integer Number of blockchain confirmations of the current transaction. Notes:
Example: confirmations=1 |
value_coin | number This is the payment amount sent by your customer before any fees are deducted. Notes:
Example: value_coin=0.05 |
value_coin_convert | string Converted value to various FIAT currencies of the value_coin .
Notes:
Example: value_coin_convert={"USD": "3.20", "EUR": "3.05", "GBP": "2.62", "CAD": "4.16", "JPY": "431.90", "AED": "11.77", "DKK": "22.67", "BRL": "16.52", "CNY": "21.43", "HKD": "25.16", "INR": "249.97", "MXN": "64.95", "UGX": "11975.46", "PLN": "14.25", "PHP": "173.14", "CZK": "75.37", "HUF": "1220.10", "BGN": "5.94", "RON": "15.02", "LKR": "1153.30", "TRY": "55.54", "ZAR": "51.36", "RUB": "181.24"} |
value_forwarded_coin | number Value forwarded to you, after fees deducted. Example: value_forwarded_coin=0.05 |
value_forwarded_coin_convert | string Converted value to various FIAT currencies of the value_forwarded_coin .
Notes:
Example: value_forwarded_coin_convert={"USD": "3.17", "EUR": "3.01", "GBP": "2.59", "CAD": "4.12", "JPY": "427.16", "AED": "11.64", "DKK": "22.41", "BRL": "16.33", "CNY": "21.20", "HKD": "24.88", "INR": "247.19", "MXN": "64.25", "UGX": "11855.29", "PLN": "14.08", "PHP": "171.25", "CZK": "74.50", "HUF": "1206.19", "BGN": "5.88", "RON": "14.86", "LKR": "1140.51", "TRY": "54.93", "ZAR": "50.82", "RUB": "179.22"} |
fee_coin | |
coin | string Ticker of the coin used for the payment: ['btc', 'bch', 'ltc'', 'eth', 'trx'] For ERC-20 (ETH) Tokens, this parameter will be For TRC-20 (Tron) Tokens, this parameter will be For BEP-20 (BSC) Tokens, this parameter will be For Polygon Tokens, this parameter will be Example: coin=btc |
price | number Coin price in USD at the time of the callback. Example: price=55.59 |
pending | integer Being the confirmed callback, this value should be 0 .
Payment was confirmed by the blockchain. Example: pending=0 |
Expected response from your server.
The callback will be marked as successful when it receives the following response from your server.
*ok*
Documentation on how to use our ready-made Checkout page to receive cryptocurrency payments.
Check the demo!
Before using the Checkout page (Failing to do so will lead to errors when requesting a Payment link):
This method allows you to request a new Payment link. Notes:
apikey required | string |
redirect_url required | string URL where your customers will be redirected to after successfully completing the payment. The Notes:
Example: redirect_url=https://example.com/success/?order_id=12345 |
value required | number Value of the order in the FIAT currency set in your Payment Settings at BlockBee's Dashboard. Example: value=10 |
currency | string Set the FIAT currency used in the value parameter.
Note: Will override the FIAT currency set in your Payment Settings at BlockBee's Dashboard. FIAT currencies supported in this list are (if the FIAT currency you wish to use is not in this list, you may contact us in order to add it to our service):
Some cryptocurrencies are also accepted in this field (for the conversion of the
Example: currency=eur |
item_description | string Description of the product or service being paid. This information will appear on the Checkout page. Example: item_description=Description of the product you are selling |
expire_at | number Epoch time in seconds at which the Checkout payment will expire. Notes:
Example: expire_at=1673438907 |
notify_url | string URL where our system will send a payment notification (IPN), when a deposit is made. Notes:
|
post | number Default: 0 Set this to 1 if you wish to receive the IPN as a POST request.
If set to Notes:
Example: post=1 |
Payment URL was created successfully.
status | string Status of the request. Should be success if the request didn't fail.
|
payment_id | string ID of the checkout payment. May be used with the logs endpoint. |
success_token | string Security token only known by your system and BlockBee so you can make sure the order was actually paid by your customer. |
payment_url | string Payment URL where your customer should be redirected to initiate the transaction. Note: It's possible to pre-select a cryptocurrency for the checkout page by using the coin GET parameter.* All of our supported tickers can be found at our cryptocurrencies page. Please replace the / with a _ .* Example: In order to pre-select Bitcoin for the payment, append ?coin=trc20_usdt to the payment_url as the following example: https://pay.blockbee.io/payment/fG78jtx96ugjtu0eIbeLmFB9z0feJf9N?coin=trc20_usdt . |
Your request couldn't be processed, please try again later
{- "status": "success",
- "payment_id": "fG78jtx96ugjtu0eIbeLmFB9z0feJf9N",
- "success_token": "fG78jtx96ugjtu0eIbeLmFB9z0feJf9NfG78jtx96ugjtu0eIbeLmFB9z0feJf9N",
}
This method allows you to check the payment status and the IPN logs for a payment using our API.
Payment logs fetched successfully.
Your request couldn't be processed, please try again later
Unauthorized. Invalid API key.
{- "status": "success",
- "is_paid": true,
- "is_pending": false,
- "is_expired": false,
- "is_partial": false,
- "payment_data": [
- {
- "value": "0.001017",
- "value_paid": "0",
- "value_outstanding": "0.001017",
- "exchange_rate": "0.000335697",
- "coin": "eth",
- "txid": [ ]
}, - {
- "value": "0.000059",
- "value_paid": "0",
- "value_outstanding": "0.000059",
- "exchange_rate": "0.0000194161",
- "coin": "btc",
- "txid": [ ]
}, - {
- "value": "3.03",
- "value_paid": "3.03",
- "value_outstanding": "0",
- "exchange_rate": "1.00038",
- "coin": "bep20_usdt",
- "txid": [
- "0x0a417c99b07cf11d686243befc80687aa729dba4dd2796207ffdf0ca304aa78c"
]
}
], - "notifications": [
- {
- "payload": {
- "value": "3.030303030303030276",
- "success_token": "YVzijuz1JrYAy3Cn0Ehpom359fpmfMoUPogZk3EFZ9iEy2aYWFACwAuLQYOw8UNn",
- "currency": "usd",
- "is_paid": 1,
- "paid_amount": "3.03",
- "paid_coin": "bep20_usdt",
- "exchange_rate": "1.00038",
- "txid": "0x0a417c99b07cf11d686243befc80687aa729dba4dd2796207ffdf0ca304aa78c",
- "address": "0x1798fEB67Aaf5C0609aa7C3DEf27EcAB067cCBB5",
- "status": "done"
}, - "response": "*ok*",
- "response_status": "200",
- "pending": false,
- "timestamp": "2024-02-22T12:21:39.877Z"
}
]
}
notify_url
.
Notes:
POST
if post=1
parameter set, else sent via GET
145.239.119.223
and 135.125.112.47
*ok*
to our IPNs.payment_url | string Payment link where the payment came from. Example: payment_url=https://pay.blockbee.io/payment/fG78jtx96ugjtu0eIbeLmFB9z0feJf9N |
redirect_url | string Redirect URL provided when requesting a new payment link. Example: redirect_url=https://example.com/success/?order_id=12345 |
value | number Amount in FIAT you requested when creating the payment link. Example: value=20000 |
success_token | string Security token only known to your systems so you can make sure the order was actually paid by your customer. Example: success_token=fG78jtx96ugjtu0eIbeLmFB9z0feJf9NfG78jtx96ugjtu0eIbeLmFB9z0feJf9N |
currency | string FIAT currency. Should be the same that you set in your Payment Settings at BlockBee's Dashboard. Example: currency=usd |
is_paid | string Default: 1 Should always be 1 .
Example: is_paid=1 |
paid_amount | string Amount paid in cryptocurrency. Notes:
Example: paid_amount=1.23 |
paid_coin | string Cryptocurrency/token used to make the payment. Notes:
Example: paid_coin=btc |
exchange_rate | number Exchange rate at the time of the payment. Example: exchange_rate=20000 |
txid | string Transaction hash(es) of your client's payment(s). Notes:
Example: txid=0xa7551df44e487f9c0507d68d90193cde2604dfcefdc975bae54535a2e0f80b32,0x6e8b278e3db1948d2c694b7f709dd4e864ae80d516970ebfd05a98629b6efe15,0x387c6250b3e86f7372b9c49d00497f1b26b373d40801c9e60a97ef5124b6b75c |
address | string Address generated by BlockBee where your client's payment was received. Example: address=3PFoGK63cVVUWnd2vu7W1kM83NXUfvzMqM |
status | string Status of the transaction. Example: status=done |
Expected response from your server.
The callback will be marked as successful when it receives the following response from your server.
*ok*
Documentation on how to use our ready-made Checkout page to receive cryptocurrency deposits.
Check the demo!
Before using the Checkout page (Failing to do so will lead to errors when requesting a Deposit link):
This method allows you to create a new Deposit link.
Notes:
apikey required | string |
currency | string Set the FIAT currency used in the deposit page. Note: Will override the FIAT currency set in your Payment Settings at BlockBee's Dashboard. FIAT currencies supported in this list are (if the FIAT currency you wish to use is not in this list, you may contact us in order to add it to our service):
Some cryptocurrencies are also accepted in this field (for the conversion of the
Example: currency=eur |
notify_url required | string URL where our system will send a payment notification (IPN), when a deposit is made. Notes:
Example: notify_url=https://example.com?user_id=1124 |
item_description | string Description of the product or service being paid. This information will appear on the Checkout page. |
post | number Default: 0 Set this to 1 if you wish to receive the IPN as a POST request.
If set to Notes:
Example: post=1 |
suggested_value | number Set this field if you'd like to suggest a specific amount in the deposit link. Must be a number higher than 0. Notes:
Example: suggested_value=10 |
Deposit URL was created successfully.
status | string Status of the request. Should be success if the request didn't fail.
|
payment_url | string Payment URL where your customer should be redirected to initiate the transaction. Note: It's possible to pre-select a cryptocurrency for the checkout page by using the coin GET parameter.* All of our supported tickers can be found at our cryptocurrencies page. Please replace the / with a _ .* Example: In order to pre-select Bitcoin for the payment, append ?coin=trc20_usdt to the payment_url as the following example: https://pay.blockbee.io/deposit/fG78jtx96ugjtu0eIbeLmFB9z0feJf9N?coin=trc20_usdt . |
payment_id | string ID of the deposit. May be used with the logs endpoint. |
Your request couldn't be processed, please try again later
{- "status": "success",
- "payment_id": "fG78jtx96ugjtu0eIbeLmFB9z0feJf9N"
}
Fetches logs of all deposits made to your Deposit link, including transaction details, value in fiat currency, and the status of each deposit. This endpoint is essential for tracking incoming payments and ensuring they are correctly processed and reconciled in your system.
A list of deposit transactions made to your account.
status | string |
Array of objects | |
total_deposited | string The total amount deposited. |
currency | string The fiat currency used for the |
Array of objects Notifications sent regarding deposit processing. |
Bad request. Invalid request parameters.
Unauthorized. Invalid API key.
{- "status": "success",
- "deposits": [
- {
- "txid": "0x448737599d08ccb92a4545a42e6171133177a86ac64435877b891f1e2dff4abd",
- "value": "1",
- "value_fiat": "1",
- "coin": "BEP20_USDT",
- "pending": false,
- "timestamp": "31/08/2023 19:30:35"
}
], - "total_deposited": "7.69",
- "currency": "USD",
- "notifications": [
- {
- "payload": {
- "value": "3.030303030303030276",
- "success_token": "YVzijuz1JrYAy3Cn0Ehpom359fpmfMoUPogZk3EFZ9iEy2aYWFACwAuLQYOw8UNn",
- "currency": "usd",
- "is_paid": 1,
- "paid_amount": "3.03",
- "paid_coin": "bep20_usdt",
- "exchange_rate": "1.00038",
- "txid": "0x0a417c99b07cf11d686243befc80687aa729dba4dd2796207ffdf0ca304aa78c",
- "address": "0x1798fEB67Aaf5C0609aa7C3DEf27EcAB067cCBB5",
- "status": "done"
}, - "response": "*ok*",
- "response_status": "200",
- "pending": false,
- "timestamp": "2024-02-22T12:21:39.877Z"
}
]
}
IPN issued when the deposit has been confirmed by the
network. Will be sent to the URL provided in notify_url
.
Notes:
POST
if post=1
parameter set, else sent via GET
145.239.119.223
and 135.125.112.47
*ok*
to our IPNs.uuid | string This is an unique identifier to each payment your clients have made, so you can easily track any duplicate IPNs sent, in the case our system doesn't mark the IPN as successful. Notes:
Example: uuid=afe11bea-768b-47ae-ba0f-907379fbe5ef |
txid | string Transaction hash of your client's deposit. Example: txid=0xa7551df44e487f9c0507d68d90193cde2604dfcefdc975bae54535a2e0f80b32 |
address | string Address generated by BlockBee where your client's payment was received. Example: address=3PFoGK63cVVUWnd2vu7W1kM83NXUfvzMqM |
payment_url | string Deposit link where the deposit came from. Example: payment_url=https://pay.blockbee.io/deposit/fG78jtx96ugjtu0eIbeLmFB9z0feJf9N |
currency | string FIAT currency. Should be the same that you set in your Payment Settings at BlockBee's Dashboard. Example: currency=usd |
paid_amount | string Amount paid in cryptocurrency. Notes:
Example: paid_amount=1.23 |
paid_amount_fiat | string Amount paid in the FIAT currency described in the parameter currency .
Example: paid_amount_fiat=21234.32 |
paid_coin | string Cryptocurrency/token used to make the payment. Notes:
Example: paid_coin=btc |
status | string Status of the transaction. Example: status=done |
Expected response from your server
The callback will be marked as successful when it receives the following response from your server
*ok*
A Payout Request involves the transfer of funds to a designated address.
Notes:
ticker
provided.
Notes:
50
Payout Requests per page.ticker required | string The ticker parameter in this API request refers to the unique identifier of the cryptocurrency to which you are making the request.
It is included in the URL of the request and helps to specify the exact cryptocurrency that you want to retrieve data for. The ticker is typically a short code that uniquely identifies the cryptocurrency, or the token and it's network/blockchain.
For example, Notes:
Example: eth |
List of Payout Requests.
Your request couldn't be processed, please try again later.
{- "status": "success",
- "payout_requests": [
- {
- "id": "3825d29b-7a8f-47da-8623-e99850674247",
- "payout_id": "ce270ad3-e563-4850-a18f-c057eaca0d8f",
- "coin": "eth",
- "address": "0xA6B78B56ee062185E405a1DDDD18cE8fcBC4395d",
- "value": "0.245",
- "status": "processing",
- "display_status": "Processing",
- "timestamp": "04/08/2024 09:25:00"
}
], - "num_pages": 1
}
ticker required | string The ticker parameter in this API request refers to the unique identifier of the cryptocurrency to which you are making the request.
It is included in the URL of the request and helps to specify the exact cryptocurrency that you want to retrieve data for. The ticker is typically a short code that uniquely identifies the cryptocurrency, or the token and it's network/blockchain.
For example, Notes:
Example: eth |
{- "status": "success",
- "request_id": "3825d29b-7a8f-47da-8623-e99850674247"
}
Notes:
Payout Request
represents a payment request initiated to facilitate a transaction with your customer.ticker required | string The ticker parameter in this API request refers to the unique identifier of the cryptocurrency to which you are making the request.
It is included in the URL of the request and helps to specify the exact cryptocurrency that you want to retrieve data for. The ticker is typically a short code that uniquely identifies the cryptocurrency, or the token and it's network/blockchain.
For example, Notes:
Example: eth |
object A JSON object containing the mapping of payout destination addresses to the amounts to be paid out. |
Success response indicating the creation of multiple Payout Requests.
Your request couldn't be processed, please try again later
{- "outputs": {
- "0xA6B78B56ee062185E405a1DDDD18cE8fcBC4395d": 0.2,
- "0x18B211A1Ba5880C7d62C250B6441C2400d588589": 0.1
}
}
{- "status": "success",
- "request_ids": [
- "e7408219-b37c-4e24-8a71-78f0755468d8",
- "a8703c94-3bbe-4642-b4e3-7c1258600692"
]
}
ticker required | string The ticker parameter in this API request refers to the unique identifier of the cryptocurrency to which you are making the request.
It is included in the URL of the request and helps to specify the exact cryptocurrency that you want to retrieve data for. The ticker is typically a short code that uniquely identifies the cryptocurrency, or the token and it's network/blockchain.
For example, Notes:
Example: eth |
object A JSON object containing the mapping of payout destination addresses to the amounts to be paid out. |
{- "outputs": {
- "0xA6B78B56ee062185E405a1DDDD18cE8fcBC4395d": 0.2,
- "0x18B211A1Ba5880C7d62C250B6441C2400d588589": 0.1
}
}
{- "status": "success",
- "payout_info": {
- "id": "3825d29b-7a8f-47da-8623-e99850674247",
- "status": "created",
- "display_status": "Created",
- "from": "",
- "requests": {
- "0xA6B78B56ee062185E405a1DDDD18cE8fcBC4395d": "4.000000000000000000"
}, - "total_requested": "4",
- "total_with_fee": "4.04",
- "total_fiat": "",
- "fee": "0.04",
- "coin": "bep20_usdt",
- "txid": "",
- "timestamp": "05/03/2024 15:10:00"
}, - "queued": true
}
Automated or Manual Payouts API that allows to send funds to multiple addresses.
Payouts can now be fulfilled automatically using our dedicated API endpoints.
This streamlines the transaction process, allowing you to send funds to up to 100 different addresses with a single transaction,
without the need for manual selection and approval.
However, you can still fulfil Payouts from BlockBee Dashboard using your own wallet.
Notes:
ticker
provided.
Notes:
50
Payout Requests per page.ticker required | string The ticker parameter in this API request refers to the unique identifier of the cryptocurrency to which you are making the request.
It is included in the URL of the request and helps to specify the exact cryptocurrency that you want to retrieve data for. The ticker is typically a short code that uniquely identifies the cryptocurrency, or the token and it's network/blockchain.
For example, Notes:
Example: eth |
List of Payouts.
Your request couldn't be processed, please try again later.
{- "status": "success",
- "payouts": [
- {
- "id": "47bb524e-3b96-4d58-a7bd-439d1cca2f07",
- "status": "done",
- "display_status": "Done",
- "total_requested": "1",
- "total_with_fee": "1.01",
- "total_fiat": "",
- "fee": "0.01",
- "coin": "bep20_usdt",
- "timestamp": "07/02/2024 09:26:00"
}
], - "num_pages": 1
}
ID
.
Notes:
Done
.payout_id=12345
{- "status": "success",
- "payout_info": {
- "id": "3825d29b-7a8f-47da-8623-e99850674247",
- "status": "created",
- "display_status": "Created",
- "from": "",
- "requests": {
- "0xA6B78B56ee062185E405a1DDDD18cE8fcBC4395d": "4.000000000000000000"
}, - "total_requested": "4",
- "total_with_fee": "4.04",
- "total_fiat": "",
- "fee": "0.04",
- "coin": "bep20_usdt",
- "txid": "",
- "timestamp": "05/03/2024 15:10:00"
}, - "queued": true
}
ID
.
Notes:
12345,54321
.request_ids=12345%2C54321
{- "status": "success",
- "payout_info": {
- "id": "e7408219-b37c-4e24-8a71-78f0755468d8",
- "status": "created",
- "display_status": "Created",
- "from": "",
- "requests": {
- "0xA6B78B56ee062185E405a1DDDD18cE8fcBC4395d": "0.200000000000000011",
- "0xA8EbeD50f2e05fB4a25b2DdCdc651A7CA769B5CF": "0.100000000000000006"
}, - "total_requested": "0.300000000000000017",
- "total_with_fee": "0.30300000000000001717",
- "total_fiat": "",
- "fee": "0.00300000000000000017",
- "coin": "bep20_usdt",
- "txid": "",
- "timestamp": "12/03/2024 14:40:11"
}
}
ID
.
payout_id=e7408219-b37c-4e24-8a71-78f0755468d8
{- "status": "success",
- "payout_info": {
- "id": "e7408219-b37c-4e24-8a71-78f0755468d8",
- "status": "created",
- "display_status": "Created",
- "from": "",
- "requests": {
- "0xA6B78B56ee062185E405a1DDDD18cE8fcBC4395d": "0.2",
- "0xA8EbeD50f2e05fB4a25b2DdCdc651A7CA769B5CF": "0.1"
}, - "total_requested": "0.3",
- "total_with_fee": "0.30",
- "total_fiat": "",
- "fee": "0.003",
- "coin": "bep20_usdt",
- "txid": "",
- "timestamp": "12/03/2024 14:40:11"
}
}
A Self-Custodial Wallet is hosted by BlockBee, but only you have access to its funds using your API Key V2. This wallet enables funds to be sent automatically via API requests.
Notes:
ticker
provided.
ticker required | string The ticker parameter in this API request refers to the unique identifier of the cryptocurrency to which you are making the request.
It is included in the URL of the request and helps to specify the exact cryptocurrency that you want to retrieve data for. The ticker is typically a short code that uniquely identifies the cryptocurrency, or the token and it's network/blockchain.
For example, Notes:
Example: eth |
{- "status": "success",
- "address": "0x18B211A1Ba5880C7d62C250B6441C2400d588589"
}
ticker
provided.
ticker required | string The ticker parameter in this API request refers to the unique identifier of the cryptocurrency to which you are making the request.
It is included in the URL of the request and helps to specify the exact cryptocurrency that you want to retrieve data for. The ticker is typically a short code that uniquely identifies the cryptocurrency, or the token and it's network/blockchain.
For example, Notes:
Example: eth |
Response with the Payout Wallet address for the provided ticker
.
Your request couldn't be processed, please try again later
{- "status": "success",
- "balance": 0.02
}
Create custom and specially tailored UIs for your business with the help of these endpoints.
These endpoints provide you with essential features to make conversions, get estimates, retrieve information, and generate QR codes.
Endpoint that provides information regarding BlockBee API Service (e.g supported blockchains, cryptocurrencies and tokens).
Info fetched successfully.
object | |
object |
{- "btc": {
- "coin": "Bitcoin",
- "ticker": "btc",
- "minimum_transaction_coin": "0.00008000",
- "minimum_fee_coin": "0.00000546",
- "fee_percent": "1.00",
- "network_fee_estimation": "0.006548837643539048",
- "prices": "{'DKK': '56281.94', 'CAD': '10985.14', 'AED': '30517.01', 'BRL': '34243.36', 'USD': '8308.47', 'MXN': '160193.26', 'CNY': '58740.88', 'INR': '591471.72', 'JPY': '899719.16', 'HKD': '65173.93', 'GBP': '6616.08', 'EUR': '7535.35'}",
- "prices_updated": "2019-10-14T13:00:09.585Z"
}, - "trc20": {
- "usdt": {
- "coin": "USDT",
- "ticker": "usdt",
- "minimum_transaction_coin": "3.00000000",
- "minimum_fee_coin": "0.00000546",
- "fee_percent": "1.00",
- "network_fee_estimation": "31.89800000",
- "prices": "{'DKK': '56281.94', 'CAD': '10985.14', 'AED': '30517.01', 'BRL': '34243.36', 'USD': '8308.47', 'MXN': '160193.26', 'CNY': '58740.88', 'INR': '591471.72', 'JPY': '899719.16', 'HKD': '65173.93', 'GBP': '6616.08', 'EUR': '7535.35'}",
- "prices_updated": "2019-10-14T13:00:09.585Z"
}
}
}
Use this endpoint to retrieve information about the cryptocurrency you intend to use. This endpoint provides detailed information about the cryptocurrency/token provided in the ticker
parameter.
ticker required | string The ticker parameter in this API request refers to the unique identifier of the cryptocurrency to which you are making the request.
It is included in the URL of the request and helps to specify the exact cryptocurrency that you want to retrieve data for. The ticker is typically a short code that uniquely identifies the cryptocurrency, or the token and it's network/blockchain.
For example, Notes:
Example: btc |
Info fetched successfully.
status | string Status of the request. Should be `success` if the request didn't fail. |
coin | string Human readable name of the currency. |
ticker | string Ticker of the currency. |
minimum_transaction_coin | string Minimum transaction value for this currency, values below this value are disregarded by BlockBee API. |
minimum_fee_coin | string BlockBee currently doesn't charge a minimum fee. On Bitcoin and Bitcoin Cash there's a minimum transaction fee of 546 Satoshis due to dust threshold. For Litecoin it's 5460 Litoshis. |
fee_percent | number Fee percentage for this currency. |
network_fee_estimation | string Estimation of the blockchain fee for this cryptocurrency/token. **Notes:** * This value is informative. To obtain a blockchain fee estimation use the estimate endpoint instead. |
prices | object Object with the exchange rate of this currency in various FIAT currencies. Keys are the names of the currencies, values are the exchange rates. Updated every 5 minutes. |
prices_updated | string Datetime of the last price update. |
Error fetching info.
{- "status": "success",
- "coin": "Bitcoin",
- "ticker": "btc",
- "minimum_transaction_coin": "0.00008000",
- "minimum_fee_coin": "0.00000546",
- "fee_percent": "1.00",
- "network_fee_estimation": "0.006548837643539048",
- "prices": "{'DKK': '56281.94', 'CAD': '10985.14', 'AED': '30517.01', 'BRL': '34243.36', 'USD': '8308.47', 'MXN': '160193.26', 'CNY': '58740.88', 'INR': '591471.72', 'JPY': '899719.16', 'HKD': '65173.93', 'GBP': '6616.08', 'EUR': '7535.35'}",
- "prices_updated": "2019-10-14T13:00:09.585Z"
}
This method generates a base64-encoded QR Code image for payments.
ticker required | string The ticker parameter in this API request refers to the unique identifier of the cryptocurrency to which you are making the request.
It is included in the URL of the request and helps to specify the exact cryptocurrency that you want to retrieve data for. The ticker is typically a short code that uniquely identifies the cryptocurrency, or the token and it's network/blockchain.
For example, Notes:
Example: btc |
apikey required | string |
address required | string The payment address ( address_in from our system).
|
value | integer Value to request the user. Optional. Notes:
|
size | integer Default: 512 Size of the QR Code image in pixels. Min: 64 Max: 1024
Example: size=300 |
The QR Code.
{- "status": "success",
- "qr_code": "...",
- "payment_uri": "..."
}
Notes:
ticker required | string The ticker parameter in this API request refers to the unique identifier of the cryptocurrency to which you are making the request.
It is included in the URL of the request and helps to specify the exact cryptocurrency that you want to retrieve data for. The ticker is typically a short code that uniquely identifies the cryptocurrency, or the token and it's network/blockchain.
For example, Notes:
Example: btc |
apikey required | string |
addresses | |
priority | string Default: "default" This parameter allows you to set the priority with which funds should be forwarded to the provided address. It reflects the amount of fees paid to the blockchain network and can affect the speed of transaction confirmation. It's different per currency/network. Notes:
Example: priority=fast |
Estimated cost.
status | string Status of the request. Should be `success` if the request didn't fail. |
estimated_cost | integer Estimated cost in the blockchain’s native cryptocurrency. Notes:
|
estimated_cost_currency | object Object with the estimated cost in various FIAT currencies. Keys are the names of the currencies, values are the estimated costs. |
Your request couldn't be processed, please try again later
{- "status": "success",
- "estimated_cost": "0.00001",
- "estimated_cost_currency": "{'USD': '0.09', 'EUR': '0.08', 'GBP': '0.07', 'CAD': '0.11', 'JPY': '10.21', 'AED': '0.33', 'DKK': '0.58', 'BRL': '0.46', 'CNY': '0.56', 'HKD': '0.69', 'INR': '6.67', 'MXN': '1.81', 'UGX': '310.74', 'PLN': '0.35', 'PHP': '4.56', 'CZK': '1.91', 'HUF': '27.95', 'BGN': '0.15', 'RON': '0.39', 'LKR': '18.02'}"
}
With this method, you can effortlessly convert prices between FIATs and cryptocurrencies, or even between different cryptocurrencies.
Note:
ticker required | string The ticker parameter in this API request refers to the unique identifier of the cryptocurrency to which you are making the request.
It is included in the URL of the request and helps to specify the exact cryptocurrency that you want to retrieve data for. The ticker is typically a short code that uniquely identifies the cryptocurrency, or the token and it's network/blockchain.
For example, Notes:
Example: btc |
apikey required | string |
value required | number Value you wish to convert in the cryptocurrency/token of the ticker you are using. Example: value=10 |
from required | string Specify the currency you wish to convert from, whether it is FIAT or cryptocurrency. Check our full list of supported cryptocurrencies. FIAT currencies supported in this list are (if the FIAT currency you wish to use is not in this list, you may contact us in order to add it to our service):
Example: from=usd |
The converted value.
Your request couldn't be processed, please try again later.
{- "value_coin": "0.01",
- "exchange_rate": "47000",
- "status": "success"
}