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

# Lire un retrait

> Un retrait, avec la même structure que la réponse de création.



## OpenAPI

````yaml GET /api/v1/payouts/{id}
openapi: 3.1.0
info:
  title: API Mercy Pay
  version: 1.0.0
  description: >-
    Encaissez par mobile money et par carte, facturez en récurrent et versez vos
    fonds. Les montants sont des entiers en unités mineures. Chaque réponse
    porte un en-tête `Request-Id`.
servers:
  - url: https://mercy-pay.com
    description: >-
      Production. La clé choisit l'environnement : `mp_sandbox_…` ou
      `mp_live_…`.
security:
  - bearerAuth: []
tags:
  - name: Compte
  - name: Sessions de paiement
  - name: Paiements
  - name: Remboursements
    description: Rendre un paiement au client, en entier.
  - name: Liens de paiement
  - name: Plans
  - name: Abonnements
  - name: Clients
  - name: Factures
  - name: Espace client
  - name: Soldes
  - name: Retraits
  - name: État des opérateurs
  - name: Événements
    description: Tout ce qui s'est passé sur le compte, envoyé ou non à un endpoint.
  - name: Endpoints de webhook
    description: Les URL de votre serveur qui reçoivent les événements.
paths:
  /api/v1/payouts/{id}:
    get:
      tags:
        - Retraits
      summary: Lire un retrait
      description: Un retrait, avec la même structure que la réponse de création.
      operationId: getPayout
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Identifiant du retrait (`po_…`)
      responses:
        '200':
          description: Le retrait
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Payout'
              example:
                data:
                  id: po_a9d4e6f21b3c4e5d8f702c9b6a1e3d48
                  object: payout
                  livemode: false
                  created: '2026-10-03T10:12:00+00:00'
                  amount: 4000
                  fee_amount: 80
                  net_amount: 3920
                  currency: XAF
                  destination:
                    type: mobile_money
                    country: CMR
                    provider: MTN_MOMO_CMR
                    phone: '237680000000'
                  status: paid
                  origin: api
                  failure_code: null
                  failure_reason: null
                  metadata: null
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  schemas:
    Payout:
      type: object
      properties:
        id:
          type: string
          description: Identifiant du retrait (`po_…`)
        object:
          type: string
          const: payout
        livemode:
          type: boolean
          description: '`true` pour de l''argent réel (clé live), `false` en sandbox'
        created:
          type:
            - string
            - 'null'
          format: date-time
          description: Date de création, ISO 8601
        amount:
          type: integer
          description: Montant demandé, débité en totalité de votre solde.
        fee_amount:
          type: integer
          description: Commission Mercy Pay retenue, 2 % de `amount`.
        net_amount:
          type: integer
          description: Montant réellement envoyé (`amount` moins `fee_amount`).
        currency:
          type: string
          description: Devise du solde source
        destination:
          type: object
          properties:
            type:
              type: string
              description: Type de destination
              enum:
                - mobile_money
            country:
              type: string
              description: Pays ISO 3166-1 alpha-3, par exemple `CMR`.
            provider:
              type: string
              description: >-
                Code opérateur, par exemple `MTN_MOMO_CMR`. Voir [Pays et
                opérateurs](/payments/overview#pays-et-operateurs).
            phone:
              type: string
              description: Numéro avec indicatif, sans `+`
        status:
          type: string
          description: Voir [Retraits](/payouts/overview#statuts).
          enum:
            - requested
            - approved
            - processing
            - paid
            - failed
            - rejected
            - canceled
        status_detail:
          type:
            - string
            - 'null'
          description: >-
            Précise un retrait en cours. `delayed` : l'opérateur est
            indisponible et le retrait attend son retour, vous pouvez l'annuler.
            `pending_processing` : le retrait n'est pas encore parti, il partira
            automatiquement. `null` sinon.
          enum:
            - delayed
            - pending_processing
            - null
        origin:
          type:
            - string
            - 'null'
          description: >-
            D'où vient le retrait. Vide pour ceux créés avant le 7 novembre
            2026.
          enum:
            - dashboard
            - api
            - automatic
            - null
        failure_code:
          type:
            - string
            - 'null'
          description: >-
            Motif d'échec stable, par exemple `recipient_not_found`. Voir
            [Erreurs](/developers/errors)
        failure_reason:
          type:
            - string
            - 'null'
          description: Raison de l'échec ou du refus
        metadata:
          type:
            - object
            - 'null'
          additionalProperties: true
          description: Vos données libres. Voir [Metadata](/developers/metadata).
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              enum:
                - authentication_error
                - invalid_request_error
                - idempotency_error
                - payment_error
                - rate_limit_error
                - api_error
            code:
              type: string
              description: Code stable, à tester dans votre code
            message:
              type: string
              description: Explication en français, pour un humain
            param:
              type:
                - string
                - 'null'
              description: Le premier champ en cause
            doc_url:
              type: string
              description: Explication de ce code
            request_id:
              type: string
              description: >-
                Identifiant de la requête (`req_…`), aussi dans l'en-tête
                `Request-Id`
            errors:
              type: object
              additionalProperties:
                type: array
                items:
                  type: string
              description: Détail par champ refusé, sur une erreur `422`
      required:
        - error
  responses:
    Unauthorized:
      description: Clé absente, invalide ou révoquée
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              type: authentication_error
              code: api_key_invalid
              message: Clé API invalide.
              param: null
              doc_url: https://docs.mercy-pay.com/developers/errors#api_key_invalid
              request_id: req_01jc8x4m2v7t9qk3n5w6y8z0ab
    NotFound:
      description: Ressource inconnue, ou d'un autre marchand ou environnement
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              type: invalid_request_error
              code: resource_not_found
              message: Ressource introuvable.
              param: null
              doc_url: https://docs.mercy-pay.com/developers/errors#resource_not_found
              request_id: req_01jc8x4m2v7t9qk3n5w6y8z0ab
    RateLimited:
      description: Plus de 60 requêtes par minute avec cette clé
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              type: rate_limit_error
              code: rate_limited
              message: Trop de requêtes.
              param: null
              doc_url: https://docs.mercy-pay.com/developers/errors#rate_limited
              request_id: req_01jc8x4m2v7t9qk3n5w6y8z0ab
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Votre clé API. Utilisez une clé sandbox (`mp_sandbox_…`) pour essayer :
        aucun argent réel ne bouge.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.