PayFac en tant que service (PFaaS)
Suivi de l’état des commandes pour terminaux et services

Suivez l’état et les détails d’une commande de terminal ou de service pour un marchand au moyen de l’API PayFac en tant que service (PFaaS) Moneris.

Sommaire

API alimentant ce scénario

GET /onboarding/merchants/{merchant-id}/orders/{merchant-order-id} - Retrieve an order

Systèmes concernés

  • Application partenaire (ISV)

  • API PayFac en tant que service (PFaaS) Moneris

  • Systèmes d’exécution (à titre de référence seulement).

Prérequis

  • Accès OAuth 2.0 avec étendue (scope) :

    • onboarding.order.read (lecture)

    • (ou onboarding.order.write si votre intégration le possède déjà)

  • En-têtes requis :

    • Api-Version (Version de l’API)

    • X-Correlation-Id (ID de corrélation)

  • Paramètres de chemin :

    • merchant-id (Identifiant du marchand)

    • merchant-order-id (Identifiant de la commande du marchand)

Les équipes des ventes et d’intégration ont besoin d’une visibilité en temps réel sur la progression des commandes (par exemple, décision, frais, état de préparation à l’expédition) afin de coordonner les activations et les mises à jour destinées aux clients.

Aperçu du cas d’utilisation

  • Toutes les commandes suivent un flux de processus métier pour la configuration dans les systèmes en aval et passent donc par différents états avant d’être complétées.

  • Après la soumission d’une commande, votre portail interroge la commande par ID afin d’afficher le orderStatus (Statut de la commande) le plus récent et les détails connexes (fees (Frais), limits (Limites), banking summary (Résumé bancaire)).

Tâches clés permises par ce scénario :

  • Récupérer les détails d’une commande par ID

  • Afficher l’état et les frais de la commande

  • Déclencher des notifications lors des changements d’état

Étapes

  1. L’application partenaire appelle GET /onboarding/merchants/{merchant-id}/orders/{merchant-order-id}

  2. L’API renvoie 200 OK avec l’objet order (commande)

  3. L’application partenaire répète l’appel à intervalles réguliers pour détecter les changements d’état

Récupérer une commande par identifiant (ID)

Réponse

Obtenez l’état actuel de la commande et ses détails afin de mettre à jour votre portail et vos flux de travail.

Endpoint (le point de terminaison):

GET /onboarding/merchants/{merchant-id}/orders/{merchant-order-id}

Entrées requises :

  • merchant-id (paramètre de chemin, Identifiant du marchand)

  • merchant-order-id (paramètre de chemin, Identifiant de la commande du marchand)

  • En-têtes :

    • Api-Version (Version de l’API)

    • X-Correlation-Id (ID de corrélation)

Notes

  • Stratégie d’interrogation cyclique (polling) : utilisez un repli exponentiel (exponential backoff) et évitez les intervalles trop fréquents.

  • Utilisez X-Correlation-Id (ID de corrélation) pour tracer les requêtes de bout en bout.

  • Respectez les limites de taux en utilisant les en-têtes X-RateLimit-* (Limite de taux).

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