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

# Prop Trading List Org Payments

> Pages the firm's org-wide prop-trader payout history, optionally narrowed to one import, with trader identity.

Required scope: `payments:read`. It also needs `compensation:read`.

## OpenAPI

````yaml api-reference/openapi.json GET /hris/prop-trading-list-org-payments
openapi: 3.1.0
info:
  title: Toku API
  version: 1.0.0
servers:
  - url: https://api.toku.com
security:
  - bearerAuth: []
paths:
  /hris/prop-trading-list-org-payments:
    get:
      operationId: propTradingListOrgPayments
      summary: Prop Trading List Org Payments
      x-toku-required-scope: payments:read
      description: >-
        Pages the firm's org-wide prop-trader payout history, optionally
        narrowed to one import, with trader identity.


        Required scope: `payments:read`. It also needs `compensation:read`.
      parameters:
        - name: payoutImportID
          in: query
          required: false
          schema:
            type: string
            format: uuid
        - name: page
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            default: 1
        - name: pageSize
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 25
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PropTradingListOrgPaymentsResponse'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not found
        '409':
          description: Conflict
        '429':
          description: Response 429
components:
  schemas:
    PropTradingListOrgPaymentsResponse:
      type: object
      properties:
        payments:
          type: array
          items:
            type: object
            properties:
              payoutImportRowID:
                type: string
              externalReference:
                type: string
              invoicePaymentID:
                type: string
              invoiceNumber:
                type: string
              amount:
                type: string
                pattern: ^-?\d+(\.\d+)?(e[+-]?\d+)?$
              currencyCode:
                type: string
              status:
                type: string
                enum:
                  - IN_REVIEW
                  - FAILED
                  - CANCELLED
                  - PAID
                  - PARTIALLY_PAID
                  - IN_PROGRESS
                  - AWAITING_PAYMENT
                  - PENDING
              legTypes:
                type: array
                items:
                  type: string
              tokenSymbol:
                type:
                  - string
                  - 'null'
              networkName:
                type:
                  - string
                  - 'null'
              fx:
                type:
                  - object
                  - 'null'
                properties:
                  payoutCurrency:
                    type: string
                  payoutAmount:
                    type: string
                    pattern: ^-?\d+(\.\d+)?(e[+-]?\d+)?$
                  rate:
                    type: string
                    pattern: ^-?\d+(\.\d+)?(e[+-]?\d+)?$
                  midRate:
                    type:
                      - string
                      - 'null'
                    pattern: ^-?\d+(\.\d+)?(e[+-]?\d+)?$
                  markupBps:
                    type:
                      - integer
                      - 'null'
                  ratePulledAt:
                    type:
                      - string
                      - 'null'
                  isExecuted:
                    type: boolean
                required:
                  - payoutCurrency
                  - payoutAmount
                  - rate
                  - midRate
                  - markupBps
                  - ratePulledAt
                  - isExecuted
              estimatedArrival:
                type:
                  - object
                  - 'null'
                properties:
                  from:
                    type: string
                  by:
                    type: string
                  passed:
                    type: boolean
                required:
                  - from
                  - by
                  - passed
              paidAt:
                type:
                  - string
                  - 'null'
              createdAt:
                type: string
              traderName:
                type:
                  - string
                  - 'null'
              traderRoleInOrgID:
                type:
                  - string
                  - 'null'
            required:
              - payoutImportRowID
              - externalReference
              - invoicePaymentID
              - invoiceNumber
              - amount
              - currencyCode
              - status
              - legTypes
              - tokenSymbol
              - networkName
              - fx
              - estimatedArrival
              - paidAt
              - createdAt
              - traderName
              - traderRoleInOrgID
        total:
          type: integer
        page:
          type: integer
        pageSize:
          type: integer
        totalPages:
          type: integer
      required:
        - payments
        - total
        - page
        - pageSize
        - totalPages
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
````
