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

# Modifier un endpoint

> Seuls les champs envoyés changent. `status` à `disabled` met l'envoi en pause.



## OpenAPI

````yaml PATCH /api/v1/webhook_endpoints/{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/webhook_endpoints/{id}:
    patch:
      tags:
        - Endpoints de webhook
      summary: Modifier un endpoint
      description: >-
        Seuls les champs envoyés changent. `status` à `disabled` met l'envoi en
        pause.
      operationId: updateWebhookEndpoint
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Identifiant de l'endpoint (`we_…`)
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                url:
                  type: string
                  format: uri
                  description: URL publique en HTTPS de votre serveur
                events:
                  type: array
                  items:
                    type: string
                  description: Les types d'événements à recevoir
                environment:
                  type:
                    - string
                    - 'null'
                  enum:
                    - sandbox
                    - live
                    - null
                  description: >-
                    L'environnement de votre clé, ou `null` pour les deux.
                    `null` demande une clé live : une clé sandbox ne gère que
                    des endpoints sandbox, et c'est leur environnement par
                    défaut.
                status:
                  type: string
                  enum:
                    - enabled
                    - disabled
            example:
              status: disabled
      responses:
        '200':
          description: L'endpoint modifié
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/WebhookEndpoint'
              example:
                data:
                  id: we_6d1f3a8c2e5b4d7a9c0e2f4b6a8d1c3e
                  object: webhook_endpoint
                  livemode: false
                  created: '2026-11-08T10:05:00+00:00'
                  url: https://boutique-akwa.cm/webhooks/mercy-pay
                  events:
                    - payment.succeeded
                    - payment.failed
                  environment: sandbox
                  status: disabled
                  disabled_reason: null
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/ValidationFailed'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  schemas:
    WebhookEndpoint:
      type: object
      properties:
        id:
          type: string
          description: Identifiant (`we_…`)
        object:
          type: string
          const: webhook_endpoint
        livemode:
          type: boolean
        created:
          type: string
          format: date-time
        url:
          type: string
        events:
          type: array
          items:
            type: string
        environment:
          type:
            - string
            - 'null'
          enum:
            - sandbox
            - live
            - null
          description: '`null` : reçoit les événements sandbox et live'
        status:
          type: string
          enum:
            - enabled
            - disabled
        secret:
          type: string
          description: Secret de signature, renvoyé une seule fois, à la création
        disabled_reason:
          type:
            - string
            - 'null'
          enum:
            - failing
            - manual
            - null
          description: >-
            Pourquoi l'endpoint est désactivé : `failing` après 3 jours sans
            aucun événement accepté, `manual` à votre demande. `null` s'il est
            actif
    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
    ValidationFailed:
      description: Données invalides, avec le détail dans `errors`
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              type: invalid_request_error
              code: validation_failed
              message: Le champ amount est obligatoire.
              param: amount
              doc_url: https://docs.mercy-pay.com/developers/errors#validation_failed
              request_id: req_01jc8x4m2v7t9qk3n5w6y8z0ab
              errors:
                amount:
                  - Le champ amount est obligatoire.
    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.