> ## Documentation Index
> Fetch the complete documentation index at: https://docs.whop.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List Payouts

> Lists payouts (withdrawal requests) for an account or user, most recent first. Pass exactly one of account_id (a biz_ identifier) or user_id (a user_ identifier). The saved payout method on each payout additionally requires the payout:destination:read scope and is null without it.



## OpenAPI

````yaml /openapi/api-v1-native.yml get /payouts
openapi: 3.1.0
info:
  title: Whop API
  description: >-
    Hand-written V1 endpoints. Merged into the GraphqlRestProxy-generated schema
    at build time.
  version: v1
servers:
  - url: https://{defaultHost}
    variables:
      defaultHost:
        default: api.whop.com/api/v1
security: []
paths:
  /payouts:
    parameters:
      - $ref: '#/components/parameters/ApiVersionDate'
    get:
      tags:
        - Payouts
      summary: List Payouts
      description: >-
        Lists payouts (withdrawal requests) for an account or user, most recent
        first. Pass exactly one of account_id (a biz_ identifier) or user_id (a
        user_ identifier). The saved payout method on each payout additionally
        requires the payout:destination:read scope and is null without it.
      operationId: listPayouts
      parameters:
        - name: account_id
          in: query
          required: false
          schema:
            type: string
          description: The owning account ID (a biz_ identifier). Provide this or user_id.
        - name: user_id
          in: query
          required: false
          schema:
            type: string
          description: The owning user ID (a user_ identifier). Provide this or account_id.
        - name: currency
          in: query
          required: false
          schema:
            type: string
          description: Optional currency code filter, for example `usd`.
        - name: first
          in: query
          required: false
          schema:
            type: integer
            default: 20
            maximum: 100
          description: Number of payouts to return from the start of the window.
        - name: after
          in: query
          required: false
          schema:
            type: string
          description: Cursor to fetch the page after (from page_info.end_cursor).
        - name: last
          in: query
          required: false
          schema:
            type: integer
            maximum: 100
          description: Number of payouts to return from the end of the window.
        - name: before
          in: query
          required: false
          schema:
            type: string
          description: Cursor to fetch the page before (from page_info.start_cursor).
      responses:
        '200':
          description: payout method nulled without the destination-read scope
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        object:
                          type: string
                          enum:
                            - payout
                        id:
                          type: string
                          description: Payout ID.
                        status:
                          type: string
                          enum:
                            - requested
                            - awaiting_payment
                            - in_transit
                            - completed
                            - failed
                            - canceled
                            - denied
                          description: Current payout status.
                        amount:
                          type: number
                          format: float
                          description: The payout amount in whole currency units.
                        currency:
                          type: string
                          description: Payout currency.
                        fee_amount:
                          type: number
                          format: float
                          description: >-
                            The fee charged for the payout, in the payout
                            currency.
                        speed:
                          type: string
                          enum:
                            - standard
                            - instant
                          description: Payout delivery speed.
                        created_at:
                          type: string
                          format: date-time
                          description: When the payout was created.
                        estimated_arrival:
                          type:
                            - string
                            - 'null'
                          format: date-time
                          description: >-
                            Estimated time the funds become available in the
                            destination account.
                        payer_name:
                          type:
                            - string
                            - 'null'
                          description: Name of the entity processing the payout.
                        payout_token:
                          type:
                            - object
                            - 'null'
                          description: >-
                            The saved payout method used. Requires
                            payout:destination:read; null without it.
                          properties:
                            nickname:
                              type:
                                - string
                                - 'null'
                              description: Saved payout method nickname.
                            payout_destination:
                              type:
                                - object
                                - 'null'
                              description: Payout destination display details.
                              properties:
                                payer_name:
                                  type:
                                    - string
                                    - 'null'
                                  description: Payout destination display name.
                                icon_url:
                                  type:
                                    - string
                                    - 'null'
                                  description: Payout destination icon URL.
                              required:
                                - payer_name
                                - icon_url
                          required:
                            - nickname
                            - payout_destination
                      required:
                        - object
                        - id
                        - status
                        - amount
                        - currency
                        - fee_amount
                        - speed
                        - created_at
                        - estimated_arrival
                        - payer_name
                        - payout_token
                  page_info:
                    type: object
                    properties:
                      has_next_page:
                        type: boolean
                      end_cursor:
                        type:
                          - string
                          - 'null'
                      has_previous_page:
                        type: boolean
                      start_cursor:
                        type:
                          - string
                          - 'null'
                    required:
                      - has_next_page
                      - end_cursor
                      - has_previous_page
                      - start_cursor
                required:
                  - data
                  - page_info
        '400':
          $ref: '#/components/responses/InvalidParameters'
          description: neither account_id nor user_id provided
        '401':
          $ref: '#/components/responses/Unauthorized'
          description: missing or invalid authentication
        '403':
          $ref: '#/components/responses/Forbidden'
          description: credential lacks the withdrawal-read scope
        '404':
          $ref: '#/components/responses/NotFound'
          description: no ledger for that owner is visible to the credential
      security:
        - bearerAuth:
            - payout:withdrawal:read
components:
  parameters:
    ApiVersionDate:
      name: Api-Version-Date
      in: header
      required: false
      schema:
        type: string
        format: date
        example: '2026-07-01'
      description: >-
        Pins the request to a dated API version. When omitted, the request uses
        the original (2025-01-01) request/response shapes, so existing
        unversioned callers are never broken. Generated SDKs always send the
        latest version they were built against. An unrecognized value is
        rejected with a 400. The schemas documented here always describe the
        latest version.
  responses:
    InvalidParameters:
      description: Invalid Parameters
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/V1ErrorResponse'
    Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/V1ErrorResponse'
    Forbidden:
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/V1ErrorResponse'
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/V1ErrorResponse'
  schemas:
    V1ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              description: Machine-readable error code.
            message:
              type: string
              description: Human-readable error message.
          required:
            - type
            - message
      required:
        - error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: auth-scheme
      description: >-
        An account API key, account scoped JWT, app API key, or user OAuth
        token.

````