Create a Payout Request

View as Markdown

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, or by using BlockBee API.

Method: GET

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

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.

addressstring•Required

Provide the destination address where you want the Payout to be sent.

Example:TGfBcXvtZKxxku4X8yx92y56HdYTATKuDF

valuenumber•Required

Amount you wish to send to the provided destination address.

Example:1.34

Returns

Returns the ID of the newly created payout request.

statusstring

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

request_idstring

ID of the Payout Request.