API Key provided by BlockBee's Dashboard.

The URL the callbacks will be sent to. Must be a valid URL.

Attention:

- The callback URL should be unique. Duplicated callback URLs will return the same address_in. You can make your callback URL unique by adding GET parameters, like: ?user_id=1234

- The callback URL needs to be urlencoded, otherwise the GET parameters you add may be lost.

For a complete list of fields sent by our system, please refer to our callback documentation.

Note: To prevent repeated callbacks to your systems, the response to the callback request should be *ok* in plain text.

The address parameter is where you specify where BlockBee will forward your payment. You can enter a single address or multiple addresses if you want to split the payment to multiple addresses.

If you're using multiple addresses, you'll need to format them like this: <percentage_1>@<address_1>|<percentage_2>@<address_2> and so on. Percentages can range from 0.0001 (0.01%) to 1.0 (100%) and must add up to 1.00 (100%).

Addresses must be valid for the ticker you're using, otherwise the API will reject the payment.

By default, addresses are set in BlockBee's Dashboard, and to be able to set them in this parameter you need to enable the option "Address Override" when creating the API Key.

Note: For multiple addresses, the minimum value per transaction (see cryptocurrencies page) is multiplied by the following formula: 1 + (N - 1) / 3, where N is the number of output addresses.

For more information about multi-address minimums, check our knowledge base.

