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

# List settlement requests



## OpenAPI

````yaml /openapi/v0/openapi.json get /v0/settlement-requests
openapi: 3.0.0
info:
  title: Superbank API
  description: Superbank Developer API for Instant Settlement
  version: '1.0'
  contact: {}
servers:
  - url: https://api-sandbox.superbank.co
    description: Sandbox
security: []
tags: []
paths:
  /v0/settlement-requests:
    get:
      tags:
        - Settlement Requests
      summary: List settlement requests
      operationId: SettlementRequestsController_list
      parameters:
        - name: page
          required: false
          in: query
          description: >-
            The page number to retrieve. Pages are 1-indexed. If omitted,
            defaults to the first page
          schema:
            type: number
        - name: limit
          required: false
          in: query
          description: >-
            The maximum number of settlement requests to return per page. If
            omitted, defaults to 20. Maximum is 100
          schema:
            type: number
        - name: status
          required: false
          in: query
          description: >-
            Filters settlement requests by status. If omitted, settlement
            requests of all statuses are returned
          schema:
            enum:
              - REQUEST_STARTED
              - REQUEST_EXPIRED
              - REQUEST_CANCELED
              - REQUEST_COMPLETED
              - REQUEST_REFUNDED
              - FUNDS_SENT
              - FUNDS_RECEIVING_LATE
              - SETTLEMENT_SENT
              - SETTLEMENT_COMPLETED
              - AWAITING_PAYIN_RECONCILIATION
              - PAYIN_CANCELED
              - PAYIN_UNDER_REVIEW
              - PAYIN_FAILED
              - PAYIN_AMOUNT_MISMATCH
              - PAYOUT_CANCELED
              - PAYOUT_UNDER_REVIEW
              - PAYOUT_FAILED
            type: string
        - name: external_id
          required: false
          in: query
          description: >-
            Filters settlement requests by the `external_id` you supplied on
            create. Exact match.
          schema:
            type: string
      responses:
        '200':
          description: Settlement requests retrieved
      security:
        - api-key: []
components:
  securitySchemes:
    api-key:
      type: apiKey
      in: header
      name: X-Api-Key

````