PayFac en tant que service (PFaaS)
Commande de terminaux et de services pour les nouveaux marchands

Créez une commande de terminal ou de service pour un marchand nouvellement intégré et surveillez son exécution.

Sommaire

API alimentant ce scénario

  1. POST /onboarding/merchants/{merchant-id}/orders - Créer une commande

  2. GET /onboarding/merchants/{merchant-id}/orders/{merchant-order-id} - Récupérer une commande

Prérequis

  • Le merchant (marchand) est créé et possède un merchant-id (Identifiant du marchand) valide.

  • Le marchand doit disposer d’un AgreementModelCode (Code du modèle d’entente) et d’un RepresentativeCode (Code du représentant) valides fournis par Moneris.

  • Accès API avec étendues (scopes) :

    • onboarding.order.write pour créer une commande

    • onboarding.order.read pour récupérer une commande

  • En-têtes d’authentification :

    • Api-Version (Version de l’API)

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

    • Authentification OAuth2 ou ApiKey

Les partenaires peuvent mettre en service du matériel, des services et des fournitures de manière programmatique à grande échelle, réduisant ainsi les efforts manuels et accélérant le délai d’activation pour les nouveaux marchands.

Aperçu du cas d’utilisation

Les partenaires (ISV, PayFac, acquéreurs tiers) déclenchent une commande dès qu’un enregistrement de marchand existe. L’application partenaire appelle les API de commandes de terminaux et de services de PayFac en tant que service (PFaaS) de Moneris pour soumettre la commande, puis effectue une interrogation cyclique (polling) du statut de la commande afin d’alimenter les flux de travail en aval (par exemple, notifications d’expédition, activation du point de vente).

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

  • Soumettre une commande de terminaux/services/fournitures pour un marchand

  • Recevoir la charge utile de commande créée contenant les fees (frais), promotions (promotions) et supplies items (articles de fournitures)

  • Récupérer les détails de la commande afin de suivre l’état et l’exécution

1. Créer la commande (POST)

Soumettez la commande initiale de terminaux/services/fournitures pour le marchand.

Appelez POST /onboarding/merchants/{merchant-id}/orders avec l’un des exemples de requêtes pris en charge.

L’API renvoie 201 Created (crée) avec un objet order (commande) représentant la commande créée.

Entrées requises :

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

  • Corps de la requête correspondant à Create Order request

    (createOrderRequest) (Requête de création de commande)

  • En-têtes d’authentification :

    • Api-Version (Version de l’API)

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

    • Authentification OAuth2 ou ApiKey

Réponse

Requête

2. Récupérer les détails de la commande (GET)

Interrogez (polling) le statut et les détails de la commande afin d’alimenter les processus d’exécution et les notifications.

Appelez GET /onboarding/merchants/{merchant-id}/orders/{merchant-order-id}. L’API renvoie 200 OK avec les détails les plus récents de la commande.

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 d’authentification :

    • Api-Version (Version de l’API)

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

    • Authentification OAuth2 ou ApiKey

Réponse

Notes

REMARQUE : Commandes accélérées

Lorsque isExpeditedOrder (Commande accélérée) = (valeur booléenne vraie), coordonnez-vous avec les accords de niveau de service (SLA) d’exécution en conséquence.

Notes supplémentaires

  • Toutes les valeurs monétaires sont exprimées en cents.

  • Utilisez idempotencyKey (Clé d’idempotence) lors de la création afin d’éviter les commandes en double (lorsque cela s’applique).

  • Surveillez orderStatus (Statut de la commande) pour déclencher les avis d’expédition et l’activation du point de vente (POS).

  • Les réponses d’erreur courantes incluent : 400, 401, 403, 404, 409, 422, 429, 500, 503.

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