PayFac en tant que service (PFaaS)
Soumission de commande de banque partenaire

Soumettez une commande de banque partenaire (adresse de livraison, informations du banquier, solutions) pour un marchand à l’aide des API PayFac en tant que service (PFaaS) de Moneris.

Sommaire

Systèmes impliqués

  • Application partenaire

  • API PayFac en tant que service (PFaaS) de Moneris

  • Exécution/Opérations

API alimentant ce scénario

GET /onboarding/merchants/{merchant-id}/orders/{merchant-order-id} - Terminal & Service Orders

Prérequis

  • Étendue OAuth2 :

    • onboarding.order.write

    • (et optionnellement onboarding.order.read pour la récupération)

  • En-têtes requis pour tous les appels :

    • Api-Version (Version de l’API)

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

  • Paramètre de chemin :

    • merchant-id (Identifiant du marchand)

Les banques partenaires peuvent créer des commandes de manière programmatique avec des champs spécifiques au banquier et des détails de livraison, réduisant ainsi la coordination manuelle et accélérant le délai d’expédition.

Aperçu du cas d’utilisation

Soumettez une commande de banque partenaire pour un marchand à l’aide de l’exemple CreatePartnerBankOrderPayload (Charge utile de création de commande de banque partenaire).

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

  • Créer des commandes de banque partenaire avec les détails de livraison et du banquier

  • Recevoir une charge utile de commande 201 Created (201 Créé) incluant les fees (frais), promotions (promotions) et supplies (fournitures)

  • (Optionnel) Récupérer la commande par ID pour l’affichage du statut

1. Créer une commande de banque partenaire (POST)

Créez une nouvelle commande pour un marchand à l’aide de la charge utile Partner Bank (Banque partenaire), qui inclut les détails de la succursale du banquier, l’adresse de livraison et les solutions.

Endpoint (le point de terminaison) :

POST /onboarding/merchants/{merchant-id}/orders

Type de contenu :

application/json

Entrées requises :

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

  • Le corps de la requête doit correspondre à CreatePartnerBankOrderPayload (Charge utile de création de commande de banque partenaire).

  • En-têtes :

    • Api-Version (Version de l’API)

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

Réponse

Requête

(Optionnel) : Récupérer une commande par ID (GET)

Récupérez la commande afin d’afficher l’état actuel et les détails dans votre portail.

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)

Réponse

Notes

  • 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).

  • Respectez les limites de taux à l’aide des 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