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

# getPayouts

> Get payouts.



## OpenAPI

````yaml /openapi.yaml get /getPayouts
openapi: 3.1.0
info:
  title: AlphaInsider
  version: '1.0'
  description: >-
    The official API and websocket documentation for
    [AlphaInsider.com](https://alphainsider.com/)
servers:
  - url: https://alphainsider.com/api
security: []
tags:
  - name: Introduction
  - name: Authentication
  - name: Users
  - name: Strategies
  - name: Subscriptions
  - name: Payments
  - name: Withdrawals
  - name: Timelines
  - name: Stocks
  - name: Trades
  - name: Webhooks
  - name: Bots
  - name: Websockets
paths:
  /getPayouts:
    get:
      tags:
        - Withdrawals
      summary: getPayouts
      description: Get payouts.
      operationId: getPayouts
      parameters:
        - $ref: '#/components/parameters/api_token'
        - name: limit
          in: query
          schema:
            $ref: '#/components/schemas/limit'
        - name: offset_id
          in: query
          schema:
            $ref: '#/components/schemas/offset_id'
      responses:
        '200':
          description: Request was successful.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    $ref: '#/components/schemas/success'
                  response:
                    type: array
                    description: >-
                      Endpoint-specific response payload, or an error message
                      when `success` is false.
                    items:
                      type: object
                      properties:
                        payout_id:
                          type: string
                          description: Payout identifier.
                        provider:
                          type: string
                          enum:
                            - stripe
                            - circle
                          description: External provider or data provider.
                        user_id:
                          $ref: '#/components/schemas/user_id'
                        type:
                          type: string
                          enum:
                            - eth
                            - matic
                            - bank
                            - card
                          description: Type or category for this object.
                        amount:
                          type: string
                          description: Amount.
                        fee:
                          type: string
                          description: Fee value.
                        destination:
                          type: object
                          description: Payout destination details.
                        status:
                          type: string
                          enum:
                            - pending
                            - paid
                            - failed
                          description: Current status.
                        updated_at:
                          $ref: '#/components/schemas/updated_at'
                        created_at:
                          $ref: '#/components/schemas/created_at'
              examples:
                '200':
                  value:
                    success: true
                    response:
                      - payout_id: AdcY6qDIBCdnxPCDF1aE4
                        provider: stripe
                        user_id: user_1
                        type: bank
                        amount: '972'
                        fee: '28'
                        destination:
                          address: '6789'
                        status: paid
                        updated_at: '2024-02-05T15:59:39.906Z'
                        created_at: '2024-02-05T15:59:36.765Z'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
components:
  parameters:
    api_token:
      in: header
      name: Authorization
      description: User API token.
      required: true
      schema:
        type: string
        format: JWT
  schemas:
    limit:
      type: number
      description: Number of results to return.
    offset_id:
      type: string
      description: Offet by ID. Used for pagination.
    success:
      type: boolean
      description: True when the request succeeded.
    user_id:
      type: string
      description: AlphaInsider user identifier.
    updated_at:
      type: string
      format: date-time
      description: Last update timestamp.
    created_at:
      type: string
      format: date-time
      description: Creation timestamp.
  responses:
    '400':
      description: Request failed.
      content:
        application/json:
          schema:
            type: object
            properties:
              success:
                type: boolean
                description: False when the request failed.
              response:
                type: string
                description: Error message.
          examples:
            '400':
              value:
                success: false
                response: Request failed.
    '401':
      description: Authentication failed.
      content:
        application/json:
          schema:
            type: object
            properties:
              success:
                type: boolean
                description: False when the request failed.
              response:
                type: string
                description: Error message.
          examples:
            '401':
              value:
                success: false
                response: Authentication failed.

````