Process Bulk Payout Requests

View as Markdown

Use this method to efficiently generate and dispatch multiple Payout Requests. This process not only facilitates the creation of one or several Payout Requests but also initiates the Payout, ensuring the automatic transfer of funds.

Method: POST

Path: https://api.blockbee.io/{ticker}/payout/request/bulk/process/

Parameters

Path Parameters

tickerstring•Required

The ticker parameter in this API request refers to the unique identifier of the cryptocurrency to which you are making the request. It is included in the URL of the request and helps to specify the exact cryptocurrency that you want to retrieve data for. The ticker is typically a short code that uniquely identifies the cryptocurrency, or the token and it's network/blockchain. For example, btc is the ticker for Bitcoin, and trc20/usdt is the ticker for USDT over TRC-20. Having this in mind, a request for USDT over TRC-20 will look like this: https://api.blockbee.io/trc20/usdt/create/.

Notes:

  • You can find all our tickers in our cryptocurrencies page.
  • Our Payouts system does not support doge.

Query Parameters

apikeystring•Required

API Key provided by BlockBee's Dashboard. Unsure how to get yours? Check this tutorial.

Note:

  • The API key can also be sent as a header named apikey.

Request Body

This endpoint requires a JSON request body with the payout requests.

JSON
{
  "outputs": {
    "0xA6B78B56ee062185E405a1DDDD18cE8fcBC4395d": 0.2,
    "0x18B211A1Ba5880C7d62C250B6441C2400d588589": 0.1
  }
}

Returns

Returns information about the created payout and its status.

statusstring

Status of the request. Should be success if the request didn't fail.

payout_infoobject

An object containing detailed information about the payout.

idstring

Unique identifier for the payout.

statusstring

The status of the Payout. Can be created, processing, done, or error.

display_statusstring

The status of the Payout. Can be Created, Pending Payment, Done, or Error.

fromstring

Source address for the payout, if applicable.

requestsobject

A mapping of destination addresses to the amount requested for each.

total_requestedstring

Total cryptocurrency amount requested.

total_with_feestring

Total cryptocurrency amount including the fee.

errorstring

The error message given in case the payout status is error.

Important Note: This parameter will only be returned if there was an error with the Payout.

blockchain_feestring

The fee paid to the blockchain for the transaction.

feestring

Fee associated with the transaction.

coinstring

Cryptocurrency ticker for the transaction.

txidstring

Transaction ID, available once the payout is fulfilled.

timestampstring

Timestamp when the payout was created.

queuedboolean

Indicates whether the payout is queued for processing.