GuidesRéférence APIChangelog
Log In
Guides

Modèle de protocole contextuel (MCP)


Vue d'ensemble

Le serveur Moneris Model Context Protocol (MCP) (Modèle de protocole contextuel) expose des outils que les agents IA compatibles MCP peuvent utiliser pour interagir avec les API Moneris pour le traitement des paiements, la gestion des clients, les abonnements et plus encore.

Si vous utilisez un éditeur de code alimenté par l'IA comme Cursor, VS Code ou Claude Code, vous pouvez le connecter au serveur MCP Moneris. Il en va de même pour les outils généralistes comme GitHub Copilot et Claude.


Serveur distant

Moneris héberge un serveur MCP HTTP en continu (streamable) à l'adresse :

  • Sandbox : https://mcp.sb.moneris.io/
  • Production : https://mcp.moneris.io/

À la fin de ce guide, votre agent effectuera des requêtes authentifiées à l'API Moneris.


Prérequis

  • Un compte marchand Moneris avec accès à l'API.
  • Vos identifiants d'API Moneris (clé d'API et identifiant marchand).
  • Des outils alimentés par l'IA compatibles MCP tels que : Cursor, VS Code, Claude.

1. Configurer le serveur MCP Moneris dans votre éditeur

Avant que votre agent IA puisse interagir avec l'API Moneris, il doit savoir où se trouve le serveur MCP. Cette étape enregistre le serveur Moneris MCP distant auprès de votre éditeur afin que tous les appels d'outils subséquents soient acheminés via celui-ci. Ajoutez la configuration du serveur MCP Moneris à votre éditeur. Le serveur MCP Moneris distant est hébergé à https://mcp.sb.moneris.io/.

📘

Environnement de production

Les exemples ci-dessous utilisent l'URL du bac à sable. Pour la production, remplacez https://mcp.sb.moneris.io/ par https://mcp.moneris.io/.


Ajoutez ce qui suit à votre fichier ~/.cursor/mcp.json :

{
  "mcpServers": {
    "moneris": {
      "url": "https://mcp.sb.moneris.io/",
      "headers": {
        "x-api-key": "${env:MONERIS_API_KEY}",
        "x-merchant-id": "${env:MONERIS_MERCHANT_ID}"
      }
    }
  }
}

Pour en savoir plus, consultez la documentation MCP de Cursor.


2. Traiter votre premier paiement avec un agent IA

Ce scénario décrit la création d'un client et le traitement d'un paiement de base à l'aide de votre agent IA et du serveur MCP Moneris.


Avant de commencer

  • Étape 1 complétée.
  • Un identifiant de mode de paiement enregistré valide, créé en dehors des interactions MCP, LLM ou d'agent.

2.1 Créer un client (optionnel)

Exemple d'invite : Créez un client avec le prénom Jane, le nom Doe et le courriel [email protected].

Sortie attendue : Identifiant du client.

2.2 Créer un paiement

Exemple d'invite : Créez un paiement de 10,00 $ CA en utilisant l'identifiant de mode de paiement enregistré <STORED_PAYMENT_METHOD_ID> et capturez-le automatiquement.

Sortie attendue : Identifiant du paiement.

Notes supplémentaires

  • Les paiements sont traités immédiatement lorsque automaticCapture (capture automatique) est défini à true (vrai).

Considérations de sécurité

  • Données de carte brutes. Ne transmettez jamais de données de carte brutes dans les messages de clavardage ou aux LLM/agents.
  • Portée du serveur MCP. Le serveur Moneris MCP ne demande ni n'attend de données de carte brutes.
  • Modes de paiement enregistrés. Utilisez les identifiants de modes de paiement enregistrés Moneris au lieu de données de carte brutes.
  • Identifiants dans le clavardage. Évitez de transmettre des identifiants marchands ou des clés d'API dans les messages de clavardage.
  • Secrets codés en dur. Ne codez jamais en dur des secrets dans le code source ou le contrôle de version.
  • Séparation des environnements. Utilisez toujours les identifiants Sandbox pour le développement et les tests.
  • Confirmation d'outil. Activez la confirmation humaine pour les outils liés aux paiements en production.
  • HTTPS. Utilisez toujours HTTPS dans les environnements de production.

Gestion des erreurs

Le serveur MCP retourne des erreurs (Erreur) pour :

  • Les problèmes de connectivité réseau
  • Les échecs d'authentification
  • Les paramètres de requête invalides
  • La limitation du débit de l'API
  • Les erreurs serveur

Les erreurs sont retournées dans un format JSON-RPC cohérent avec un champ message descriptif pour aider au débogage.

Outils disponibles

Le serveur expose les outils MCP suivants pour interagir avec l'API Moneris. Nous recommandons d'activer la confirmation humaine pour les outils et de faire preuve de prudence lors de la combinaison du serveur Moneris MCP avec d'autres serveurs MCP afin d'éviter les transactions non intentionnelles.

RessourceOutilDescription
Paiementscreate_paymentCréer un paiement en utilisant uniquement un identifiant de mode de paiement
retrieve_paymentRécupérer un paiement par identifiant
list_paymentsLister les paiements avec pagination et filtrage
cancel_paymentAnnuler un paiement
complete_paymentCompléter un paiement (pour les transactions en deux étapes)
Remboursementsretrieve_refundRécupérer un remboursement par identifiant
list_refundsLister les remboursements avec pagination et filtrage
Modes de paiementretrieve_payment_methodRécupérer un mode de paiement par identifiant
list_payment_methodsLister les modes de paiement avec pagination
Validation de carteretrieve_card_validationRécupérer les résultats de validation de carte
list_card_validationsLister les validations de carte avec pagination
Clientscreate_customerCréer un nouveau client
retrieve_customerRécupérer les détails d'un client par identifiant
list_customersLister les clients avec pagination et filtrage
Tarification multidevisemcpRateVerrouiller les taux de change pour les paiements ou remboursements multidevises
getMultiCurrencyPricingRateByIdRécupérer les détails du taux MCP verrouillé par identifiant de recherche
Abonnementslist_subscriptionsLister les abonnements
retrieve_subscriptionRécupérer les détails d'un abonnement par identifiant d'abonnement
Supplémentsurcharge_lookupEffectue une recherche de surcharge pour déterminer si un mode de paiement est admissible à une surcharge

Soutien

Pour les problèmes liés à :

  • API Moneris : Communiquez avec le soutien Moneris ou consultez le Portail des développeurs Moneris.
  • Serveur MCP : Vérifiez les journaux du serveur et assurez-vous d'une configuration adéquate. Communiquez avec [email protected] pour tout commentaire sur le produit.
  • Intégration : Vérifiez vos identifiants d'API et votre connectivité réseau.

Renseignements supplémentaires

📘

Définitions de l'API

Consultez les endpoints (points de terminaison), les formats des demandes et des réponses, ainsi que les modes d'authentification de ce scénario.

Définitions de l'API