> ## 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.

# Lister les sites autorisés

> Les sites sur lesquels le paiement intégré peut s'afficher, avec leur état de vérification. En sandbox, `localhost`, `127.0.0.1` et les domaines `.test` et `.localhost` sont autorisés sans déclaration.



## OpenAPI

````yaml GET /api/v1/embed_domains
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.
  - name: Journal des requêtes
    description: >-
      Les appels faits avec vos clés, pour suivre une intégration depuis le
      terminal.
  - name: Sites autorisés
    description: Les sites sur lesquels le paiement intégré peut s'afficher.
paths:
  /api/v1/embed_domains:
    get:
      tags:
        - Sites autorisés
      summary: Lister les sites autorisés
      description: >-
        Les sites sur lesquels le paiement intégré peut s'afficher, avec leur
        état de vérification. En sandbox, `localhost`, `127.0.0.1` et les
        domaines `.test` et `.localhost` sont autorisés sans déclaration.
      operationId: listEmbedDomains
      parameters:
        - name: limit
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 20
          description: Nombre d'objets
        - name: starting_after
          in: query
          schema:
            type: string
          description: Le `next_cursor` de la page précédente
        - name: ending_before
          in: query
          schema:
            type: string
          description: Un id, pour revenir à la page d'avant
      responses:
        '200':
          description: Une page de sites
          content:
            application/json:
              schema:
                type: object
                properties:
                  object:
                    type: string
                    const: list
                  url:
                    type: string
                  has_more:
                    type: boolean
                  next_cursor:
                    type:
                      - string
                      - 'null'
                    description: À passer en `starting_after` pour la page suivante
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/EmbedDomain'
              example:
                object: list
                url: /api/v1/embed_domains
                has_more: false
                next_cursor: null
                data:
                  - id: edom_6f1c2a8e4b3d4e5f9a0b1c2d3e4f5a6b
                    object: embed_domain
                    livemode: true
                    created: '2026-11-17T09:30:00+00:00'
                    hostname: boutique.com
                    status: verified
                    verification:
                      type: TXT
                      name: _mercy-pay.boutique.com
                      value: mercy-pay-verification=Zq8Lw2vR7tYc4NbK1sXe9mPaU3gHd6Jf
                    verified_at: '2026-11-17T09:42:00+00:00'
                    last_checked_at: '2026-11-17T10:00:00+00:00'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  schemas:
    EmbedDomain:
      type: object
      properties:
        id:
          type: string
          description: Identifiant du site (`edom_…`)
        object:
          type: string
          const: embed_domain
        livemode:
          type: boolean
          description: >-
            `true` pour une clé live, `false` en sandbox. Un site autorisé vaut
            pour les deux environnements.
        created:
          type:
            - string
            - 'null'
          format: date-time
          description: Date d'ajout, ISO 8601
        hostname:
          type: string
          description: >-
            Le domaine, par exemple `boutique.com`. Il autorise aussi ses
            sous-domaines.
        status:
          type: string
          enum:
            - pending
            - verified
            - failed
          description: >-
            `pending` tant que l'enregistrement TXT n'est pas trouvé, `verified`
            ensuite, `failed` s'il a disparu depuis plus de 7 jours.
        verification:
          type: object
          description: L'enregistrement DNS à créer chez votre hébergeur de domaine.
          properties:
            type:
              type: string
              const: TXT
            name:
              type: string
              description: >-
                Le nom de l'enregistrement, par exemple
                `_mercy-pay.boutique.com`
            value:
              type: string
              description: La valeur exacte à mettre dans l'enregistrement
        verified_at:
          type:
            - string
            - 'null'
          format: date-time
          description: Première vérification réussie
        last_checked_at:
          type:
            - string
            - 'null'
          format: date-time
          description: Dernière lecture de l'enregistrement. Elle a lieu toutes les heures.
    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
    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.