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

# List Settlements



## OpenAPI

````yaml GET /v1/settlements
openapi: 3.1.0
info:
  title: Plexos Pay API
  description: Mobile Money Payment Gateway for African Markets
  version: 1.0.0
  contact:
    name: Plexos Pay
    url: https://plexospay.com
servers:
  - url: https://api.plexospay.com
    description: Production
security:
  - bearerAuth: []
paths:
  /v1/settlements:
    get:
      tags:
        - Settlements
      summary: List settlements
      operationId: listSettlements
      parameters:
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/starting_after'
        - name: status
          in: query
          schema:
            $ref: '#/components/schemas/SettlementStatus'
      responses:
        '200':
          description: Paginated list of settlements
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Settlement'
                  hasMore:
                    type: boolean
components:
  parameters:
    limit:
      name: limit
      in: query
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 20
      description: Max items per page (1-100)
    starting_after:
      name: starting_after
      in: query
      schema:
        type: string
      description: Cursor — ID of the last item from previous page
  schemas:
    SettlementStatus:
      type: string
      enum:
        - PENDING
        - PROCESSING
        - COMPLETED
        - FAILED
    Settlement:
      type: object
      properties:
        id:
          type: string
          example: se_abc123
        merchantId:
          type: string
        amount:
          type: string
        feeTotal:
          type: string
        netAmount:
          type: string
        currency:
          $ref: '#/components/schemas/Currency'
        amountFormatted:
          type: string
        netAmountFormatted:
          type: string
        status:
          $ref: '#/components/schemas/SettlementStatus'
        periodStart:
          type: string
          format: date-time
        periodEnd:
          type: string
          format: date-time
        payoutRef:
          type: string
          nullable: true
        itemCount:
          type: integer
        createdAt:
          type: string
          format: date-time
        processedAt:
          type: string
          format: date-time
          nullable: true
        completedAt:
          type: string
          format: date-time
          nullable: true
    Currency:
      type: string
      enum:
        - CVE
        - AOA
      description: ISO currency code
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API key starting with `sk_live_` or `sk_test_`

````