List Payouts

View as Markdown

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.

Method: GET

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


Parameters

Path Parameters

tickerstringRequired

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

apikeystringRequired

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.


statusstring

Filter by the status of the Payout.


pnumber

Specify the page of the list. As this endpoint follows pagination, displaying only 50 results per page, you'll need to specify the page number to access additional results.


Returns

Returns a list of payouts.

statusstring

Status of the response. Should be success if the operation was successful.

payoutsArray of objects

An array of payout objects.

idstring

The ID of the payout.

statusstring

The status of the payout.

The verbose status of the payout.

The total cryptocurrency amount requested for the payout.

The fiat equivalent of the total amount requested, if applicable.

The total amount requested including the fee.

The fiat equivalent of the total amount with fee, if applicable.

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.

The fee paid to the blockchain for the transaction.

feestring

The fee associated with the payout.

coinstring

The cryptocurrency for the payout.

timestampstring

The timestamp when the payout was created.

num_pagesinteger

The number of pages of payout requests available.