Set this to 1 if you want to be notified of pending transactions (before they're confirmed)

For a complete list of fields sent by our system, please refer to our pending callback documentation.

Note: To prevent repeated callbacks to your systems, the response to the callback request should be *ok* in plain text.

Number of blockchain confirmations you want before receiving the callback (Min. 1).

Set this to 1 if you wish to receive the callback as a POST request (default: GET).

This parameter allows users to set the priority with which funds should be forwarded to the provided address. It reflects the amount of fees paid to the blockchain network and can affect the speed of transaction confirmation. It's different per currency/network.

For more information about this parameter, check our knowledge base.

Allows customers to pay with any token supported by the system, even if the token is different from what the user initially specified.

However, you should ensure that your Wallet supports the tokens you expect clients to pay with and that your system can handle price conversions.

For example, if a user wishes to receive 1000 USDT (or equivalent) and a client sends 1000 TRX, the system should be able to handle that scenario.

Disabled by default, set this to 1 to enable it.

For more information about this parameter, check our knowledge base.

Notice: Available only for TRC-20, BEP-20, ERC-20 and POLYGON networks.

If enabled, allows you to create the same address on BEP-20, ERC-20 and POLYGON blockchains, which enables you to receive payments on BEP-20, ERC-20 and POLYGON blockchains.

However, it is important to note that this parameter only creates an address for the specified token, and if the token is not supported on the extra blockchain, the address will only be created on the selected blockchain. To avoid this from happen you must enable multi_token, and in blockchains where the token you're selecting is not supported will default for USDT.

Additionally, users should ensure that their Wallet supports both chains, as BlockBee cannot reverse any payments sent through an unsupported chain.

It can be paired with multi_token to accept any token sent by the customer, provided it's supported by our systems in the blockchain where was sent.

Disabled by default, set this to 1 to enable it.

Notice: Available only for BEP-20, ERC-20 and POLYGON chains.

For more information about this parameter, check our knowledge base.

API Key provided by BlockBee's Dashboard.

API Key provided by BlockBee's Dashboard.

API Key provided by BlockBee's Dashboard.

The payment address (address_in from our system)

Value to request the user, in the main coin (BTC, ETH, etc). Optional.

Note: Some user wallets don't support this, only the address. Use at your own discretion.

API Key provided by BlockBee's Dashboard.

The number of addresses to forward the funds to. Default: 1

API Key provided by BlockBee's Dashboard.

Value you wish to convert in the cryptocurrency/token of the ticker you are using.

This is an unique identifier to each payment your clients have made, so you can easily track any duplicate callbacks sent, in the case our system doesn't mark the callback as successful

Address where your client's payment was received

Address(es) where we forwarded your payment

Transaction hash of your client's payment

Number of confirmations of the current transaction

Value of the payment in integer. Field meant to help with precise calculations on some platforms

Notice: For some stable coins (e.g USDT or BUSD), this field always come rounded to 'cents' (two decimals), meaning you must always divide it by 100.
Example: If value=1054, 1054/100=10.54.

It's recomended to use the value_coin field instead.

Value of the payment

Converted value to various FIAT currencies of the value_coin. Response is json-encoded.

Notice: This parameter will only be shown if added the convert=1 parameter in the /create/ endpoint.

Ticker of the coin used for the payment: ['btc', 'bch', 'ltc', 'eth', 'trx']

For ERC-20 (ETH) Tokens, this parameter will be erc20_ + the ticker of the token, e.g erc20_usdt

For TRC-20 (Tron) Tokens, this parameter will be trc20_ + the ticker of the token, e.g trc20_usdt

For BEP-20 (BSC) Tokens, this parameter will be bep20_ + the ticker of the token, e.g bep20_usdt

For Polygon Tokens, this parameter will be polygon_ + the ticker of the token, e.g polygon_usdt

Coin price in USD at the time of receiving

This is an unique identifier to each payment your clients have made, so you can easily track any duplicate callbacks sent, in the case our system doesn't mark the callback as successful

Address where your client's payment was received

Address(es) where we forwarded your payment

Transaction hash of your client's payment

Transaction hash of our the payment forwarded to you

Number of confirmations of the current transaction

BlockBee fee in integer. Field meant to help with precise calculations on some platforms

Value of the payment in integer. Field meant to help with precise calculations on some platforms

Notice: For some stable coins (e.g USDT or BUSD), this field always come rounded to 'cents' (two decimals), meaning you must always divide it by 100.
Example: If value=1054, 1054/100=10.54.

It's recomended to use the value_coin field instead.

Value of the payment

Converted value to various FIAT currencies of the value_coin. Response is json-encoded.

Notice: This parameter will only be shown if added the convert=1 parameter in the /create/ endpoint.

Value forwarded to you, after fees in integer. Field meant to help with precise calculations on some platforms

Value forwarded to you, after fees

Converted value to various FIAT currencies of the value_forwarded_coin. Response is json-encoded.

Notice: This parameter will only be shown if added the convert=1 parameter in the /create/ endpoint.

BlockBee Fee

Ticker of the coin used for the payment: ['btc', 'bch', 'ltc', 'eth', 'trx']

For ERC-20 (ETH) Tokens, this parameter will be erc20_ + the ticker of the token, e.g erc20_usdt

For TRC-20 (Tron) Tokens, this parameter will be trc20_ + the ticker of the token, e.g trc20_usdt

For BEP-20 (BSC) Tokens, this parameter will be bep20_ + the ticker of the token, e.g bep20_usdt

For Polygon Tokens, this parameter will be polygon_ + the ticker of the token, e.g polygon_usdt

Coin price in USD at the time of receiving

API Key provided by BlockBee's Dashboard.

URL where your customers will be redirected to after successfully completing the payment. A success token will be added as GET parameter to this URL, together with any GET parameter you might have provided in your redirect_url, which you can use to validate that the client is coming from BlockBee.

Value of the order in the currency set in BlockBee's Dashboard payment settings.

Description of the product or service being paid. This information will appear on the checkout page.

Epoch time in seconds at which the Checkout payment will expire. Minimum is 1h. If not set, it will never expire.

Optional URL where our system will send a payment notification (IPN) when the order is paid. Similar functionality as callback_url of the base API.

For a complete list of fields sent by our system, please refer to our callback documentation.

Note: To prevent repeated callbacks to your systems, the response to the IPN request should be *ok* in plain text.

URL from the Checkout where the payment was made.

Redirect URL provided in the payment request.

Value you provided in the payment request.

Security token only known to your systems so you can make sure the order was actually paid by your customer.

FIAT currency. It will be the same that you set in BlockBee's Dashboard.

1 if the payment was completed. Can be 0 if user sent a partial payment.

Amount paid in the cryptocurrency described in the parameter paid_coin.

Cryptocurrency used to make the payment.

Exchange rate at the time of the payment.

Transaction hash(es) of your client's payment(s).

Address where your client's payment was received

API Key provided by BlockBee's Dashboard.

URL where our system will send a payment notification (IPN) when the order is paid. Similar functionality as callback_url of the base API.

For a complete list of fields sent by our system, please refer to our IPN for Deposits documentation.

Note: To prevent repeated callbacks to your systems, the response to the IPN request should be *ok* in plain text.

Description of the product or service being paid. This information will appear on the checkout page.

This is an unique identifier to each payment your clients have made, so you can easily track any duplicate callbacks sent, in the case our system doesn't mark the callback as successful.

Transaction hash(es) of your client's payment(s).

Address where your client's payment was received

URL from the Checkout where the payment was made.

FIAT currency. It will be the same that you set in BlockBee Dashboard.

Amount paid in the cryptocurrency described in the parameter paid_coin.

Amount paid in the FIAT currency described in the parameter currency.

Cryptocurrency used to make the payment.

API Key provided by BlockBee's Dashboard.

Provide the destination address for the payment or withdrawal. This is the address where you want the funds to be sent.