# List Payout Requests

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

- **`ticker`** (`string`) (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](https://blockbee.io/cryptocurrencies/) page.
* Our Payouts system does not support `doge`.

### Query Parameters

- **`apikey`** (`string`) (required): API Key provided by BlockBee's [Dashboard](https://dash.blockbee.io/). Unsure how to get yours? [Check this tutorial](/kb/tutorials/dashboard/how-to-generate-a-new-api-key).

**Note:**
* The API key can also be sent as a header named `apikey`.

- **`status`** (`string`) - Example: `all`: Filter by the status of the Payout Request.

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

- **`p`** (`number`) - Example: `1`: 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 paginated list of payout requests.

- **`status`** (`string`): Status of the response. Should be success if the operation was successful.

- **`payout_requests`** (`Array of objects`): An array of payout request objects.

  - **`id`** (`string`): The ID of the Payout Request.

  - **`payout_id`** (`string`): The ID of the Payout, if a Payout was already created with this Payout Request.

  - **`coin`** (`string`): The cryptocurrency for the Payout Request.

  - **`address`** (`string`): The Payout Request destination address.

  - **`value`** (`string`): The amount of cryptocurrency to Payout Request.

  - **`status`** (`string`): The status of the Payout Request.

  - **`display_status`** (`string`): The status of the Payout Request.

  - **`timestamp`** (`string`): The timestamp when the Payout Request was made.

- **`num_pages`** (`integer`): The number of pages of Payout Requests available.



## Example Response

```json
{
  "status": "success",
  "payout_requests": [
    {
      "id": "7f839bdd-5acd-4ce3-984d-1be8357b642d",
      "address": "1H6ZZpRmMnrw8ytepV3BYwMjYYnEkWDqVP",
      "value": "0.001",
      "status": "pending",
      "created_at": "2024-03-12T14:40:11Z"
    }
  ]
}
```