{ "openapi": "3.1.0", "info": { "title": "BlockBee API", "version": "1.0.0", "description": "Cryptocurrency payment processing API. Generated from BlockBee documentation. See https://docs.blockbee.io for full guides, webhooks, and library SDKs.", "contact": { "name": "BlockBee Support", "url": "https://blockbee.io" }, "license": { "name": "Proprietary", "url": "https://blockbee.io/terms-of-service/" } }, "servers": [ { "url": "https://api.blockbee.io", "description": "Production" } ], "externalDocs": { "description": "Full documentation", "url": "https://docs.blockbee.io" }, "tags": [ { "name": "Custom Payment Flow" }, { "name": "Deposits" }, { "name": "Payments Checkout" }, { "name": "Payments Deposit" }, { "name": "Payout Requests" }, { "name": "Payouts" }, { "name": "Self-Custodial Wallet" }, { "name": "Subscriptions" }, { "name": "Utilities" }, { "name": "Webhooks" } ], "paths": { "/convert/": { "get": { "operationId": "convert_price", "summary": "Convert Price", "description": "This method enables seamless price conversion between fiat currencies and cryptocurrencies, as well as between different cryptocurrencies.", "tags": [ "Utilities" ], "externalDocs": { "description": "BlockBee docs page", "url": "https://docs.blockbee.io/api/convert-price" }, "parameters": [ { "name": "apikey", "in": "query", "required": true, "description": "Query parameter (string)", "schema": { "type": "string", "example": "your_api_key_here" } }, { "name": "value", "in": "query", "required": true, "description": "Query parameter (string)", "schema": { "type": "string", "example": "1" } }, { "name": "from", "in": "query", "required": true, "description": "Query parameter (string)", "schema": { "type": "string", "example": "usd" } }, { "name": "to", "in": "query", "required": true, "description": "Query parameter (string)", "schema": { "type": "string", "example": "btc" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "success" }, "value_coin": { "type": "string", "example": "0.0000088" }, "exchange_rate": { "type": "string", "example": "0.00000880022" } }, "example": { "status": "success", "value_coin": "0.0000088", "exchange_rate": "0.00000880022" } } } } } } } }, "/{ticker}/convert/": { "get": { "operationId": "convert_price_by_ticker", "summary": "Convert Prices Using Ticker", "description": "With this method, you can effortlessly convert prices between FIAT currencies and cryptocurrencies, or even between different cryptocurrencies, by specifying the ticker directly in the URL path. This makes the conversion process straightforward and easy to implement.\n**Note:** * Prices are fetched every 5 minutes from CoinMarketCap.", "tags": [ "Utilities" ], "externalDocs": { "description": "BlockBee docs page", "url": "https://docs.blockbee.io/api/convert-price-by-ticker" }, "parameters": [ { "name": "ticker", "in": "path", "required": true, "description": "Path parameter (string)", "schema": { "type": "string", "example": "btc" } }, { "name": "apikey", "in": "query", "required": true, "description": "Query parameter (string)", "schema": { "type": "string", "example": "your_api_key_here" } }, { "name": "value", "in": "query", "required": true, "description": "Query parameter (string)", "schema": { "type": "string", "example": "1" } }, { "name": "from", "in": "query", "required": false, "description": "Query parameter (string)", "schema": { "type": "string", "example": "usd" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "value_coin": { "type": "string", "example": "0.01" }, "exchange_rate": { "type": "string", "example": "47000" }, "status": { "type": "string", "example": "success" } }, "example": { "value_coin": "0.01", "exchange_rate": "47000", "status": "success" } } } } } } } }, "/checkout/request/": { "get": { "operationId": "create_checkout", "summary": "Create a Checkout Payment Link", "description": "This method allows you to request a new Payment link. **Notes:** * Supports partial payments and prompts the customer to complete the remaining balance if the full amount isn't paid.", "tags": [ "Payments Checkout" ], "externalDocs": { "description": "BlockBee docs page", "url": "https://docs.blockbee.io/api/create-checkout" }, "parameters": [ { "name": "apikey", "in": "query", "required": true, "description": "Query parameter (string)", "schema": { "type": "string", "example": "your_api_key_here" } }, { "name": "redirect_url", "in": "query", "required": true, "description": "Query parameter (string)", "schema": { "type": "string", "example": "https://example.com/success/?order_id=12345" } }, { "name": "value", "in": "query", "required": true, "description": "Query parameter (string)", "schema": { "type": "string", "example": "10" } }, { "name": "currency", "in": "query", "required": false, "description": "Query parameter (string)", "schema": { "type": "string", "example": "usd" } }, { "name": "item_description", "in": "query", "required": false, "description": "Query parameter (string)", "schema": { "type": "string", "example": "Order #1234" } }, { "name": "customer_name", "in": "query", "required": false, "description": "Query parameter (string)", "schema": { "type": "string", "example": "John Doe" } }, { "name": "customer_email", "in": "query", "required": false, "description": "Query parameter (string)", "schema": { "type": "string", "example": "email@example.com" } }, { "name": "expire_at", "in": "query", "required": false, "description": "Query parameter (datefield)", "schema": { "type": "string", "format": "date-time" } }, { "name": "notify_url", "in": "query", "required": false, "description": "Query parameter (string)", "schema": { "type": "string", "example": "https://example.com/callback/?order_id=12345" } }, { "name": "post", "in": "query", "required": false, "description": "Query parameter (number)", "schema": { "type": "integer", "example": "1" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "success" }, "payment_id": { "type": "string", "example": "fG78jtx96ugjtu0eIbeLmFB9z0feJf9N" }, "success_token": { "type": "string", "example": "fG78jtx96ugjtu0eIbeLmFB9z0feJf9NfG78jtx96ugjtu0eIbeLmFB9z0feJf9N" }, "payment_url": { "type": "string", "example": "https://pay.blockbee.io/payment/fG78jtx96ugjtu0eIbeLmFB9z0feJf9N" } }, "example": { "status": "success", "payment_id": "fG78jtx96ugjtu0eIbeLmFB9z0feJf9N", "success_token": "fG78jtx96ugjtu0eIbeLmFB9z0feJf9NfG78jtx96ugjtu0eIbeLmFB9z0feJf9N", "payment_url": "https://pay.blockbee.io/payment/fG78jtx96ugjtu0eIbeLmFB9z0feJf9N" } } } } } } } }, "/deposit/request/": { "get": { "operationId": "create_deposit", "summary": "Create Deposit Request", "description": "This method allows you to create a deposit request.", "tags": [ "Deposits" ], "externalDocs": { "description": "BlockBee docs page", "url": "https://docs.blockbee.io/api/create-deposit" }, "parameters": [ { "name": "apikey", "in": "query", "required": true, "description": "Query parameter (string)", "schema": { "type": "string", "example": "your_api_key_here" } }, { "name": "notify_url", "in": "query", "required": true, "description": "Query parameter (string)", "schema": { "type": "string", "example": "https://example.com/callback/?user_id=1124" } }, { "name": "currency", "in": "query", "required": false, "description": "Query parameter (string)", "schema": { "type": "string", "example": "usd" } }, { "name": "item_description", "in": "query", "required": false, "description": "Query parameter (string)", "schema": { "type": "string", "example": "Deposit #123" } }, { "name": "customer_name", "in": "query", "required": false, "description": "Query parameter (string)", "schema": { "type": "string", "example": "John Doe" } }, { "name": "customer_email", "in": "query", "required": false, "description": "Query parameter (string)", "schema": { "type": "string", "example": "email@example.com" } }, { "name": "post", "in": "query", "required": false, "description": "Query parameter (number)", "schema": { "type": "integer", "example": "1" } }, { "name": "suggested_value", "in": "query", "required": false, "description": "Query parameter (number)", "schema": { "type": "integer", "example": "10" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "success" }, "payment_url": { "type": "string", "example": "https://pay.blockbee.io/deposit/Zz87cpYde6cKszIwn0A6oOxea2i1eGoJ/" }, "payment_id": { "type": "string", "example": "Zz87cpYde6cKszIwn0A6oOxea2i1eGoJ" } }, "example": { "status": "success", "payment_url": "https://pay.blockbee.io/deposit/Zz87cpYde6cKszIwn0A6oOxea2i1eGoJ/", "payment_id": "Zz87cpYde6cKszIwn0A6oOxea2i1eGoJ" } } } } } } } }, "/{ticker}/create/": { "get": { "operationId": "create_payment_address", "summary": "Create New Payment Address", "description": "Generates a new address to give your customer for payment. Transactions below the minimum transfer limit for the chosen [cryptocurrency](https://blockbee.io/cryptocurrencies/) are rejected.\n**Notices:** * The length of this request must not exceed `8192` characters. * Check the minimum transfer limit for your chosen [cryptocurrency](https://blockbee.io/cryptocurrencies/) before generating an address. Transactions below the minimum are rejected.", "tags": [ "Custom Payment Flow" ], "externalDocs": { "description": "BlockBee docs page", "url": "https://docs.blockbee.io/api/create-payment-address" }, "parameters": [ { "name": "ticker", "in": "path", "required": true, "description": "Path parameter (string)", "schema": { "type": "string", "example": "btc" } }, { "name": "apikey", "in": "query", "required": true, "description": "Query parameter (string)", "schema": { "type": "string", "example": "your_api_key_here" } }, { "name": "callback", "in": "query", "required": true, "description": "Query parameter (string)", "schema": { "type": "string", "example": "https://example.com/your_callback?invoice_id=123" } }, { "name": "address", "in": "query", "required": false, "description": "Query parameter (string)", "schema": { "type": "string", "example": "1H6ZZpRmMnrw8ytepV3BYwMjYYnEkWDqVP" } }, { "name": "pending", "in": "query", "required": false, "description": "Query parameter (integer)", "schema": { "type": "integer", "example": "1" } }, { "name": "confirmations", "in": "query", "required": false, "description": "Query parameter (integer)", "schema": { "type": "integer", "example": "3" } }, { "name": "post", "in": "query", "required": false, "description": "Query parameter (integer)", "schema": { "type": "integer", "example": "1" } }, { "name": "json", "in": "query", "required": false, "description": "Query parameter (integer)", "schema": { "type": "integer", "example": "1" } }, { "name": "priority", "in": "query", "required": false, "description": "Query parameter (string)", "schema": { "type": "string", "example": "default" } }, { "name": "multi_token", "in": "query", "required": false, "description": "Query parameter (integer)", "schema": { "type": "integer", "example": "1" } }, { "name": "convert", "in": "query", "required": false, "description": "Query parameter (integer)", "schema": { "type": "integer", "example": "1" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "address_in": { "type": "string", "example": "14PqCsA7KMgseZMPwg6mJy754MtQkrgszu" }, "address_out": { "type": "string", "example": "1H6ZZpRmMnrw8ytepV3BYwMjYYnEkWDqVP (single address)\n\n{1H6ZZpRmMnrw8ytepV3BYwMjYYnEkWDqVP: 0.70, 1PE5U4temq1rFzseHHGE2L8smwHCyRbkx3: 0.30} (multiple addresses)\n" }, "callback_url": { "type": "string", "example": "https://example.com/invoice/1234?payment_id=5678" }, "priority": { "type": "string", "example": "default" }, "minimum_transaction_coin": { "type": "number", "example": 0.008 }, "status": { "type": "string", "example": "success" } }, "example": { "address_in": "14PqCsA7KMgseZMPwg6mJy754MtQkrgszu", "address_out": "1H6ZZpRmMnrw8ytepV3BYwMjYYnEkWDqVP (single address)\n\n{1H6ZZpRmMnrw8ytepV3BYwMjYYnEkWDqVP: 0.70, 1PE5U4temq1rFzseHHGE2L8smwHCyRbkx3: 0.30} (multiple addresses)\n", "callback_url": "https://example.com/invoice/1234?payment_id=5678", "priority": "default", "minimum_transaction_coin": 0.008, "status": "success" } } } } } } } }, "/payout/create/": { "post": { "operationId": "create_payout", "summary": "Create Payout", "description": "Create a Payout by providing the Payout Request ID(s).", "tags": [ "Payouts" ], "externalDocs": { "description": "BlockBee docs page", "url": "https://docs.blockbee.io/api/create-payout" }, "parameters": [ { "name": "apikey", "in": "query", "required": true, "description": "Query parameter (string)", "schema": { "type": "string", "example": "your_api_key_here" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "success" }, "payout_info": { "type": "object", "properties": { "id": { "type": "string", "example": "b4252c0a-03f1-4715-90b8-a32ba4c91b9f" }, "status": { "type": "string", "example": "created" }, "display_status": { "type": "string", "example": "Created" }, "from": { "type": "string", "example": "" }, "requests": { "type": "object", "properties": { "0xA6B78B56ee062185E405a1DDDD18cE8fcBC4395d": { "type": "string", "example": "0.2" } }, "example": { "0xA6B78B56ee062185E405a1DDDD18cE8fcBC4395d": "0.2" } }, "total_requested": { "type": "string", "example": "0.2" }, "total_with_fee": { "type": "string", "example": "0.201" }, "error": { "type": [ "string", "null" ] }, "blockchain_fee": { "type": "integer", "example": 0 }, "fee": { "type": "string", "example": "0.001" }, "coin": { "type": "string", "example": "bep20_usdt" }, "txid": { "type": "string", "example": "" }, "timestamp": { "type": "string", "example": "10/07/2025 17:28:29" } }, "example": { "id": "b4252c0a-03f1-4715-90b8-a32ba4c91b9f", "status": "created", "display_status": "Created", "from": "", "requests": { "0xA6B78B56ee062185E405a1DDDD18cE8fcBC4395d": "0.2" }, "total_requested": "0.2", "total_with_fee": "0.201", "error": null, "blockchain_fee": 0, "fee": "0.001", "coin": "bep20_usdt", "txid": "", "timestamp": "10/07/2025 17:28:29" } } }, "example": { "status": "success", "payout_info": { "id": "b4252c0a-03f1-4715-90b8-a32ba4c91b9f", "status": "created", "display_status": "Created", "from": "", "requests": { "0xA6B78B56ee062185E405a1DDDD18cE8fcBC4395d": "0.2" }, "total_requested": "0.2", "total_with_fee": "0.201", "error": null, "blockchain_fee": 0, "fee": "0.001", "coin": "bep20_usdt", "txid": "", "timestamp": "10/07/2025 17:28:29" } } } } } } }, "requestBody": { "required": true, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "request_ids": { "type": "string", "example": "7f839bdd-5acd-4ce3-984d-1be8357b642d,7f839bdd-5asd-4ce3-984d-1be8357b646d" } }, "required": [ "request_ids" ] } }, "application/json": { "schema": { "type": "object", "properties": { "request_ids": { "type": "string", "example": "7f839bdd-5acd-4ce3-984d-1be8357b642d,7f839bdd-5asd-4ce3-984d-1be8357b646d" } }, "required": [ "request_ids" ] } } } } } }, "/{ticker}/payout/request/create/": { "get": { "operationId": "create_payout_request", "summary": "Create a Payout Request", "description": "Use this method to create a new Payout Request, which is a request for a payment you wish to send to your customer. Once you have created the Payout Request, you can fulfill it using BlockBee's [Dashboard](https://dash.blockbee.io/), or by using BlockBee API.", "tags": [ "Payout Requests" ], "externalDocs": { "description": "BlockBee docs page", "url": "https://docs.blockbee.io/api/create-payout-request" }, "parameters": [ { "name": "ticker", "in": "path", "required": true, "description": "Path parameter (string)", "schema": { "type": "string", "example": "btc" } }, { "name": "apikey", "in": "query", "required": true, "description": "Query parameter (string)", "schema": { "type": "string", "example": "your_api_key_here" } }, { "name": "address", "in": "query", "required": true, "description": "Query parameter (string)", "schema": { "type": "string", "example": "1H6ZZpRmMnrw8ytepV3BYwMjYYnEkWDqVP" } }, { "name": "value", "in": "query", "required": true, "description": "Query parameter (string)", "schema": { "type": "string", "example": "0.001" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "success" }, "request_id": { "type": "string", "example": "3825d29b-7a8f-47da-8623-e99850674247" } }, "example": { "status": "success", "request_id": "3825d29b-7a8f-47da-8623-e99850674247" } } } } } } } }, "/{ticker}/payout/request/bulk/": { "post": { "operationId": "create_payout_requests_bulk", "summary": "Bulk Create Payout Requests", "description": "This method allows you to create multiple payout requests in bulk for a specific ticker.", "tags": [ "Payout Requests" ], "externalDocs": { "description": "BlockBee docs page", "url": "https://docs.blockbee.io/api/create-payout-requests-bulk" }, "parameters": [ { "name": "ticker", "in": "path", "required": true, "description": "Path parameter (string)", "schema": { "type": "string", "example": "btc" } }, { "name": "apikey", "in": "query", "required": true, "description": "Query parameter (string)", "schema": { "type": "string", "example": "your_api_key_here" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "success" }, "request_ids": { "type": "array", "items": { "type": "string", "example": "2a4437cb-4a5c-43c7-b3cb-4103bbae9486" }, "example": [ "2a4437cb-4a5c-43c7-b3cb-4103bbae9486", "8676ebfb-14c4-4455-af85-59257a8d1d8f" ] } }, "example": { "status": "success", "request_ids": [ "2a4437cb-4a5c-43c7-b3cb-4103bbae9486", "8676ebfb-14c4-4455-af85-59257a8d1d8f" ] } } } } } }, "requestBody": { "required": true, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "outputs": { "type": "string", "example": "{\"0xA6B78B56ee062185E405a1DDDD18cE8fcBC4395d\": 0.2, \"0x18B211A1Ba5880C7d62C250B6441C2400d588589\": 0.1}" } }, "required": [ "outputs" ] } }, "application/json": { "schema": { "type": "object", "properties": { "outputs": { "type": "string", "example": "{\"0xA6B78B56ee062185E405a1DDDD18cE8fcBC4395d\": 0.2, \"0x18B211A1Ba5880C7d62C250B6441C2400d588589\": 0.1}" } }, "required": [ "outputs" ] } } } } } }, "/subscription/create/": { "get": { "operationId": "create_subscription", "summary": "Create Subscription", "description": "This method allows you to create a subscription.", "tags": [ "Subscriptions" ], "externalDocs": { "description": "BlockBee docs page", "url": "https://docs.blockbee.io/api/create-subscription" }, "parameters": [ { "name": "apikey", "in": "query", "required": true, "description": "Query parameter (string)", "schema": { "type": "string", "example": "your_api_key_here" } }, { "name": "user_id", "in": "query", "required": true, "description": "Query parameter (string)", "schema": { "type": "string", "example": "user_123" } }, { "name": "user_email", "in": "query", "required": true, "description": "Query parameter (string)", "schema": { "type": "string", "example": "example@mail.com" } }, { "name": "option", "in": "query", "required": false, "description": "Query parameter (string)", "schema": { "type": "string", "example": "pro" } }, { "name": "post", "in": "query", "required": false, "description": "Query parameter (number)", "schema": { "type": "integer", "example": "1" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "success" }, "token": { "type": "string", "example": "I55hhRINHptLJPwsqwYNxJOKBItRiq1o" }, "subscription_url": { "type": "string", "example": "https://pay.blockbee.io/subscription/I55hhRINHptLJPwsqwYNxJOKBItRiq1o" } }, "example": { "status": "success", "token": "I55hhRINHptLJPwsqwYNxJOKBItRiq1o", "subscription_url": "https://pay.blockbee.io/subscription/I55hhRINHptLJPwsqwYNxJOKBItRiq1o" } } } } } } } }, "/{ticker}/estimate/": { "get": { "operationId": "estimate_fees", "summary": "Estimate Blockchain Fees", "description": "This method allows you to estimate blockchain fees to forward a transaction to your wallet address.\n**Notes:** * This is an **estimation** only, and might change significantly when the transaction is processed by the blockchain. BlockBee is not responsible if blockchain fees differ from this estimation when forwarding the funds. * Does not include BlockBee's fees.", "tags": [ "Utilities" ], "externalDocs": { "description": "BlockBee docs page", "url": "https://docs.blockbee.io/api/estimate-fees" }, "parameters": [ { "name": "ticker", "in": "path", "required": true, "description": "Path parameter (string)", "schema": { "type": "string", "example": "btc" } }, { "name": "apikey", "in": "query", "required": true, "description": "Query parameter (string)", "schema": { "type": "string", "example": "your_api_key_here" } }, { "name": "addresses", "in": "query", "required": false, "description": "Query parameter (integer)", "schema": { "type": "integer", "example": "1" } }, { "name": "priority", "in": "query", "required": false, "description": "Query parameter (string)", "schema": { "type": "string", "example": "default" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "success" }, "estimated_cost": { "type": "string", "example": "0.00000213000" }, "estimated_cost_currency": { "type": "object", "additionalProperties": { "type": "string" }, "example": { "AED": "0.84", "AUD": "0.35", "BGN": "0.38", "BRL": "1.26", "CAD": "0.31", "CHF": "0.18", "CNY": "1.65", "COP": "926.32", "CZK": "4.82", "DKK": "1.46", "EUR": "0.20", "GBP": "0.17", "HKD": "1.80", "HUF": "78.41", "IDR": "3731.31", "INR": "19.70", "JPY": "33.10", "LKR": "68.95", "MXN": "4.32", "MYR": "0.97", "NGN": "352.22", "NOK": "2.33", "PHP": "12.96", "PLN": "0.83", "RON": "0.99", "RUB": "18.11", "SEK": "2.20", "SGD": "0.29", "THB": "7.46", "TRY": "9.15", "TWD": "6.68", "UAH": "9.60", "UGX": "826.72", "USD": "0.23", "VND": "6016.13", "ZAR": "4.06" } } }, "example": { "status": "success", "estimated_cost": "0.00000213000", "estimated_cost_currency": { "AED": "0.84", "AUD": "0.35", "BGN": "0.38", "BRL": "1.26", "CAD": "0.31", "CHF": "0.18", "CNY": "1.65", "COP": "926.32", "CZK": "4.82", "DKK": "1.46", "EUR": "0.20", "GBP": "0.17", "HKD": "1.80", "HUF": "78.41", "IDR": "3731.31", "INR": "19.70", "JPY": "33.10", "LKR": "68.95", "MXN": "4.32", "MYR": "0.97", "NGN": "352.22", "NOK": "2.33", "PHP": "12.96", "PLN": "0.83", "RON": "0.99", "RUB": "18.11", "SEK": "2.20", "SGD": "0.29", "THB": "7.46", "TRY": "9.15", "TWD": "6.68", "UAH": "9.60", "UGX": "826.72", "USD": "0.23", "VND": "6016.13", "ZAR": "4.06" } } } } } } } } }, "/{ticker}/qrcode/": { "get": { "operationId": "generate_qr_code", "summary": "Payment QR Code Generator", "description": "This method generates a base64-encoded QR Code image for payments.", "tags": [ "Utilities" ], "externalDocs": { "description": "BlockBee docs page", "url": "https://docs.blockbee.io/api/generate-qr-code" }, "parameters": [ { "name": "ticker", "in": "path", "required": true, "description": "Path parameter (string)", "schema": { "type": "string", "example": "btc" } }, { "name": "apikey", "in": "query", "required": true, "description": "Query parameter (string)", "schema": { "type": "string", "example": "your_api_key_here" } }, { "name": "address", "in": "query", "required": true, "description": "Query parameter (string)", "schema": { "type": "string", "example": "1H6ZZpRmMnrw8ytepV3BYwMjYYnEkWDqVP" } }, { "name": "value", "in": "query", "required": false, "description": "Query parameter (string)", "schema": { "type": "string", "example": "0.001" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "success" }, "qr_code": { "type": "string", "example": "iVBORw0KGgoAAAANSUhEUgAAAQAAAAEAAQMAAABmvDolAAAABlBMVEX///8AAABVwtN+AAABsklEQVR4nO3WsQ3EIAwE0LnA/ld3MoQJc4K4v2ALzaKdg75vdv4qgQAEIAABCEAAAhCAAAQ@example" }, "payment_uri": { "type": "string", "example": "bitcoin:14PqCsA7KMgseZMPwg6mJy754MtQkrgszu?amount=0.1" } }, "example": { "status": "success", "qr_code": "iVBORw0KGgoAAAANSUhEUgAAAQAAAAEAAQMAAABmvDolAAAABlBMVEX///8AAABVwtN+AAABsklEQVR4nO3WsQ3EIAwE0LnA/ld3MoQJc4K4v2ALzaKdg75vdv4qgQAEIAABCEAAAhCAAAQ@example", "payment_uri": "bitcoin:14PqCsA7KMgseZMPwg6mJy754MtQkrgszu?amount=0.1" } } } } } } } }, "/checkout/logs/": { "get": { "operationId": "get_checkout_logs", "summary": "Get Checkout Logs", "description": "This method allows you to get the logs for a checkout payment.", "tags": [ "Payments Checkout" ], "externalDocs": { "description": "BlockBee docs page", "url": "https://docs.blockbee.io/api/get-checkout-logs" }, "parameters": [ { "name": "apikey", "in": "query", "required": true, "description": "Query parameter (string)", "schema": { "type": "string", "example": "your_api_key_here" } }, { "name": "payment_id", "in": "query", "required": true, "description": "Query parameter (string)", "schema": { "type": "string", "example": "fG78jtx96ugjtu0eIbeLmFB9z0feJf9N" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "success" }, "logs": { "type": "array", "items": { "type": "object", "properties": { "payment_id": { "type": "string", "example": "fG78jtx96ugjtu0eIbeLmFB9z0feJf9N" }, "status": { "type": "string", "example": "completed" }, "amount": { "type": "string", "example": "10" }, "currency": { "type": "string", "example": "eur" }, "created_at": { "type": "string", "example": "2024-03-12T14:40:11Z" } }, "example": { "payment_id": "fG78jtx96ugjtu0eIbeLmFB9z0feJf9N", "status": "completed", "amount": "10", "currency": "eur", "created_at": "2024-03-12T14:40:11Z" } }, "example": [ { "payment_id": "fG78jtx96ugjtu0eIbeLmFB9z0feJf9N", "status": "completed", "amount": "10", "currency": "eur", "created_at": "2024-03-12T14:40:11Z" } ] } }, "example": { "status": "success", "logs": [ { "payment_id": "fG78jtx96ugjtu0eIbeLmFB9z0feJf9N", "status": "completed", "amount": "10", "currency": "eur", "created_at": "2024-03-12T14:40:11Z" } ] } } } } } } } }, "/deposit/logs/": { "get": { "operationId": "get_deposit_logs", "summary": "Get Deposit Logs", "description": "This method allows you to get the logs for a deposit request.", "tags": [ "Deposits" ], "externalDocs": { "description": "BlockBee docs page", "url": "https://docs.blockbee.io/api/get-deposit-logs" }, "parameters": [ { "name": "apikey", "in": "query", "required": true, "description": "Query parameter (string)", "schema": { "type": "string", "example": "your_api_key_here" } }, { "name": "callback", "in": "query", "required": false, "description": "Query parameter (string)", "schema": { "type": "string", "example": "https://example.com/your_callback?invoice_id=123" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "success" }, "logs": { "type": "array", "items": { "type": "object", "properties": { "address_in": { "type": "string", "example": "14PqCsA7KMgseZMPwg6mJy754MtQkrgszu" }, "address_out": { "type": "string", "example": "1H6ZZpRmMnrw8ytepV3BYwMjYYnEkWDqVP" }, "value_coin": { "type": "string", "example": "0.00100000" }, "value_forwarded_coin": { "type": "string", "example": "0.00099000" }, "value_usd": { "type": "string", "example": "107.99" }, "callback_url": { "type": "string", "example": "https://example.com/your_callback?invoice_id=123" }, "confirmations": { "type": "integer", "example": 3 }, "txid_in": { "type": "string", "example": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6" }, "txid_out": { "type": "string", "example": "z6y5x4w3v2u1t0s9r8q7p6o5n4m3l2k1j0i9h8g7f6e5d4c3b2a1" }, "timestamp": { "type": "string", "example": "2024-01-15 10:30:45" }, "pending": { "type": "integer", "example": 0 }, "fee": { "type": "string", "example": "0.00001000" }, "fee_usd": { "type": "string", "example": "1.08" }, "priority": { "type": "string", "example": "default" }, "value_coin_convert": { "type": "string", "example": "{\"USD\":\"107.99\",\"EUR\":\"98.45\"}" }, "value_forwarded_coin_convert": { "type": "string", "example": "{\"USD\":\"106.91\",\"EUR\":\"97.47\"}" } }, "example": { "address_in": "14PqCsA7KMgseZMPwg6mJy754MtQkrgszu", "address_out": "1H6ZZpRmMnrw8ytepV3BYwMjYYnEkWDqVP", "value_coin": "0.00100000", "value_forwarded_coin": "0.00099000", "value_usd": "107.99", "callback_url": "https://example.com/your_callback?invoice_id=123", "confirmations": 3, "txid_in": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6", "txid_out": "z6y5x4w3v2u1t0s9r8q7p6o5n4m3l2k1j0i9h8g7f6e5d4c3b2a1", "timestamp": "2024-01-15 10:30:45", "pending": 0, "fee": "0.00001000", "fee_usd": "1.08", "priority": "default", "value_coin_convert": "{\"USD\":\"107.99\",\"EUR\":\"98.45\"}", "value_forwarded_coin_convert": "{\"USD\":\"106.91\",\"EUR\":\"97.47\"}" } }, "example": [ { "address_in": "14PqCsA7KMgseZMPwg6mJy754MtQkrgszu", "address_out": "1H6ZZpRmMnrw8ytepV3BYwMjYYnEkWDqVP", "value_coin": "0.00100000", "value_forwarded_coin": "0.00099000", "value_usd": "107.99", "callback_url": "https://example.com/your_callback?invoice_id=123", "confirmations": 3, "txid_in": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6", "txid_out": "z6y5x4w3v2u1t0s9r8q7p6o5n4m3l2k1j0i9h8g7f6e5d4c3b2a1", "timestamp": "2024-01-15 10:30:45", "pending": 0, "fee": "0.00001000", "fee_usd": "1.08", "priority": "default", "value_coin_convert": "{\"USD\":\"107.99\",\"EUR\":\"98.45\"}", "value_forwarded_coin_convert": "{\"USD\":\"106.91\",\"EUR\":\"97.47\"}" } ] } }, "example": { "status": "success", "logs": [ { "address_in": "14PqCsA7KMgseZMPwg6mJy754MtQkrgszu", "address_out": "1H6ZZpRmMnrw8ytepV3BYwMjYYnEkWDqVP", "value_coin": "0.00100000", "value_forwarded_coin": "0.00099000", "value_usd": "107.99", "callback_url": "https://example.com/your_callback?invoice_id=123", "confirmations": 3, "txid_in": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6", "txid_out": "z6y5x4w3v2u1t0s9r8q7p6o5n4m3l2k1j0i9h8g7f6e5d4c3b2a1", "timestamp": "2024-01-15 10:30:45", "pending": 0, "fee": "0.00001000", "fee_usd": "1.08", "priority": "default", "value_coin_convert": "{\"USD\":\"107.99\",\"EUR\":\"98.45\"}", "value_forwarded_coin_convert": "{\"USD\":\"106.91\",\"EUR\":\"97.47\"}" } ] } } } } } } } }, "/{ticker}/logs/": { "get": { "operationId": "get_payment_logs", "summary": "Check Payment Address Logs", "description": "This method provides information and callbacks for addresses created through the `create` endpoint. It returns a list of callbacks made at the specified `callbacks` parameter, and allows to track payment activity and troubleshoot any issues.", "tags": [ "Custom Payment Flow" ], "externalDocs": { "description": "BlockBee docs page", "url": "https://docs.blockbee.io/api/get-payment-logs" }, "parameters": [ { "name": "ticker", "in": "path", "required": true, "description": "Path parameter (string)", "schema": { "type": "string", "example": "btc" } }, { "name": "apikey", "in": "query", "required": true, "description": "Query parameter (string)", "schema": { "type": "string", "example": "your_api_key_here" } }, { "name": "callback", "in": "query", "required": true, "description": "Query parameter (string)", "schema": { "type": "string", "example": "https://example.com/your_callback?invoice_id=123" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "address_in": { "type": "string", "example": "14PqCsA7KMgseZMPwg6mJy754MtQkrgszu" }, "address_out": { "type": "string", "example": "1H6ZZpRmMnrw8ytepV3BYwMjYYnEkWDqVP" }, "callback_url": { "type": "string", "example": "https://example.com/invoice/1234?payment_id=5678" }, "status": { "type": "string", "example": "success" }, "notify_pending": { "type": "boolean", "example": true }, "notify_confirmations": { "type": "integer", "example": 1 }, "priority": { "type": "string", "example": "default" }, "callbacks": { "type": "array", "items": { "type": "object", "properties": { "txid_in": { "type": "string", "example": "33f11611f863d7475eb10daada2f225f0877561cf58cdfff175e99635dfd9120" }, "txid_out": { "type": "string", "example": "5ea53d5e728bfdb56b54c0b945990b69ae1e66cec56ab24679c9a622c4695276" }, "value_coin": { "type": "number", "example": 0.1 }, "value_forwarded_coin": { "type": "number", "example": 0.1 }, "confirmations": { "type": "integer", "example": 13 }, "last_update": { "type": "string", "example": "15/02/2018 21:23:42" }, "result": { "type": "string", "example": "done" }, "fee_percent": { "type": "integer", "example": 1 }, "fee_coin": { "type": "number", "example": 0.02 }, "logs": { "type": "array", "items": { "type": "object", "properties": { "request_url": { "type": "string", "example": "https://example.com/callback.php?order_id=423&nonce=KRnrAtVbbPrA21TR4yQDESnTV5xxV4jR&uuid=883d30bc-d53b-46e4-9f4d-425001a6a45d&address_in=0x672FF17DDD6f2F6b1CA8c2A9cC8D25f0950AbCc5&address_out=0xA6B78B56ee062185E405a1DDDD18cE8fcBC4395d&confirmations=84484&txid_in=0x4ac6d4f5df0803f91d5fb34d566400bb4417e98d5a515be087a9447d1f22cbbc&txid_out=0x711e26fec256b9945cee5195636772266104adc293d9013caa27752433a7effd&fee=1&value=200&value_coin=2.00011&value_forwarded=184&value_forwarded_coin=1.844926267290333679&coin=bep20_usdt&result=sent&pending=0" }, "responses": { "type": "string", "example": "*ok*" }, "response_status": { "type": "string", "example": "200" }, "next_try": { "type": "string", "example": "14/10/2022 12:47:18" }, "pending": { "type": "string", "example": "0" }, "confirmed": { "type": "integer", "example": 1 } }, "example": { "request_url": "https://example.com/callback.php?order_id=423&nonce=KRnrAtVbbPrA21TR4yQDESnTV5xxV4jR&uuid=883d30bc-d53b-46e4-9f4d-425001a6a45d&address_in=0x672FF17DDD6f2F6b1CA8c2A9cC8D25f0950AbCc5&address_out=0xA6B78B56ee062185E405a1DDDD18cE8fcBC4395d&confirmations=84484&txid_in=0x4ac6d4f5df0803f91d5fb34d566400bb4417e98d5a515be087a9447d1f22cbbc&txid_out=0x711e26fec256b9945cee5195636772266104adc293d9013caa27752433a7effd&fee=1&value=200&value_coin=2.00011&value_forwarded=184&value_forwarded_coin=1.844926267290333679&coin=bep20_usdt&result=sent&pending=0", "responses": "*ok*", "response_status": "200", "next_try": "14/10/2022 12:47:18", "pending": "0", "confirmed": 1 } }, "example": [ { "request_url": "https://example.com/callback.php?order_id=423&nonce=KRnrAtVbbPrA21TR4yQDESnTV5xxV4jR&uuid=883d30bc-d53b-46e4-9f4d-425001a6a45d&address_in=0x672FF17DDD6f2F6b1CA8c2A9cC8D25f0950AbCc5&address_out=0xA6B78B56ee062185E405a1DDDD18cE8fcBC4395d&confirmations=84484&txid_in=0x4ac6d4f5df0803f91d5fb34d566400bb4417e98d5a515be087a9447d1f22cbbc&txid_out=0x711e26fec256b9945cee5195636772266104adc293d9013caa27752433a7effd&fee=1&value=200&value_coin=2.00011&value_forwarded=184&value_forwarded_coin=1.844926267290333679&coin=bep20_usdt&result=sent&pending=0", "responses": "*ok*", "response_status": "200", "next_try": "14/10/2022 12:47:18", "pending": "0", "confirmed": 1 } ] } }, "example": { "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": [ { "request_url": "https://example.com/callback.php?order_id=423&nonce=KRnrAtVbbPrA21TR4yQDESnTV5xxV4jR&uuid=883d30bc-d53b-46e4-9f4d-425001a6a45d&address_in=0x672FF17DDD6f2F6b1CA8c2A9cC8D25f0950AbCc5&address_out=0xA6B78B56ee062185E405a1DDDD18cE8fcBC4395d&confirmations=84484&txid_in=0x4ac6d4f5df0803f91d5fb34d566400bb4417e98d5a515be087a9447d1f22cbbc&txid_out=0x711e26fec256b9945cee5195636772266104adc293d9013caa27752433a7effd&fee=1&value=200&value_coin=2.00011&value_forwarded=184&value_forwarded_coin=1.844926267290333679&coin=bep20_usdt&result=sent&pending=0", "responses": "*ok*", "response_status": "200", "next_try": "14/10/2022 12:47:18", "pending": "0", "confirmed": 1 } ] } }, "example": [ { "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": [ { "request_url": "https://example.com/callback.php?order_id=423&nonce=KRnrAtVbbPrA21TR4yQDESnTV5xxV4jR&uuid=883d30bc-d53b-46e4-9f4d-425001a6a45d&address_in=0x672FF17DDD6f2F6b1CA8c2A9cC8D25f0950AbCc5&address_out=0xA6B78B56ee062185E405a1DDDD18cE8fcBC4395d&confirmations=84484&txid_in=0x4ac6d4f5df0803f91d5fb34d566400bb4417e98d5a515be087a9447d1f22cbbc&txid_out=0x711e26fec256b9945cee5195636772266104adc293d9013caa27752433a7effd&fee=1&value=200&value_coin=2.00011&value_forwarded=184&value_forwarded_coin=1.844926267290333679&coin=bep20_usdt&result=sent&pending=0", "responses": "*ok*", "response_status": "200", "next_try": "14/10/2022 12:47:18", "pending": "0", "confirmed": 1 } ] } ] } }, "example": { "address_in": "14PqCsA7KMgseZMPwg6mJy754MtQkrgszu", "address_out": "1H6ZZpRmMnrw8ytepV3BYwMjYYnEkWDqVP", "callback_url": "https://example.com/invoice/1234?payment_id=5678", "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": [ { "request_url": "https://example.com/callback.php?order_id=423&nonce=KRnrAtVbbPrA21TR4yQDESnTV5xxV4jR&uuid=883d30bc-d53b-46e4-9f4d-425001a6a45d&address_in=0x672FF17DDD6f2F6b1CA8c2A9cC8D25f0950AbCc5&address_out=0xA6B78B56ee062185E405a1DDDD18cE8fcBC4395d&confirmations=84484&txid_in=0x4ac6d4f5df0803f91d5fb34d566400bb4417e98d5a515be087a9447d1f22cbbc&txid_out=0x711e26fec256b9945cee5195636772266104adc293d9013caa27752433a7effd&fee=1&value=200&value_coin=2.00011&value_forwarded=184&value_forwarded_coin=1.844926267290333679&coin=bep20_usdt&result=sent&pending=0", "responses": "*ok*", "response_status": "200", "next_try": "14/10/2022 12:47:18", "pending": "0", "confirmed": 1 } ] } ] } } } } } } } }, "/payout/status/": { "post": { "operationId": "get_payout_status", "summary": "Get Payout Status", "description": "Get the status of a payout by providing the payout ID.", "tags": [ "Payouts" ], "externalDocs": { "description": "BlockBee docs page", "url": "https://docs.blockbee.io/api/get-payout-status" }, "parameters": [ { "name": "apikey", "in": "query", "required": true, "description": "Query parameter (string)", "schema": { "type": "string", "example": "your_api_key_here" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "success" }, "payout_info": { "type": "object", "properties": { "id": { "type": "string", "example": "ddcbab52-3fbc-478c-a103-ecdc2f0ed58c" }, "status": { "type": "string", "example": "done" }, "display_status": { "type": "string", "example": "Done" }, "from": { "type": "string", "example": "0x18B211A1Ba5880C7d62C250B6441C2400d588589" }, "requests": { "type": "object", "properties": { "0xA6B78B56ee062185E405a1DDDD18cE8fcBC4395d": { "type": "string", "example": "0.2" } }, "example": { "0xA6B78B56ee062185E405a1DDDD18cE8fcBC4395d": "0.2" } }, "total_requested": { "type": "string", "example": "0.2" }, "total_with_fee": { "type": "string", "example": "0.201" }, "error": { "type": [ "string", "null" ] }, "blockchain_fee": { "type": "string", "example": "0.000024738630000000" }, "fee": { "type": "string", "example": "0.001" }, "coin": { "type": "string", "example": "bep20_usdt" }, "txid": { "type": "string", "example": "0xcc522d6b94e3f284f3f00d43729167f792419c70ec4f9143fc1bddeb04c91912" }, "timestamp": { "type": "string", "example": "10/07/2025 17:01:27" } }, "example": { "id": "ddcbab52-3fbc-478c-a103-ecdc2f0ed58c", "status": "done", "display_status": "Done", "from": "0x18B211A1Ba5880C7d62C250B6441C2400d588589", "requests": { "0xA6B78B56ee062185E405a1DDDD18cE8fcBC4395d": "0.2" }, "total_requested": "0.2", "total_with_fee": "0.201", "error": null, "blockchain_fee": "0.000024738630000000", "fee": "0.001", "coin": "bep20_usdt", "txid": "0xcc522d6b94e3f284f3f00d43729167f792419c70ec4f9143fc1bddeb04c91912", "timestamp": "10/07/2025 17:01:27" } } }, "example": { "status": "success", "payout_info": { "id": "ddcbab52-3fbc-478c-a103-ecdc2f0ed58c", "status": "done", "display_status": "Done", "from": "0x18B211A1Ba5880C7d62C250B6441C2400d588589", "requests": { "0xA6B78B56ee062185E405a1DDDD18cE8fcBC4395d": "0.2" }, "total_requested": "0.2", "total_with_fee": "0.201", "error": null, "blockchain_fee": "0.000024738630000000", "fee": "0.001", "coin": "bep20_usdt", "txid": "0xcc522d6b94e3f284f3f00d43729167f792419c70ec4f9143fc1bddeb04c91912", "timestamp": "10/07/2025 17:01:27" } } } } } } }, "requestBody": { "required": true, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "payout_id": { "type": "string", "example": "ddcbab52-3fbc-478c-a103-ecdc2f0ed58c" } }, "required": [ "payout_id" ] } }, "application/json": { "schema": { "type": "object", "properties": { "payout_id": { "type": "string", "example": "ddcbab52-3fbc-478c-a103-ecdc2f0ed58c" } }, "required": [ "payout_id" ] } } } } } }, "/info/": { "get": { "operationId": "get_service_info", "summary": "BlockBee Service Information", "description": "Endpoint that provides information regarding BlockBee API Service (e.g supported blockchains, cryptocurrencies and tokens).", "tags": [ "Utilities" ], "externalDocs": { "description": "BlockBee docs page", "url": "https://docs.blockbee.io/api/get-service-info" }, "parameters": [ { "name": "apikey", "in": "query", "required": false, "description": "Query parameter (string)", "schema": { "type": "string", "example": "your_api_key_here" } }, { "name": "prices", "in": "query", "required": false, "description": "Query parameter (integer)", "schema": { "type": "integer", "example": "0" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "btc": { "type": "object", "properties": { "coin": { "type": "string", "example": "Bitcoin" }, "logo": { "type": "string", "example": "https://api.cryptapi.io/media/token_logos/btc.png" }, "ticker": { "type": "string", "example": "btc" }, "minimum_transaction": { "type": "integer", "example": 8000 }, "minimum_transaction_coin": { "type": "string", "example": "0.00008000" }, "minimum_fee": { "type": "integer", "example": 546 }, "minimum_fee_coin": { "type": "string", "example": "0.00000546" }, "fee_percent": { "type": "string", "example": "1.000" }, "network_fee_estimation": { "type": "string", "example": "0.00000263" }, "prices": { "type": "object", "properties": { "USD": { "type": "string", "example": "113687.2123324492" }, "EUR": { "type": "string", "example": "97303.8618504321" } }, "example": { "USD": "113687.2123324492", "EUR": "97303.8618504321" } }, "prices_updated": { "type": "string", "example": "2025-07-10T17:35:17.529Z" } }, "example": { "coin": "Bitcoin", "logo": "https://api.cryptapi.io/media/token_logos/btc.png", "ticker": "btc", "minimum_transaction": 8000, "minimum_transaction_coin": "0.00008000", "minimum_fee": 546, "minimum_fee_coin": "0.00000546", "fee_percent": "1.000", "network_fee_estimation": "0.00000263", "prices": { "USD": "113687.2123324492", "EUR": "97303.8618504321" }, "prices_updated": "2025-07-10T17:35:17.529Z" } }, "avax-c": { "type": "object", "properties": { "avax": { "type": "object", "properties": { "coin": { "type": "string", "example": "AVAX" }, "logo": { "type": "string", "example": "https://api.cryptapi.io/media/token_logos/avax_avax.png" }, "ticker": { "type": "string", "example": "avax" }, "minimum_transaction": { "type": "integer", "example": 10000000000000000 }, "minimum_transaction_coin": { "type": "string", "example": "0.01000000" }, "minimum_fee": { "type": "integer", "example": 0 }, "minimum_fee_coin": { "type": "string", "example": "0E-8" }, "fee_percent": { "type": "string", "example": "1.000" }, "network_fee_estimation": { "type": "string", "example": "0.0002641508790732" }, "prices": { "type": "object", "properties": { "USD": { "type": "string", "example": "19.8455617107" }, "EUR": { "type": "string", "example": "16.9856376581" } }, "example": { "USD": "19.8455617107", "EUR": "16.9856376581" } }, "prices_updated": { "type": "string", "example": "2025-07-10T17:35:17.529Z" } }, "example": { "coin": "AVAX", "logo": "https://api.cryptapi.io/media/token_logos/avax_avax.png", "ticker": "avax", "minimum_transaction": 10000000000000000, "minimum_transaction_coin": "0.01000000", "minimum_fee": 0, "minimum_fee_coin": "0E-8", "fee_percent": "1.000", "network_fee_estimation": "0.0002641508790732", "prices": { "USD": "19.8455617107", "EUR": "16.9856376581" }, "prices_updated": "2025-07-10T17:35:17.529Z" } } }, "example": { "avax": { "coin": "AVAX", "logo": "https://api.cryptapi.io/media/token_logos/avax_avax.png", "ticker": "avax", "minimum_transaction": 10000000000000000, "minimum_transaction_coin": "0.01000000", "minimum_fee": 0, "minimum_fee_coin": "0E-8", "fee_percent": "1.000", "network_fee_estimation": "0.0002641508790732", "prices": { "USD": "19.8455617107", "EUR": "16.9856376581" }, "prices_updated": "2025-07-10T17:35:17.529Z" } } }, "fee_tiers": { "type": "array", "items": { "type": "object", "properties": { "minimum": { "type": "string", "example": "0.00" }, "fee": { "type": "string", "example": "1.000" } }, "example": { "minimum": "0.00", "fee": "1.000" } }, "example": [ { "minimum": "0.00", "fee": "1.000" }, { "minimum": "10000.00", "fee": "0.900" } ] } }, "example": { "btc": { "coin": "Bitcoin", "logo": "https://api.cryptapi.io/media/token_logos/btc.png", "ticker": "btc", "minimum_transaction": 8000, "minimum_transaction_coin": "0.00008000", "minimum_fee": 546, "minimum_fee_coin": "0.00000546", "fee_percent": "1.000", "network_fee_estimation": "0.00000263", "prices": { "USD": "113687.2123324492", "EUR": "97303.8618504321" }, "prices_updated": "2025-07-10T17:35:17.529Z" }, "avax-c": { "avax": { "coin": "AVAX", "logo": "https://api.cryptapi.io/media/token_logos/avax_avax.png", "ticker": "avax", "minimum_transaction": 10000000000000000, "minimum_transaction_coin": "0.01000000", "minimum_fee": 0, "minimum_fee_coin": "0E-8", "fee_percent": "1.000", "network_fee_estimation": "0.0002641508790732", "prices": { "USD": "19.8455617107", "EUR": "16.9856376581" }, "prices_updated": "2025-07-10T17:35:17.529Z" } }, "fee_tiers": [ { "minimum": "0.00", "fee": "1.000" }, { "minimum": "10000.00", "fee": "0.900" } ] } } } } } } } }, "/subscription/fetch/": { "get": { "operationId": "get_subscription", "summary": "Fetch Subscription", "description": "This method allows you to fetch a subscription by ID.", "tags": [ "Subscriptions" ], "externalDocs": { "description": "BlockBee docs page", "url": "https://docs.blockbee.io/api/get-subscription" }, "parameters": [ { "name": "apikey", "in": "query", "required": true, "description": "Query parameter (string)", "schema": { "type": "string", "example": "your_api_key_here" } }, { "name": "token", "in": "query", "required": true, "description": "Query parameter (string)", "schema": { "type": "string", "example": "J78yEgW01HIOGZqBeqzxpXFuCwHGQgdO" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "success" }, "subscription": { "type": "object", "properties": { "token": { "type": "string", "example": "J78yEgW01HIOGZqBeqzxpXFuCwHGQgdO" }, "url": { "type": "string", "example": "https://pay.blockbee.io/subscription/J78yEgW01HIOGZqBeqzxpXFuCwHGQgdO/" }, "active": { "type": "boolean", "example": true }, "user_id": { "type": "string", "example": "user_example" }, "user_email": { "type": "string", "example": "example@mail.com" }, "end_date_ts": { "type": "integer", "example": 1753022709 }, "payment_list": { "type": "array", "items": { "type": "object", "properties": { "token": { "type": "string", "example": "Wd1lggEvyy1usHooflFiEGNQbBn4TNvJ" }, "value": { "type": "string", "example": "1.99" }, "coin": { "type": "string", "example": "usd" }, "duration_ts": { "type": "integer", "example": 2592000 }, "received_fiat": { "type": "string", "example": "1.99" }, "is_paid": { "type": "boolean", "example": true }, "is_pending": { "type": "boolean", "example": false }, "is_partial": { "type": "boolean", "example": false } }, "example": { "token": "Wd1lggEvyy1usHooflFiEGNQbBn4TNvJ", "value": "1.99", "coin": "usd", "duration_ts": 2592000, "received_fiat": "1.99", "is_paid": true, "is_pending": false, "is_partial": false } }, "example": [ { "token": "Wd1lggEvyy1usHooflFiEGNQbBn4TNvJ", "value": "1.99", "coin": "usd", "duration_ts": 2592000, "received_fiat": "1.99", "is_paid": true, "is_pending": false, "is_partial": false } ] } }, "example": { "token": "J78yEgW01HIOGZqBeqzxpXFuCwHGQgdO", "url": "https://pay.blockbee.io/subscription/J78yEgW01HIOGZqBeqzxpXFuCwHGQgdO/", "active": true, "user_id": "user_example", "user_email": "example@mail.com", "end_date_ts": 1753022709, "payment_list": [ { "token": "Wd1lggEvyy1usHooflFiEGNQbBn4TNvJ", "value": "1.99", "coin": "usd", "duration_ts": 2592000, "received_fiat": "1.99", "is_paid": true, "is_pending": false, "is_partial": false } ] } } }, "example": { "status": "success", "subscription": { "token": "J78yEgW01HIOGZqBeqzxpXFuCwHGQgdO", "url": "https://pay.blockbee.io/subscription/J78yEgW01HIOGZqBeqzxpXFuCwHGQgdO/", "active": true, "user_id": "user_example", "user_email": "example@mail.com", "end_date_ts": 1753022709, "payment_list": [ { "token": "Wd1lggEvyy1usHooflFiEGNQbBn4TNvJ", "value": "1.99", "coin": "usd", "duration_ts": 2592000, "received_fiat": "1.99", "is_paid": true, "is_pending": false, "is_partial": false } ] } } } } } } } } }, "/{ticker}/info/": { "get": { "operationId": "get_ticker_info", "summary": "Get Ticker Information", "description": "This method allows you to get information for a specific `ticker`.\n**Notes:** * If the `prices` parameter is sent, the prices will be included in the response.", "tags": [ "Utilities" ], "externalDocs": { "description": "BlockBee docs page", "url": "https://docs.blockbee.io/api/get-ticker-info" }, "parameters": [ { "name": "ticker", "in": "path", "required": true, "description": "Path parameter (string)", "schema": { "type": "string", "example": "btc" } }, { "name": "apikey", "in": "query", "required": true, "description": "Query parameter (string)", "schema": { "type": "string", "example": "your_api_key_here" } }, { "name": "prices", "in": "query", "required": false, "description": "Query parameter (integer)", "schema": { "type": "integer", "example": "1" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "coin": { "type": "string", "example": "Bitcoin" }, "logo": { "type": "string", "example": "https://api.cryptapi.io/media/token_logos/btc.png" }, "ticker": { "type": "string", "example": "btc" }, "minimum_transaction": { "type": "integer", "example": 8000 }, "minimum_transaction_coin": { "type": "string", "example": "0.00008000" }, "minimum_fee": { "type": "integer", "example": 546 }, "minimum_fee_coin": { "type": "string", "example": "0.00000546" }, "fee_percent": { "type": "string", "example": "1.000" }, "network_fee_estimation": { "type": "string", "example": "0.00000213" }, "status": { "type": "string", "example": "success" }, "prices": { "type": "object", "additionalProperties": { "type": "string" }, "example": { "AED": "396670.6487738357", "AUD": "164918.3815821888", "BGN": "179415.3514938429", "BRL": "590043.3174856082", "CAD": "147390.5225671536", "CHF": "85663.8443900161", "CNY": "774067.3699410238", "COP": "435055971.0023019300", "CZK": "2265202.0635145637", "DKK": "685208.4835369790", "EUR": "91836.4258114617", "GBP": "79525.4974900668", "HKD": "847743.9480314957", "HUF": "36795946.8818968000", "IDR": "1752476212.5931296000", "INR": "9252608.6186747890", "JPY": "15553782.2703022100", "LKR": "32387917.7777397400", "MXN": "2031288.3776691742", "MYR": "456712.2757241769", "NGN": "165449934.6265569600", "NOK": "1093143.9098128967", "PHP": "6089640.4634586780", "PLN": "391876.4118251008", "RON": "465157.5109953081", "RUB": "8509597.1435057820", "SEK": "1032104.0819723385", "SGD": "137643.4035211648", "THB": "3502342.6344668176", "TRY": "4296777.8167729120", "TWD": "3136159.8249985916", "UAH": "4508904.8475288930", "UGX": "388339955.9410019500", "USD": "107995.3359480198", "VND": "2825993400.1024604000", "ZAR": "1907272.4736099340" } }, "prices_updated": { "type": "string", "example": "2025-07-02T14:15:17.955Z" } }, "example": { "coin": "Bitcoin", "logo": "https://api.cryptapi.io/media/token_logos/btc.png", "ticker": "btc", "minimum_transaction": 8000, "minimum_transaction_coin": "0.00008000", "minimum_fee": 546, "minimum_fee_coin": "0.00000546", "fee_percent": "1.000", "network_fee_estimation": "0.00000213", "status": "success", "prices": { "AED": "396670.6487738357", "AUD": "164918.3815821888", "BGN": "179415.3514938429", "BRL": "590043.3174856082", "CAD": "147390.5225671536", "CHF": "85663.8443900161", "CNY": "774067.3699410238", "COP": "435055971.0023019300", "CZK": "2265202.0635145637", "DKK": "685208.4835369790", "EUR": "91836.4258114617", "GBP": "79525.4974900668", "HKD": "847743.9480314957", "HUF": "36795946.8818968000", "IDR": "1752476212.5931296000", "INR": "9252608.6186747890", "JPY": "15553782.2703022100", "LKR": "32387917.7777397400", "MXN": "2031288.3776691742", "MYR": "456712.2757241769", "NGN": "165449934.6265569600", "NOK": "1093143.9098128967", "PHP": "6089640.4634586780", "PLN": "391876.4118251008", "RON": "465157.5109953081", "RUB": "8509597.1435057820", "SEK": "1032104.0819723385", "SGD": "137643.4035211648", "THB": "3502342.6344668176", "TRY": "4296777.8167729120", "TWD": "3136159.8249985916", "UAH": "4508904.8475288930", "UGX": "388339955.9410019500", "USD": "107995.3359480198", "VND": "2825993400.1024604000", "ZAR": "1907272.4736099340" }, "prices_updated": "2025-07-02T14:15:17.955Z" } } } } } } } }, "/{ticker}/payout/address/": { "get": { "operationId": "get_wallet_address", "summary": "Get Address", "description": "Using this endpoint you can fetch the Payout Wallet address for your API Key and the `ticker` provided.", "tags": [ "Self-Custodial Wallet" ], "externalDocs": { "description": "BlockBee docs page", "url": "https://docs.blockbee.io/api/get-wallet-address" }, "parameters": [ { "name": "ticker", "in": "path", "required": true, "description": "Path parameter (string)", "schema": { "type": "string", "example": "btc" } }, { "name": "apikey", "in": "query", "required": true, "description": "Query parameter (string)", "schema": { "type": "string", "example": "your_api_key_here" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "success" }, "address": { "type": "string", "example": "0x18B211A1Ba5880C7d62C250B6441C2400d588589" } }, "example": { "status": "success", "address": "0x18B211A1Ba5880C7d62C250B6441C2400d588589" } } } } } } } }, "/{ticker}/payout/balance/": { "get": { "operationId": "get_wallet_balance", "summary": "Get Self-Custodial Wallet Balance", "description": "Using this endpoint you can fetch the Payout Wallet balance for your API Key and the `ticker` provided.", "tags": [ "Self-Custodial Wallet" ], "externalDocs": { "description": "BlockBee docs page", "url": "https://docs.blockbee.io/api/get-wallet-balance" }, "parameters": [ { "name": "ticker", "in": "path", "required": true, "description": "Path parameter (string)", "schema": { "type": "string", "example": "btc" } }, { "name": "apikey", "in": "query", "required": true, "description": "Query parameter (string)", "schema": { "type": "string", "example": "your_api_key_here" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "success" }, "balance": { "type": "string", "example": "0.12345678" } }, "example": { "status": "success", "balance": "0.12345678" } } } } } } } }, "/checkout/list/": { "get": { "operationId": "list_checkouts", "summary": "List Checkout Payments", "description": "List checkout payment requests for a profile.", "tags": [ "Payments Checkout" ], "externalDocs": { "description": "BlockBee docs page", "url": "https://docs.blockbee.io/api/list-checkouts" }, "parameters": [ { "name": "apikey", "in": "query", "required": true, "description": "Query parameter (string)", "schema": { "type": "string", "example": "your_api_key_here" } }, { "name": "from", "in": "query", "required": false, "description": "Query parameter (string)", "schema": { "type": "string", "example": "1672531200" } }, { "name": "to", "in": "query", "required": false, "description": "Query parameter (string)", "schema": { "type": "string", "example": "1704067199" } }, { "name": "status", "in": "query", "required": false, "description": "Query parameter (string)", "schema": { "type": "string", "example": "paid" } }, { "name": "page", "in": "query", "required": false, "description": "Query parameter (integer)", "schema": { "type": "integer", "example": "1" } }, { "name": "per_page", "in": "query", "required": false, "description": "Query parameter (integer)", "schema": { "type": "integer", "example": "25" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "success" }, "data": { "type": "array", "items": { "type": "object", "properties": { "payment_id": { "type": "string", "example": "fG78jtx96ugjtu0eIbeLmFB9z0feJf9N" }, "value": { "type": "string", "example": "10" }, "currency": { "type": "string", "example": "usd" }, "status": { "type": "string", "example": "paid" }, "created_at": { "type": "string", "example": "2023-05-15T10:00:00Z" } }, "example": { "payment_id": "fG78jtx96ugjtu0eIbeLmFB9z0feJf9N", "value": "10", "currency": "usd", "status": "paid", "created_at": "2023-05-15T10:00:00Z" } }, "example": [ { "payment_id": "fG78jtx96ugjtu0eIbeLmFB9z0feJf9N", "value": "10", "currency": "usd", "status": "paid", "created_at": "2023-05-15T10:00:00Z" } ] } }, "example": { "status": "success", "data": [ { "payment_id": "fG78jtx96ugjtu0eIbeLmFB9z0feJf9N", "value": "10", "currency": "usd", "status": "paid", "created_at": "2023-05-15T10:00:00Z" } ] } } } } } } } }, "/deposit/list/": { "get": { "operationId": "list_deposits", "summary": "List Deposit Requests", "description": "List deposit requests for a profile.", "tags": [ "Payments Deposit" ], "externalDocs": { "description": "BlockBee docs page", "url": "https://docs.blockbee.io/api/list-deposits" }, "parameters": [ { "name": "apikey", "in": "query", "required": true, "description": "Query parameter (string)", "schema": { "type": "string", "example": "your_api_key_here" } }, { "name": "from", "in": "query", "required": false, "description": "Query parameter (string)", "schema": { "type": "string", "example": "1672531200" } }, { "name": "to", "in": "query", "required": false, "description": "Query parameter (string)", "schema": { "type": "string", "example": "1704067199" } }, { "name": "status", "in": "query", "required": false, "description": "Query parameter (string)", "schema": { "type": "string", "example": "with_payments" } }, { "name": "page", "in": "query", "required": false, "description": "Query parameter (integer)", "schema": { "type": "integer", "example": "1" } }, { "name": "per_page", "in": "query", "required": false, "description": "Query parameter (integer)", "schema": { "type": "integer", "example": "25" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "success" }, "num_pages": { "type": "integer", "example": 1 }, "deposits": { "type": "array", "items": { "type": "object", "properties": { "token": { "type": "string", "example": "Zz87cpYde6cKDIIwn0A6oOxea2i1eGoJ" }, "value_fiat": { "type": "string", "example": "2.999478000000000000" }, "payment_list": { "type": "array", "items": { "type": "object", "properties": { "txid": { "type": "string", "example": "0xd9f11104a96c0d89404ed8736c7382939185b9520a23768c648ac718cf9c7885" }, "value": { "type": "string", "example": "1.000000000000000000" }, "value_fiat": { "type": "string", "example": "1.000000000000000000" }, "coin": { "type": "string", "example": "polygon_usdt" }, "timestamp": { "type": "string", "example": "2026-01-28T17:04:21.590Z" } }, "example": { "txid": "0xd9f11104a96c0d89404ed8736c7382939185b9520a23768c648ac718cf9c7885", "value": "1.000000000000000000", "value_fiat": "1.000000000000000000", "coin": "polygon_usdt", "timestamp": "2026-01-28T17:04:21.590Z" } }, "example": [ { "txid": "0xd9f11104a96c0d89404ed8736c7382939185b9520a23768c648ac718cf9c7885", "value": "1.000000000000000000", "value_fiat": "1.000000000000000000", "coin": "polygon_usdt", "timestamp": "2026-01-28T17:04:21.590Z" } ] }, "currency": { "type": "string", "example": "usd" }, "timestamp": { "type": "string", "example": "2025-11-24T14:13:51.101Z" } }, "example": { "token": "Zz87cpYde6cKDIIwn0A6oOxea2i1eGoJ", "value_fiat": "2.999478000000000000", "payment_list": [ { "txid": "0xd9f11104a96c0d89404ed8736c7382939185b9520a23768c648ac718cf9c7885", "value": "1.000000000000000000", "value_fiat": "1.000000000000000000", "coin": "polygon_usdt", "timestamp": "2026-01-28T17:04:21.590Z" } ], "currency": "usd", "timestamp": "2025-11-24T14:13:51.101Z" } }, "example": [ { "token": "Zz87cpYde6cKDIIwn0A6oOxea2i1eGoJ", "value_fiat": "2.999478000000000000", "payment_list": [ { "txid": "0xd9f11104a96c0d89404ed8736c7382939185b9520a23768c648ac718cf9c7885", "value": "1.000000000000000000", "value_fiat": "1.000000000000000000", "coin": "polygon_usdt", "timestamp": "2026-01-28T17:04:21.590Z" } ], "currency": "usd", "timestamp": "2025-11-24T14:13:51.101Z" } ] } }, "example": { "status": "success", "num_pages": 1, "deposits": [ { "token": "Zz87cpYde6cKDIIwn0A6oOxea2i1eGoJ", "value_fiat": "2.999478000000000000", "payment_list": [ { "txid": "0xd9f11104a96c0d89404ed8736c7382939185b9520a23768c648ac718cf9c7885", "value": "1.000000000000000000", "value_fiat": "1.000000000000000000", "coin": "polygon_usdt", "timestamp": "2026-01-28T17:04:21.590Z" } ], "currency": "usd", "timestamp": "2025-11-24T14:13:51.101Z" } ] } } } } } } } }, "/{ticker}/payout/request/list/": { "get": { "operationId": "list_payout_requests", "summary": "List Payout Requests", "description": "This method allows you to list payout requests for a specific ticker.", "tags": [ "Payout Requests" ], "externalDocs": { "description": "BlockBee docs page", "url": "https://docs.blockbee.io/api/list-payout-requests" }, "parameters": [ { "name": "ticker", "in": "path", "required": true, "description": "Path parameter (string)", "schema": { "type": "string", "example": "btc" } }, { "name": "apikey", "in": "query", "required": true, "description": "Query parameter (string)", "schema": { "type": "string", "example": "your_api_key_here" } }, { "name": "status", "in": "query", "required": false, "description": "Query parameter (string)", "schema": { "type": "string", "example": "all" } }, { "name": "p", "in": "query", "required": false, "description": "Query parameter (number)", "schema": { "type": "integer", "example": "1" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "success" }, "payout_requests": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "7f839bdd-5acd-4ce3-984d-1be8357b642d" }, "address": { "type": "string", "example": "1H6ZZpRmMnrw8ytepV3BYwMjYYnEkWDqVP" }, "value": { "type": "string", "example": "0.001" }, "status": { "type": "string", "example": "pending" }, "created_at": { "type": "string", "example": "2024-03-12T14:40:11Z" } }, "example": { "id": "7f839bdd-5acd-4ce3-984d-1be8357b642d", "address": "1H6ZZpRmMnrw8ytepV3BYwMjYYnEkWDqVP", "value": "0.001", "status": "pending", "created_at": "2024-03-12T14:40:11Z" } }, "example": [ { "id": "7f839bdd-5acd-4ce3-984d-1be8357b642d", "address": "1H6ZZpRmMnrw8ytepV3BYwMjYYnEkWDqVP", "value": "0.001", "status": "pending", "created_at": "2024-03-12T14:40:11Z" } ] } }, "example": { "status": "success", "payout_requests": [ { "id": "7f839bdd-5acd-4ce3-984d-1be8357b642d", "address": "1H6ZZpRmMnrw8ytepV3BYwMjYYnEkWDqVP", "value": "0.001", "status": "pending", "created_at": "2024-03-12T14:40:11Z" } ] } } } } } } } }, "/{ticker}/payout/list/": { "get": { "operationId": "list_payouts", "summary": "List Payouts", "description": "Using this endpoint you can fetch the Payout created for your API Key and the `ticker` provided. **Notes:** * This endpoint will list only the **Payout**, which is an aggregation of the **Payout Requests**. * This endpoint is paginated and will show only `50` Payout Requests per page.", "tags": [ "Payouts" ], "externalDocs": { "description": "BlockBee docs page", "url": "https://docs.blockbee.io/api/list-payouts" }, "parameters": [ { "name": "ticker", "in": "path", "required": true, "description": "Path parameter (string)", "schema": { "type": "string", "example": "btc" } }, { "name": "apikey", "in": "query", "required": true, "description": "Query parameter (string)", "schema": { "type": "string", "example": "your_api_key_here" } }, { "name": "status", "in": "query", "required": false, "description": "Query parameter (string)", "schema": { "type": "string", "example": "done" } }, { "name": "p", "in": "query", "required": false, "description": "Query parameter (number)", "schema": { "type": "integer", "example": "1" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "success" }, "payouts": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "ccaf7868-2219-4dad-b0f7-d6e3a362b26f" }, "status": { "type": "string", "example": "done" }, "display_status": { "type": "string", "example": "Done" }, "total_requested": { "type": "string", "example": "0.1" }, "total_requested_fiat": { "type": "string", "example": "0.1" }, "total_with_fee": { "type": "string", "example": "0.1005" }, "total_with_fee_fiat": { "type": "string", "example": "0.1" }, "error": { "type": [ "string", "null" ] }, "blockchain_fee": { "type": "string", "example": "0.000024738630000000" }, "fee": { "type": "string", "example": "0.0005" }, "coin": { "type": "string", "example": "bep20_usdt" }, "timestamp": { "type": "string", "example": "10/07/2025 17:03:52" } }, "example": { "id": "ccaf7868-2219-4dad-b0f7-d6e3a362b26f", "status": "done", "display_status": "Done", "total_requested": "0.1", "total_requested_fiat": "0.1", "total_with_fee": "0.1005", "total_with_fee_fiat": "0.1", "error": null, "blockchain_fee": "0.000024738630000000", "fee": "0.0005", "coin": "bep20_usdt", "timestamp": "10/07/2025 17:03:52" } }, "example": [ { "id": "ccaf7868-2219-4dad-b0f7-d6e3a362b26f", "status": "done", "display_status": "Done", "total_requested": "0.1", "total_requested_fiat": "0.1", "total_with_fee": "0.1005", "total_with_fee_fiat": "0.1", "error": null, "blockchain_fee": "0.000024738630000000", "fee": "0.0005", "coin": "bep20_usdt", "timestamp": "10/07/2025 17:03:52" } ] }, "num_pages": { "type": "integer", "example": 1 } }, "example": { "status": "success", "payouts": [ { "id": "ccaf7868-2219-4dad-b0f7-d6e3a362b26f", "status": "done", "display_status": "Done", "total_requested": "0.1", "total_requested_fiat": "0.1", "total_with_fee": "0.1005", "total_with_fee_fiat": "0.1", "error": null, "blockchain_fee": "0.000024738630000000", "fee": "0.0005", "coin": "bep20_usdt", "timestamp": "10/07/2025 17:03:52" } ], "num_pages": 1 } } } } } } } }, "/subscription/list/": { "get": { "operationId": "list_subscriptions", "summary": "List Subscriptions", "description": "This method allows you to list all subscriptions.", "tags": [ "Subscriptions" ], "externalDocs": { "description": "BlockBee docs page", "url": "https://docs.blockbee.io/api/list-subscriptions" }, "parameters": [ { "name": "apikey", "in": "query", "required": true, "description": "Query parameter (string)", "schema": { "type": "string", "example": "your_api_key_here" } }, { "name": "p", "in": "query", "required": false, "description": "Query parameter (integer)", "schema": { "type": "integer", "example": "1" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "success" }, "subscriptions": { "type": "array", "items": { "type": "object", "properties": { "token": { "type": "string", "example": "J78yEgW01HIOGZqBeqzxpXFuCwHGQgdO" }, "url": { "type": "string", "example": "https://pay.blockbee.io/subscription/J78yEgW01HIOGZqBeqzxpXFuCwHGQgdO/" }, "active": { "type": "boolean", "example": true }, "user_id": { "type": "string", "example": "user_example" }, "user_email": { "type": "string", "example": "example@mail.com" }, "end_date_ts": { "type": "integer", "example": 1753022709 }, "payment_list": { "type": "array", "items": { "type": "object", "properties": { "token": { "type": "string", "example": "Wd1lggEvyy1usHooflFiEGNQbBn4TNvJ" }, "value": { "type": "string", "example": "1.99" }, "coin": { "type": "string", "example": "usd" }, "duration_ts": { "type": "integer", "example": 2592000 }, "received_fiat": { "type": "string", "example": "1.99" }, "is_paid": { "type": "boolean", "example": true }, "is_pending": { "type": "boolean", "example": false }, "is_partial": { "type": "boolean", "example": false } }, "example": { "token": "Wd1lggEvyy1usHooflFiEGNQbBn4TNvJ", "value": "1.99", "coin": "usd", "duration_ts": 2592000, "received_fiat": "1.99", "is_paid": true, "is_pending": false, "is_partial": false } }, "example": [ { "token": "Wd1lggEvyy1usHooflFiEGNQbBn4TNvJ", "value": "1.99", "coin": "usd", "duration_ts": 2592000, "received_fiat": "1.99", "is_paid": true, "is_pending": false, "is_partial": false } ] } }, "example": { "token": "J78yEgW01HIOGZqBeqzxpXFuCwHGQgdO", "url": "https://pay.blockbee.io/subscription/J78yEgW01HIOGZqBeqzxpXFuCwHGQgdO/", "active": true, "user_id": "user_example", "user_email": "example@mail.com", "end_date_ts": 1753022709, "payment_list": [ { "token": "Wd1lggEvyy1usHooflFiEGNQbBn4TNvJ", "value": "1.99", "coin": "usd", "duration_ts": 2592000, "received_fiat": "1.99", "is_paid": true, "is_pending": false, "is_partial": false } ] } }, "example": [ { "token": "J78yEgW01HIOGZqBeqzxpXFuCwHGQgdO", "url": "https://pay.blockbee.io/subscription/J78yEgW01HIOGZqBeqzxpXFuCwHGQgdO/", "active": true, "user_id": "user_example", "user_email": "example@mail.com", "end_date_ts": 1753022709, "payment_list": [ { "token": "Wd1lggEvyy1usHooflFiEGNQbBn4TNvJ", "value": "1.99", "coin": "usd", "duration_ts": 2592000, "received_fiat": "1.99", "is_paid": true, "is_pending": false, "is_partial": false } ] } ] }, "num_pages": { "type": "integer", "example": 1 } }, "example": { "status": "success", "subscriptions": [ { "token": "J78yEgW01HIOGZqBeqzxpXFuCwHGQgdO", "url": "https://pay.blockbee.io/subscription/J78yEgW01HIOGZqBeqzxpXFuCwHGQgdO/", "active": true, "user_id": "user_example", "user_email": "example@mail.com", "end_date_ts": 1753022709, "payment_list": [ { "token": "Wd1lggEvyy1usHooflFiEGNQbBn4TNvJ", "value": "1.99", "coin": "usd", "duration_ts": 2592000, "received_fiat": "1.99", "is_paid": true, "is_pending": false, "is_partial": false } ] } ], "num_pages": 1 } } } } } } } }, "/btc/list/": { "get": { "operationId": "list_transactions", "summary": "List API Transactions", "description": "List API transactions for one specific coin or context.", "tags": [ "Utilities" ], "externalDocs": { "description": "BlockBee docs page", "url": "https://docs.blockbee.io/api/list-transactions" }, "parameters": [ { "name": "apikey", "in": "query", "required": true, "description": "Query parameter (string)", "schema": { "type": "string", "example": "your_api_key_here" } }, { "name": "from", "in": "query", "required": false, "description": "Query parameter (string)", "schema": { "type": "string", "example": "1672531200" } }, { "name": "to", "in": "query", "required": false, "description": "Query parameter (string)", "schema": { "type": "string", "example": "1704067199" } }, { "name": "page", "in": "query", "required": false, "description": "Query parameter (integer)", "schema": { "type": "integer", "example": "1" } }, { "name": "per_page", "in": "query", "required": false, "description": "Query parameter (integer)", "schema": { "type": "integer", "example": "25" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "success" }, "data": { "type": "array", "items": { "type": "object", "properties": { "txid": { "type": "string", "example": "7b47b4d1b09b5c3e602781b0ed82052dc6..." }, "address": { "type": "string", "example": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa" }, "value": { "type": "string", "example": "0.01000000" }, "created_at": { "type": "string", "example": "2023-05-15T10:00:00Z" } }, "example": { "txid": "7b47b4d1b09b5c3e602781b0ed82052dc6...", "address": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa", "value": "0.01000000", "created_at": "2023-05-15T10:00:00Z" } }, "example": [ { "txid": "7b47b4d1b09b5c3e602781b0ed82052dc6...", "address": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa", "value": "0.01000000", "created_at": "2023-05-15T10:00:00Z" } ] } }, "example": { "status": "success", "data": [ { "txid": "7b47b4d1b09b5c3e602781b0ed82052dc6...", "address": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa", "value": "0.01000000", "created_at": "2023-05-15T10:00:00Z" } ] } } } } } } } }, "/payout/process/": { "post": { "operationId": "process_payout_by_id", "summary": "Process Payout by ID", "description": "Process a payout by providing the payout ID.", "tags": [ "Payouts" ], "externalDocs": { "description": "BlockBee docs page", "url": "https://docs.blockbee.io/api/process-payout-by-id" }, "parameters": [ { "name": "apikey", "in": "query", "required": true, "description": "Query parameter (string)", "schema": { "type": "string", "example": "your_api_key_here" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "success" }, "queued": { "type": "boolean", "example": true }, "payout_info": { "type": "object", "properties": { "id": { "type": "string", "example": "ddcbab52-3fbc-478c-a103-ecdc2f0ed58c" }, "status": { "type": "string", "example": "processing" }, "display_status": { "type": "string", "example": "Pending Payment" }, "from": { "type": "string", "example": "0x18B211A1Ba5880C7d62C250B6441C2400d588589" }, "requests": { "type": "object", "properties": { "0xA6B78B56ee062185E405a1DDDD18cE8fcBC4395d": { "type": "string", "example": "0.2" } }, "example": { "0xA6B78B56ee062185E405a1DDDD18cE8fcBC4395d": "0.2" } }, "total_requested": { "type": "string", "example": "0.2" }, "total_with_fee": { "type": "string", "example": "0.201" }, "error": { "type": [ "string", "null" ] }, "blockchain_fee": { "type": "string", "example": "0E-18" }, "fee": { "type": "string", "example": "0.001" }, "coin": { "type": "string", "example": "bep20_usdt" }, "txid": { "type": "string", "example": "" }, "timestamp": { "type": "string", "example": "10/07/2025 17:01:27" } }, "example": { "id": "ddcbab52-3fbc-478c-a103-ecdc2f0ed58c", "status": "processing", "display_status": "Pending Payment", "from": "0x18B211A1Ba5880C7d62C250B6441C2400d588589", "requests": { "0xA6B78B56ee062185E405a1DDDD18cE8fcBC4395d": "0.2" }, "total_requested": "0.2", "total_with_fee": "0.201", "error": null, "blockchain_fee": "0E-18", "fee": "0.001", "coin": "bep20_usdt", "txid": "", "timestamp": "10/07/2025 17:01:27" } } }, "example": { "status": "success", "queued": true, "payout_info": { "id": "ddcbab52-3fbc-478c-a103-ecdc2f0ed58c", "status": "processing", "display_status": "Pending Payment", "from": "0x18B211A1Ba5880C7d62C250B6441C2400d588589", "requests": { "0xA6B78B56ee062185E405a1DDDD18cE8fcBC4395d": "0.2" }, "total_requested": "0.2", "total_with_fee": "0.201", "error": null, "blockchain_fee": "0E-18", "fee": "0.001", "coin": "bep20_usdt", "txid": "", "timestamp": "10/07/2025 17:01:27" } } } } } } }, "requestBody": { "required": true, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "payout_id": { "type": "string", "example": "ddcbab52-3fbc-478c-a103-ecdc2f0ed58c" } }, "required": [ "payout_id" ] } }, "application/json": { "schema": { "type": "object", "properties": { "payout_id": { "type": "string", "example": "ddcbab52-3fbc-478c-a103-ecdc2f0ed58c" } }, "required": [ "payout_id" ] } } } } } }, "/{ticker}/payout/request/bulk/process/": { "post": { "operationId": "process_payout_requests_bulk", "summary": "Process Bulk Payout Requests", "description": "This method allows you to process multiple payout requests in bulk for a specific ticker.", "tags": [ "Payout Requests" ], "externalDocs": { "description": "BlockBee docs page", "url": "https://docs.blockbee.io/api/process-payout-requests-bulk" }, "parameters": [ { "name": "ticker", "in": "path", "required": true, "description": "Path parameter (string)", "schema": { "type": "string", "example": "btc" } }, { "name": "apikey", "in": "query", "required": true, "description": "Query parameter (string)", "schema": { "type": "string", "example": "your_api_key_here" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "success" }, "queued": { "type": "boolean", "example": true }, "payout_info": { "type": "object", "properties": { "id": { "type": "string", "example": "ccaf7868-2219-4dad-b0f7-d6e3a362b26f" }, "status": { "type": "string", "example": "processing" }, "display_status": { "type": "string", "example": "Pending Payment" }, "from": { "type": "string", "example": "0x18B211A1Ba5880C7d62C250B6441C2400d588589" }, "requests": { "type": "object", "properties": { "0xA6B78B56ee062185E405a1DDDD18cE8fcBC4395d": { "type": "string", "example": "0.1" } }, "example": { "0xA6B78B56ee062185E405a1DDDD18cE8fcBC4395d": "0.1" } }, "total_requested": { "type": "string", "example": "0.1" }, "total_with_fee": { "type": "string", "example": "0.1005" }, "error": { "type": [ "string", "null" ] }, "blockchain_fee": { "type": "integer", "example": 0 }, "fee": { "type": "string", "example": "0.0005" }, "coin": { "type": "string", "example": "bep20_usdt" }, "txid": { "type": "string", "example": "" }, "timestamp": { "type": "string", "example": "10/07/2025 17:03:52" } }, "example": { "id": "ccaf7868-2219-4dad-b0f7-d6e3a362b26f", "status": "processing", "display_status": "Pending Payment", "from": "0x18B211A1Ba5880C7d62C250B6441C2400d588589", "requests": { "0xA6B78B56ee062185E405a1DDDD18cE8fcBC4395d": "0.1" }, "total_requested": "0.1", "total_with_fee": "0.1005", "error": null, "blockchain_fee": 0, "fee": "0.0005", "coin": "bep20_usdt", "txid": "", "timestamp": "10/07/2025 17:03:52" } } }, "example": { "status": "success", "queued": true, "payout_info": { "id": "ccaf7868-2219-4dad-b0f7-d6e3a362b26f", "status": "processing", "display_status": "Pending Payment", "from": "0x18B211A1Ba5880C7d62C250B6441C2400d588589", "requests": { "0xA6B78B56ee062185E405a1DDDD18cE8fcBC4395d": "0.1" }, "total_requested": "0.1", "total_with_fee": "0.1005", "error": null, "blockchain_fee": 0, "fee": "0.0005", "coin": "bep20_usdt", "txid": "", "timestamp": "10/07/2025 17:03:52" } } } } } } }, "requestBody": { "required": true, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "outputs": { "type": "string", "example": "{\"0xA6B78B56ee062185E405a1DDDD18cE8fcBC4395d\": 0.2, \"0x18B211A1Ba5880C7d62C250B6441C2400d588589\": 0.1}" } }, "required": [ "outputs" ] } }, "application/json": { "schema": { "type": "object", "properties": { "outputs": { "type": "string", "example": "{\"0xA6B78B56ee062185E405a1DDDD18cE8fcBC4395d\": 0.2, \"0x18B211A1Ba5880C7d62C250B6441C2400d588589\": 0.1}" } }, "required": [ "outputs" ] } } } } } } }, "webhooks": { "checkout-deposits-webhook": { "post": { "summary": "Checkout Deposits Webhook", "description": "Real-time webhook notifications sent when deposits are completed via BlockBee's hosted deposit solution. These webhooks notify you when a customer has successfully made a deposit to your deposit link.\n\nDelivery: GET (default — fields delivered as query parameters) or POST (set post=1 when creating the payment — fields delivered as application/x-www-form-urlencoded or JSON body). Receiver must respond with the literal body `*ok*` or HTTP 200. Signature verification: see https://docs.blockbee.io/webhooks/verify-webhook-signature", "tags": [ "Webhooks" ], "externalDocs": { "description": "Webhook docs page", "url": "https://docs.blockbee.io/webhooks/checkout-deposits-webhook" }, "requestBody": { "required": true, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "payment_id": { "type": "string", "example": "fG78jtx96ugjtu0eIbeLmFB9z0feJf9N" }, "payment_url": { "type": "string", "example": "https://pay.blockbee.io/deposit/fG78jtx96ugjtu0eIbeLmFB9z0feJf9N" }, "uuid": { "type": "string", "example": "afe11bea-768b-47ae-ba0f-907379fbe5ef" }, "txid": { "type": "string", "example": "0xa7551df44e487f9c0507d68d90193cde2604dfcefdc975bae54535a2e0f80b32" }, "address": { "type": "string", "example": "3PFoGK63cVVUWnd2vu7W1kM83NXUfvzMqM" }, "currency": { "type": "string", "example": "usd" }, "paid_amount": { "type": "string", "example": "1.23" }, "received_amount": { "type": "string", "example": "9.24" }, "paid_amount_fiat": { "type": "string", "example": "21234.32" }, "received_amount_fiat": { "type": "string", "example": "9.24" }, "paid_coin": { "type": "string", "example": "btc" }, "exchange_rate": { "type": "integer", "example": 20000 }, "type": { "type": "string", "example": "deposit" }, "customer_name": { "type": "string", "example": "John Doe" }, "customer_email": { "type": "string", "example": "example@mail.com" }, "status": { "type": "string", "example": "done" } }, "example": { "payment_id": "fG78jtx96ugjtu0eIbeLmFB9z0feJf9N", "payment_url": "https://pay.blockbee.io/deposit/fG78jtx96ugjtu0eIbeLmFB9z0feJf9N", "uuid": "afe11bea-768b-47ae-ba0f-907379fbe5ef", "txid": "0xa7551df44e487f9c0507d68d90193cde2604dfcefdc975bae54535a2e0f80b32", "address": "3PFoGK63cVVUWnd2vu7W1kM83NXUfvzMqM", "currency": "usd", "paid_amount": "1.23", "received_amount": "9.24", "paid_amount_fiat": "21234.32", "received_amount_fiat": "9.24", "paid_coin": "btc", "exchange_rate": 20000, "type": "deposit", "customer_name": "John Doe", "customer_email": "example@mail.com", "status": "done" } } }, "application/json": { "schema": { "type": "object", "properties": { "payment_id": { "type": "string", "example": "fG78jtx96ugjtu0eIbeLmFB9z0feJf9N" }, "payment_url": { "type": "string", "example": "https://pay.blockbee.io/deposit/fG78jtx96ugjtu0eIbeLmFB9z0feJf9N" }, "uuid": { "type": "string", "example": "afe11bea-768b-47ae-ba0f-907379fbe5ef" }, "txid": { "type": "string", "example": "0xa7551df44e487f9c0507d68d90193cde2604dfcefdc975bae54535a2e0f80b32" }, "address": { "type": "string", "example": "3PFoGK63cVVUWnd2vu7W1kM83NXUfvzMqM" }, "currency": { "type": "string", "example": "usd" }, "paid_amount": { "type": "string", "example": "1.23" }, "received_amount": { "type": "string", "example": "9.24" }, "paid_amount_fiat": { "type": "string", "example": "21234.32" }, "received_amount_fiat": { "type": "string", "example": "9.24" }, "paid_coin": { "type": "string", "example": "btc" }, "exchange_rate": { "type": "integer", "example": 20000 }, "type": { "type": "string", "example": "deposit" }, "customer_name": { "type": "string", "example": "John Doe" }, "customer_email": { "type": "string", "example": "example@mail.com" }, "status": { "type": "string", "example": "done" } }, "example": { "payment_id": "fG78jtx96ugjtu0eIbeLmFB9z0feJf9N", "payment_url": "https://pay.blockbee.io/deposit/fG78jtx96ugjtu0eIbeLmFB9z0feJf9N", "uuid": "afe11bea-768b-47ae-ba0f-907379fbe5ef", "txid": "0xa7551df44e487f9c0507d68d90193cde2604dfcefdc975bae54535a2e0f80b32", "address": "3PFoGK63cVVUWnd2vu7W1kM83NXUfvzMqM", "currency": "usd", "paid_amount": "1.23", "received_amount": "9.24", "paid_amount_fiat": "21234.32", "received_amount_fiat": "9.24", "paid_coin": "btc", "exchange_rate": 20000, "type": "deposit", "customer_name": "John Doe", "customer_email": "example@mail.com", "status": "done" } } } } }, "responses": { "200": { "description": "Acknowledgement. Body must be the literal string `*ok*` (BlockBee retries otherwise).", "content": { "text/plain": { "schema": { "type": "string", "enum": [ "*ok*" ], "example": "*ok*" } } } } } } }, "checkout-payments-webhook": { "post": { "summary": "Checkout Payments Webhook", "description": "Real-time webhook notifications sent when payments are completed via BlockBee's hosted checkout solution. These webhooks notify you when a customer has successfully paid for their order.\n\nDelivery: GET (default — fields delivered as query parameters) or POST (set post=1 when creating the payment — fields delivered as application/x-www-form-urlencoded or JSON body). Receiver must respond with the literal body `*ok*` or HTTP 200. Signature verification: see https://docs.blockbee.io/webhooks/verify-webhook-signature", "tags": [ "Webhooks" ], "externalDocs": { "description": "Webhook docs page", "url": "https://docs.blockbee.io/webhooks/checkout-payments-webhook" }, "requestBody": { "required": true, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "payment_id": { "type": "string", "example": "fG78jtx96ugjtu0eIbeLmFB9z0feJf9N" }, "payment_url": { "type": "string", "example": "https://pay.blockbee.io/payment/fG78jtx96ugjtu0eIbeLmFB9z0feJf9N" }, "redirect_url": { "type": "string", "example": "https://example.com/success/?order_id=12345" }, "value": { "type": "integer", "example": 20000 }, "currency": { "type": "string", "example": "usd" }, "is_paid": { "type": "string", "example": "1" }, "paid_amount": { "type": "string", "example": "1.23" }, "paid_amount_fiat": { "type": "string", "example": "21234.32" }, "received_amount": { "type": "string", "example": "9.24" }, "received_amount_fiat": { "type": "string", "example": "9.24" }, "paid_coin": { "type": "string", "example": "btc" }, "exchange_rate": { "type": "integer", "example": 20000 }, "txid": { "type": "string", "example": "0xa7551df44e487f9c0507d68d90193cde2604dfcefdc975bae54535a2e0f80b32,0x6e8b278e3db1948d2c694b7f709dd4e864ae80d516970ebfd05a98629b6efe15" }, "address": { "type": "string", "example": "3PFoGK63cVVUWnd2vu7W1kM83NXUfvzMqM" }, "type": { "type": "string", "example": "payment" }, "customer_name": { "type": "string", "example": "John Doe" }, "customer_email": { "type": "string", "example": "example@mail.com" }, "status": { "type": "string", "example": "done" } }, "example": { "payment_id": "fG78jtx96ugjtu0eIbeLmFB9z0feJf9N", "payment_url": "https://pay.blockbee.io/payment/fG78jtx96ugjtu0eIbeLmFB9z0feJf9N", "redirect_url": "https://example.com/success/?order_id=12345", "value": 20000, "currency": "usd", "is_paid": "1", "paid_amount": "1.23", "paid_amount_fiat": "21234.32", "received_amount": "9.24", "received_amount_fiat": "9.24", "paid_coin": "btc", "exchange_rate": 20000, "txid": "0xa7551df44e487f9c0507d68d90193cde2604dfcefdc975bae54535a2e0f80b32,0x6e8b278e3db1948d2c694b7f709dd4e864ae80d516970ebfd05a98629b6efe15", "address": "3PFoGK63cVVUWnd2vu7W1kM83NXUfvzMqM", "type": "payment", "customer_name": "John Doe", "customer_email": "example@mail.com", "status": "done" } } }, "application/json": { "schema": { "type": "object", "properties": { "payment_id": { "type": "string", "example": "fG78jtx96ugjtu0eIbeLmFB9z0feJf9N" }, "payment_url": { "type": "string", "example": "https://pay.blockbee.io/payment/fG78jtx96ugjtu0eIbeLmFB9z0feJf9N" }, "redirect_url": { "type": "string", "example": "https://example.com/success/?order_id=12345" }, "value": { "type": "integer", "example": 20000 }, "currency": { "type": "string", "example": "usd" }, "is_paid": { "type": "string", "example": "1" }, "paid_amount": { "type": "string", "example": "1.23" }, "paid_amount_fiat": { "type": "string", "example": "21234.32" }, "received_amount": { "type": "string", "example": "9.24" }, "received_amount_fiat": { "type": "string", "example": "9.24" }, "paid_coin": { "type": "string", "example": "btc" }, "exchange_rate": { "type": "integer", "example": 20000 }, "txid": { "type": "string", "example": "0xa7551df44e487f9c0507d68d90193cde2604dfcefdc975bae54535a2e0f80b32,0x6e8b278e3db1948d2c694b7f709dd4e864ae80d516970ebfd05a98629b6efe15" }, "address": { "type": "string", "example": "3PFoGK63cVVUWnd2vu7W1kM83NXUfvzMqM" }, "type": { "type": "string", "example": "payment" }, "customer_name": { "type": "string", "example": "John Doe" }, "customer_email": { "type": "string", "example": "example@mail.com" }, "status": { "type": "string", "example": "done" } }, "example": { "payment_id": "fG78jtx96ugjtu0eIbeLmFB9z0feJf9N", "payment_url": "https://pay.blockbee.io/payment/fG78jtx96ugjtu0eIbeLmFB9z0feJf9N", "redirect_url": "https://example.com/success/?order_id=12345", "value": 20000, "currency": "usd", "is_paid": "1", "paid_amount": "1.23", "paid_amount_fiat": "21234.32", "received_amount": "9.24", "received_amount_fiat": "9.24", "paid_coin": "btc", "exchange_rate": 20000, "txid": "0xa7551df44e487f9c0507d68d90193cde2604dfcefdc975bae54535a2e0f80b32,0x6e8b278e3db1948d2c694b7f709dd4e864ae80d516970ebfd05a98629b6efe15", "address": "3PFoGK63cVVUWnd2vu7W1kM83NXUfvzMqM", "type": "payment", "customer_name": "John Doe", "customer_email": "example@mail.com", "status": "done" } } } } }, "responses": { "200": { "description": "Acknowledgement. Body must be the literal string `*ok*` (BlockBee retries otherwise).", "content": { "text/plain": { "schema": { "type": "string", "enum": [ "*ok*" ], "example": "*ok*" } } } } } } }, "custom-payment-flow-webhooks": { "post": { "summary": "Custom Payment Flow Webhooks", "description": "Real-time webhook notifications sent when payments are received via custom payment flow. BlockBee sends two types of webhooks: pending (payment detected) and confirmed (payment verified).\n\nDelivery: GET (default — fields delivered as query parameters) or POST (set post=1 when creating the payment — fields delivered as application/x-www-form-urlencoded or JSON body). Receiver must respond with the literal body `*ok*` or HTTP 200. Signature verification: see https://docs.blockbee.io/webhooks/verify-webhook-signature", "tags": [ "Webhooks" ], "externalDocs": { "description": "Webhook docs page", "url": "https://docs.blockbee.io/webhooks/custom-payment-flow-webhooks" }, "requestBody": { "required": true, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "uuid": { "type": "string", "example": "dbfcb40e-5a6b-4305-9fa2-b0fbda6e3ff2" }, "address_in": { "type": "string", "example": "3PFoGK63cVVUWnd2vu7W1kM83NXUfvzMqM" }, "address_out": { "type": "string", "example": "1H6ZZpRmMnrw8ytepV3BYwMjYYnEkWDqVP" }, "txid_in": { "type": "string", "example": "a2174ffd39289100709f2a07b129cdbba69df2e22e5be1830221dab1fd4e332c" }, "txid_out": { "type": "string", "example": "b3285ggd50390211820g3b18b240decbba70eg3f33f6cf2941332eab2ge5f443d" }, "confirmations": { "type": "integer", "example": 3 }, "value_coin": { "type": "number", "example": 0.05 }, "value_coin_convert": { "type": "string", "example": "{\"USD\": \"3.20\", \"EUR\": \"3.05\", \"GBP\": \"2.62\", \"CAD\": \"4.16\"}" }, "value_forwarded_coin": { "type": "number", "example": 0.0495 }, "value_forwarded_coin_convert": { "type": "string", "example": "{\"USD\": \"3.17\", \"EUR\": \"3.01\", \"GBP\": \"2.59\", \"CAD\": \"4.12\"}" }, "fee_coin": { "type": "number", "example": 0.0005 }, "coin": { "type": "string", "example": "btc" }, "price": { "type": "integer", "example": 64000 }, "pending": { "type": "integer", "example": 0 } }, "example": { "uuid": "dbfcb40e-5a6b-4305-9fa2-b0fbda6e3ff2", "address_in": "3PFoGK63cVVUWnd2vu7W1kM83NXUfvzMqM", "address_out": "1H6ZZpRmMnrw8ytepV3BYwMjYYnEkWDqVP", "txid_in": "a2174ffd39289100709f2a07b129cdbba69df2e22e5be1830221dab1fd4e332c", "txid_out": "b3285ggd50390211820g3b18b240decbba70eg3f33f6cf2941332eab2ge5f443d", "confirmations": 3, "value_coin": 0.05, "value_coin_convert": "{\"USD\": \"3.20\", \"EUR\": \"3.05\", \"GBP\": \"2.62\", \"CAD\": \"4.16\"}", "value_forwarded_coin": 0.0495, "value_forwarded_coin_convert": "{\"USD\": \"3.17\", \"EUR\": \"3.01\", \"GBP\": \"2.59\", \"CAD\": \"4.12\"}", "fee_coin": 0.0005, "coin": "btc", "price": 64000, "pending": 0 } } }, "application/json": { "schema": { "type": "object", "properties": { "uuid": { "type": "string", "example": "dbfcb40e-5a6b-4305-9fa2-b0fbda6e3ff2" }, "address_in": { "type": "string", "example": "3PFoGK63cVVUWnd2vu7W1kM83NXUfvzMqM" }, "address_out": { "type": "string", "example": "1H6ZZpRmMnrw8ytepV3BYwMjYYnEkWDqVP" }, "txid_in": { "type": "string", "example": "a2174ffd39289100709f2a07b129cdbba69df2e22e5be1830221dab1fd4e332c" }, "txid_out": { "type": "string", "example": "b3285ggd50390211820g3b18b240decbba70eg3f33f6cf2941332eab2ge5f443d" }, "confirmations": { "type": "integer", "example": 3 }, "value_coin": { "type": "number", "example": 0.05 }, "value_coin_convert": { "type": "string", "example": "{\"USD\": \"3.20\", \"EUR\": \"3.05\", \"GBP\": \"2.62\", \"CAD\": \"4.16\"}" }, "value_forwarded_coin": { "type": "number", "example": 0.0495 }, "value_forwarded_coin_convert": { "type": "string", "example": "{\"USD\": \"3.17\", \"EUR\": \"3.01\", \"GBP\": \"2.59\", \"CAD\": \"4.12\"}" }, "fee_coin": { "type": "number", "example": 0.0005 }, "coin": { "type": "string", "example": "btc" }, "price": { "type": "integer", "example": 64000 }, "pending": { "type": "integer", "example": 0 } }, "example": { "uuid": "dbfcb40e-5a6b-4305-9fa2-b0fbda6e3ff2", "address_in": "3PFoGK63cVVUWnd2vu7W1kM83NXUfvzMqM", "address_out": "1H6ZZpRmMnrw8ytepV3BYwMjYYnEkWDqVP", "txid_in": "a2174ffd39289100709f2a07b129cdbba69df2e22e5be1830221dab1fd4e332c", "txid_out": "b3285ggd50390211820g3b18b240decbba70eg3f33f6cf2941332eab2ge5f443d", "confirmations": 3, "value_coin": 0.05, "value_coin_convert": "{\"USD\": \"3.20\", \"EUR\": \"3.05\", \"GBP\": \"2.62\", \"CAD\": \"4.16\"}", "value_forwarded_coin": 0.0495, "value_forwarded_coin_convert": "{\"USD\": \"3.17\", \"EUR\": \"3.01\", \"GBP\": \"2.59\", \"CAD\": \"4.12\"}", "fee_coin": 0.0005, "coin": "btc", "price": 64000, "pending": 0 } } } } }, "responses": { "200": { "description": "Acknowledgement. Body must be the literal string `*ok*` (BlockBee retries otherwise).", "content": { "text/plain": { "schema": { "type": "string", "enum": [ "*ok*" ], "example": "*ok*" } } } } } } }, "subscriptions-webhook": { "post": { "summary": "Subscriptions Webhook", "description": "BlockBee sends webhooks to notify your application about subscription events. This includes payment notifications when users renew subscriptions and expiration notifications when subscriptions end.\n\nDelivery: GET (default — fields delivered as query parameters) or POST (set post=1 when creating the payment — fields delivered as application/x-www-form-urlencoded or JSON body). Receiver must respond with the literal body `*ok*` or HTTP 200. Signature verification: see https://docs.blockbee.io/webhooks/verify-webhook-signature", "tags": [ "Webhooks", "Subscriptions" ], "externalDocs": { "description": "Webhook docs page", "url": "https://docs.blockbee.io/webhooks/subscriptions-webhook" }, "requestBody": { "required": true, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "action": { "type": "string", "example": "renew" }, "subscription_id": { "type": "string", "example": "I55hhRINHptLJPwsqwYNxJOKBItRiq1o" }, "subscription_url": { "type": "string", "example": "https://pay.blockbee.io/subscription/I55hhRINHptLJPwsqwYNxJOKBItRiq1o" }, "subscription_start_date_ts": { "type": "integer", "example": 1718131200 }, "subscription_end_date_ts": { "type": "integer", "example": 1720723200 }, "subscription_option_slug": { "type": "string", "example": "pro-plan" }, "subscription_option_duration_ts": { "type": "integer", "example": 2592000 }, "subscription_option_value": { "type": "integer", "example": 5 }, "subscription_user_id": { "type": "string", "example": "user_123" }, "subscription_user_email": { "type": "string", "example": "user@example.com" }, "payment_url": { "type": "string", "example": "https://pay.blockbee.io/subscription/payment/ls25hhRINHptLJPwsqwYNxJOKBItRiq1o" }, "payment_redirect_url": { "type": "string", "example": "https://example.com/payment-successful" }, "payment_value": { "type": "integer", "example": 5 }, "payment_success_token": { "type": "string", "example": "sU7EGOlRRxsxJu4zZoYLa69UXrSijzb73eP6nbQQgpJYAfSL3NiI407lpYqsMbR2" }, "payment_currency": { "type": "string", "example": "usd" }, "payment_is_paid": { "type": "integer", "example": 1 }, "payment_paid_amount": { "type": "integer", "example": 5 }, "payment_paid_amount_fiat": { "type": "number", "example": 4.85 }, "payment_received_amount": { "type": "integer", "example": 5 }, "payment_received_amount_fiat": { "type": "number", "example": 4.85 }, "payment_paid_coin": { "type": "string", "example": "btc" }, "payment_exchange_rate": { "type": "number", "example": 0.97 }, "payment_txid": { "type": "string", "example": "0xa1234...,0xa5678..." }, "payment_address": { "type": "string", "example": "0xabc123..." }, "payment_type": { "type": "string", "example": "payment" }, "payment_status": { "type": "string", "example": "done" } }, "example": { "action": "renew", "subscription_id": "I55hhRINHptLJPwsqwYNxJOKBItRiq1o", "subscription_url": "https://pay.blockbee.io/subscription/I55hhRINHptLJPwsqwYNxJOKBItRiq1o", "subscription_start_date_ts": 1718131200, "subscription_end_date_ts": 1720723200, "subscription_option_slug": "pro-plan", "subscription_option_duration_ts": 2592000, "subscription_option_value": 5, "subscription_user_id": "user_123", "subscription_user_email": "user@example.com", "payment_url": "https://pay.blockbee.io/subscription/payment/ls25hhRINHptLJPwsqwYNxJOKBItRiq1o", "payment_redirect_url": "https://example.com/payment-successful", "payment_value": 5, "payment_success_token": "sU7EGOlRRxsxJu4zZoYLa69UXrSijzb73eP6nbQQgpJYAfSL3NiI407lpYqsMbR2", "payment_currency": "usd", "payment_is_paid": 1, "payment_paid_amount": 5, "payment_paid_amount_fiat": 4.85, "payment_received_amount": 5, "payment_received_amount_fiat": 4.85, "payment_paid_coin": "btc", "payment_exchange_rate": 0.97, "payment_txid": "0xa1234...,0xa5678...", "payment_address": "0xabc123...", "payment_type": "payment", "payment_status": "done" } } }, "application/json": { "schema": { "type": "object", "properties": { "action": { "type": "string", "example": "renew" }, "subscription_id": { "type": "string", "example": "I55hhRINHptLJPwsqwYNxJOKBItRiq1o" }, "subscription_url": { "type": "string", "example": "https://pay.blockbee.io/subscription/I55hhRINHptLJPwsqwYNxJOKBItRiq1o" }, "subscription_start_date_ts": { "type": "integer", "example": 1718131200 }, "subscription_end_date_ts": { "type": "integer", "example": 1720723200 }, "subscription_option_slug": { "type": "string", "example": "pro-plan" }, "subscription_option_duration_ts": { "type": "integer", "example": 2592000 }, "subscription_option_value": { "type": "integer", "example": 5 }, "subscription_user_id": { "type": "string", "example": "user_123" }, "subscription_user_email": { "type": "string", "example": "user@example.com" }, "payment_url": { "type": "string", "example": "https://pay.blockbee.io/subscription/payment/ls25hhRINHptLJPwsqwYNxJOKBItRiq1o" }, "payment_redirect_url": { "type": "string", "example": "https://example.com/payment-successful" }, "payment_value": { "type": "integer", "example": 5 }, "payment_success_token": { "type": "string", "example": "sU7EGOlRRxsxJu4zZoYLa69UXrSijzb73eP6nbQQgpJYAfSL3NiI407lpYqsMbR2" }, "payment_currency": { "type": "string", "example": "usd" }, "payment_is_paid": { "type": "integer", "example": 1 }, "payment_paid_amount": { "type": "integer", "example": 5 }, "payment_paid_amount_fiat": { "type": "number", "example": 4.85 }, "payment_received_amount": { "type": "integer", "example": 5 }, "payment_received_amount_fiat": { "type": "number", "example": 4.85 }, "payment_paid_coin": { "type": "string", "example": "btc" }, "payment_exchange_rate": { "type": "number", "example": 0.97 }, "payment_txid": { "type": "string", "example": "0xa1234...,0xa5678..." }, "payment_address": { "type": "string", "example": "0xabc123..." }, "payment_type": { "type": "string", "example": "payment" }, "payment_status": { "type": "string", "example": "done" } }, "example": { "action": "renew", "subscription_id": "I55hhRINHptLJPwsqwYNxJOKBItRiq1o", "subscription_url": "https://pay.blockbee.io/subscription/I55hhRINHptLJPwsqwYNxJOKBItRiq1o", "subscription_start_date_ts": 1718131200, "subscription_end_date_ts": 1720723200, "subscription_option_slug": "pro-plan", "subscription_option_duration_ts": 2592000, "subscription_option_value": 5, "subscription_user_id": "user_123", "subscription_user_email": "user@example.com", "payment_url": "https://pay.blockbee.io/subscription/payment/ls25hhRINHptLJPwsqwYNxJOKBItRiq1o", "payment_redirect_url": "https://example.com/payment-successful", "payment_value": 5, "payment_success_token": "sU7EGOlRRxsxJu4zZoYLa69UXrSijzb73eP6nbQQgpJYAfSL3NiI407lpYqsMbR2", "payment_currency": "usd", "payment_is_paid": 1, "payment_paid_amount": 5, "payment_paid_amount_fiat": 4.85, "payment_received_amount": 5, "payment_received_amount_fiat": 4.85, "payment_paid_coin": "btc", "payment_exchange_rate": 0.97, "payment_txid": "0xa1234...,0xa5678...", "payment_address": "0xabc123...", "payment_type": "payment", "payment_status": "done" } } } } }, "responses": { "200": { "description": "Acknowledgement. Body must be the literal string `*ok*` (BlockBee retries otherwise).", "content": { "text/plain": { "schema": { "type": "string", "enum": [ "*ok*" ], "example": "*ok*" } } } } } } } } }