List Payout Requests

View as Markdown

Using this endpoint you can fetch the Payout Requests created for your API Key and the ticker provided.

Notes:

  • This endpoint is paginated and will show only 50 Payout Requests per page.

Method: GET

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

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.

statusstring

Filter by the status of the Payout Request.

Possible statuses: all, pending, rejected, processing, done

Example:all

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.

Example:1

Returns

Returns a paginated list of payout requests.

statusstring

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

payout_requestsArray of objects

An array of payout request objects.

idstring

The ID of the Payout Request.

payout_idstring

The ID of the Payout, if a Payout was already created with this Payout Request.

coinstring

The cryptocurrency for the Payout Request.

addressstring

The Payout Request destination address.

valuestring

The amount of cryptocurrency to Payout Request.

statusstring

The status of the Payout Request.

display_statusstring

The status of the Payout Request.

timestampstring

The timestamp when the Payout Request was made.

num_pagesinteger

The number of pages of Payout Requests available.