---
title: "List all payouts"
method: GET
path: "/v2/payouts"
tags: ["Payouts"]
---

# List all payouts

`GET /v2/payouts`

## Request

- Base URL: `https://api.partnerstack.com/api`
- URL: `https://api.partnerstack.com/api/v2/payouts`
- Auth: HTTP bearer

Returns a list of your payouts. The payouts are returned sorted by creation date by default, with the most recent payout appearing first.

## Query parameters

- `min_created` integer
- `max_created` integer
- `order_by` '-created_at' | 'created_at'
- `limit` integer
- `starting_after` string
- `ending_before` string

## Response `200`

Returns a list of your payouts. The payouts are returned sorted by creation date by default, with the most recent payout appearing first.

- object
  - `data` object, required
    - `has_more` boolean
    - `items` object[]
      - `created_at` integer: Immutable Unix timestamp in milliseconds taken at time of creation
      - `key` string: Unique key of this payout.
      - `updated_at` integer: Unix timestamp in milliseconds taken at time of last update
      - `amount` integer: The amount of this payout in terms of total cents.
      - `currency` string: The currency used for this payout.
      - `provider` object: The details of the payment provider.
        - `external_key` string: The external unique key given by the payment provider.
        - `key` string: Unique key of the payment provider.
        - `meta` object, nullable: Metadata regarding the provider account
        - `name` 'stripe' | 'paypal' | 'airwallex' | 'manual': The name of the payment provider.
      - `sent_at` integer, nullable: The date the payout was requested to be withdrawn in epoch time (ms).
      - `status` 'new' | 'in_review' | 'ready' | 'pending' | 'successful' | 'failed' | 'cancelled' | 'conversion_in_queue' | 'conversion_pending' | 'conversion_successful' | 'calculation_in_review': The status of this payout.
      - `withdrawal_date` integer, nullable: The date the payout was withdrawn successfully in epoch time (ms).
    - `total` integer, nullable
  - `message` string, required
  - `status` integer, required

## Other responses

- `400`: Bad Request Error
- `401`: Unauthorized Error
- `403`: Forbidden Error
- `404`: Not Found Error
- `500`: Internal Server Error

---

[API](https://skmtc.dev/partnerstack/apis/partnerstack-partner-api.md) - [All operations](https://skmtc.dev/partnerstack/apis/partnerstack-partner-api/llms.txt) - [OpenAPI document](https://skmtc.dev/partnerstack/apis/partnerstack-partner-api/revisions/c050e16b8752?raw)