PayFac en tant que service (PFaaS)
Intégration et mise à jour des marchands tiers

Créez et gérez des marchands pour une intégration d’acquéreur tiers à l’aide des API d’intégration et de mise à jour des marchands de Moneris.

Sommaire

Systèmes concernés

  • Plateforme partenaire (votre back end / interface utilisateur d’inscription)

  • API PayFac en tant que service (PFaaS) Moneris (Inscription des marchands)

  • Systèmes de back-office de Moneris (crédit, risque, mise en service, enregistrements)

APIs utilisées

  1. POST /onboarding/merchants — Create Merchant (Créer un marchand)

  2. GET /onboarding/merchants/{merchant-id} — Obtenir les détails du merchant (marchand)

  3. PATCH /onboarding/merchants/{merchant-id} — Mettre à jour les détails du merchant (marchand) (partiel, application/merge-patch+json)

Prérequis

  • Accès OAuth2 avec des étendues (scopes) :

    • onboarding.merchant.write (créer/mettre à jour)

    • onboarding.merchant.read (récupérer)

  • Les en-têtes Api-Version (Version de l’API) et X-Correlation-Id (ID de corrélation) sont envoyés sur toutes les requêtes.

  • Les en-têtes Api-Version (Version de l’API) et X-Correlation-Id (ID de corrélation) sont envoyés sur toutes les requêtes.

Les ISV et les acquéreurs partenaires peuvent créer de manière programmatique des profils de marchands Moneris, récupérer les informations les plus récentes sur les marchands et mettre à jour les principaux détails des marchands ou des contacts pour les nouveaux marchands sans échanges manuels, réduisant ainsi le délai de mise en service et la charge opérationnelle.

Aperçu du cas d’utilisation

Mettez ceci en œuvre lorsque votre plateforme partenaire doit :

  • Soumettre une nouvelle demande de marchand et un profil bancaire.

  • Récupérer les détails du marchand et le statut en utilisant le merchantId (Identifiant du marchand) attribué.

  • Mettre à jour les tout nouveaux détails du marchand/contact au moyen de mises à jour partielles avant de passer la première commande.

Étapes

  1. La plateforme partenaire soumet Create Merchant (Créer un marchand) avec la charge utile d’intégration complète.

  2. Moneris enregistre le profil de merchant (marchand) et les détails bancaires.

  3. Moneris accuse réception de la création et attribue un merchantId (Identifiant du marchand).

  4. L’API répond 201 Created avec des headers (en-têtes) et un corps merchant (marchand).

Optionnel :

  1. Le partenaire récupère les détails du merchant (marchand) par merchantId (Identifiant du marchand).

  2. L’API répond 200 OK avec l’objet merchant (marchand).

  3. Le partenaire émet PATCH Update Merchant (PATCH Mettre à jour le marchand) pour modifier les champs de contact/merchant (marchand).

  4. Moneris applique les mises à jour dans les systèmes de back-office.

  5. Moneris confirme les modifications.

  6. L’API répond 200 OK avec merchantDetails (Détails du marchand) mis à jour.

1. Créer un marchand (POST)

Démarrez un nouveau profil de marchand avec des détails commerciaux, bancaires et de sécurité afin qu’une commande puisse être passée pour le marchand et que l’approvisionnement en aval et les vérifications de risque puissent se poursuivre.

Endpoint (le point de terminaison) :

POST /onboarding/merchants

Entrées requises :

L’objet merchantPayload (Charge utile du marchand) est requis, lequel exige lui-même : bankingDetails (Détails bancaires), businessDetails (Détails de l’entreprise), merchantDetails (Détails du marchand), businessActivity (Activité commerciale), securityDetails (Détails de sécurité).

REMARQUE : Pour les acquéreurs tiers, il est obligatoire de transmettre un chainId (Identifiant de chaîne) provisionné par Moneris afin de lier tous les marchands de l’acquéreur tiers et pour l’identification du type d’ISV (fournisseur de logiciel indépendant).

Réponse

Requête

2. Retrieve Merchant Details (GET)

Récupérez le profil actuel du merchant (marchand) pour l’affichage du statut ou la synchronisation CRM.

Endpoint (le point de terminaison) :

GET /onboarding/merchants/{merchant-id}

Entrées requises :

  • merchant-id (paramètre de chemin, V13)

Réponse

3. Mettre à jour les détails du marchand (PATCH)

Appliquez une maintenance ciblée du compte aux informations du marchand/contact sans soumettre de nouveau la charge utile complète d’intégration.

Endpoint (le point de terminaison) :

GET /onboarding/merchants/{merchant-id}

Type de contenu :

  • application/merge-patch+json

Réponse

Requête

Notes

Gestion de l’idempotence et des nouvelles tentatives

Si la plateforme expire après un appel POST /onboarding/merchants, vérifiez la création d’un merchant (marchand) à l’aide de votre merchantId (Identifiant du marchand) stocké (provenant de l’en-tête Location ou de la réponse de création) avant de réessayer. Utilisez un nouvel X-Correlation-Id (ID de corrélation) pour chaque tentative.

Notes supplémentaires

  • Envoyez Api-Version (Version de l’API) et X-Correlation-Id (ID de corrélation) à chaque appel.

  • Utilisez les étendues OAuth2 avec le principe du moindre privilège : onboarding.merchant.read (lecture) et onboarding.merchant.write (création/mise à jour).

  • Toutes les valeurs de montant monétaire sont exprimées en cents.

  • Validez le format du merchant-id (Identifiant du marchand) — 13 caractères — avant la substitution dans le chemin.

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