Bulk Create Payout Requests

View as Markdown

Use this method to create multiple Payout Requests.

Notes:

  • A Payout Request represents a payment request initiated to facilitate a transaction with your customer.

Method: POST

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

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 a success message if the payout requests were created successfully.

statusstring

Status of the response, indicating the successful creation of Payout Requests.

request_idsArray of strings

An array of request IDs for the newly created Payout Requests.