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

# Lister les retraits

> Liste paginée et filtrable de vos retraits

<Note>
  Filtres disponibles : `?status=`, `?merchant=`, `?currency=`.
</Note>


## OpenAPI

````yaml api-reference/openapi.json GET /settlements/
openapi: 3.1.0
info:
  title: SasPay API
  description: >-
    API d'encaissement et de paiement mobile money/carte pour l'Afrique de
    l'Ouest et du Centre. Toutes les routes marchand nécessitent une clé API
    secrète (header Authorization: Bearer sk_...).
  version: 1.0.0
servers:
  - url: https://api.saspay.me/api/v1
security:
  - bearerAuth: []
paths:
  /settlements/:
    get:
      tags:
        - Retraits
      summary: Lister les retraits
      description: 'Filtres disponibles : status, merchant, currency.'
      parameters:
        - name: page
          in: query
          required: false
          schema:
            type: integer
            default: 1
        - name: page_size
          in: query
          required: false
          schema:
            type: integer
            default: 20
            maximum: 100
        - name: status
          in: query
          required: false
          schema:
            type: string
        - name: merchant
          in: query
          required: false
          schema:
            type: string
            format: uuid
        - name: currency
          in: query
          required: false
          schema:
            type: string
      responses:
        '200':
          description: Liste paginée
          content:
            application/json:
              example:
                count: 37
                next: null
                previous: null
                results:
                  - id: 9f0a1b2c-1111-2222-3333-444455556666
                    reference: 6c9e1a2b-3333-4444-5555-666677778888
                    merchant: 8a1f5c3e-0000-1111-2222-333344445555
                    payout_method: b3e1c2d4-1111-2222-3333-444455556666
                    country: BJ
                    requested_amount: '150000.00'
                    fee_charge_mode: DEDUCTED
                    client_fee: '1500.00'
                    gateway_fee: '500.00'
                    platform_fee: '1000.00'
                    fee_config: standard_payout_fee
                    debited_amount: '150000.00'
                    net_amount: '148500.00'
                    currency: XOF
                    status: PENDING
                    approved_by_admin: null
                    approved_at: null
                    executed_at: null
                    completed_at: null
                    proof_url: null
                    failure_reason: null
                    created_at: '2026-08-12T10:05:00Z'
                    updated_at: '2026-08-12T10:05:00Z'
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: sk_live_... / sk_test_...
      description: >-
        Clé API secrète du marchand — header Authorization: Bearer sk_live_xxx
        (ou sk_test_xxx en environnement de test).

````