Créer un abonnement

post

https://api.sb.moneris.io/subscriptions

Cette opération permet de créer un abonnement.

Webhooks

Détails de la définition du webhook

application/json

  <div class="tab-content" style="display: block;">
    <type-definition>
      <h4 class="text-truncate flex-grow">Corps de la requête Webhook</h4>
      <p>
      <p>Il s'agit de la définition de base de tous les messages d'événement. Il contient les propriétés communes partagées par tous les événements.</p>
      </p>
      <div role="table" class="table-preset table-preset-schema" id="webhookRequestTable">
        <div class="d-contents" role="rowgroup">
          <div class="d-contents" role="row">
            <div role="columnheader" class="table-preset-head text-truncate">
              <span>
                Nom</span>
            </div>
            <div role="columnheader" class="table-preset-head text-truncate">
              <span>
                Requis</span>
            </div>
            <div role="columnheader" class="table-preset-head text-truncate">
              <span>Information supplémentaire</span>
            </div>
            <div role="columnheader" class="table-preset-head">
              <span>
                Description</span>
            </div>
          </div>
        </div>
        <div class="d-contents" role="rowgroup">
          <div class="d-contents" role="row">
            <div role="cell" class="text-truncate" title="eventId">
              eventId</div>
            <div role="cell">
              true</div>
            <div role="cell" class="text-truncate">
              <a class="text-monospace" title="string">
                string</a>
            </div>
            <div role="cell">
              <p>Identifiant unique de l'événement. Peut être utilisé comme clé d'idempotence pour éviter les doublons.</p>
            </div>
          </div>
          <div class="d-contents" role="row">
            <div role="cell" class="text-truncate" title="eventType">
              eventType</div>
            <div role="cell">
              true</div>
            <div role="cell" class="text-truncate">
              <a class="text-monospace" title="string">
                string</a>
            </div>
            <div role="cell">
              <p>Voici une liste de tous les types d'événements que nous envoyons actuellement.</p>
              <ul>
                <li>RECURRING_PAYMENT_CONFIRMED: Une transaction de paiement d'abonnement a été exécutée.</li>
              </ul>
            </div>
          </div>
          <div class="d-contents" role="row">
            <div role="cell" class="text-truncate" title="occuredAt">
              occuredAt</div>
            <div role="cell">
              true</div>
            <div role="cell" class="text-truncate">
              <a class="text-monospace" title="string">
                date-time</a>
            </div>
            <div role="cell">
              <p>l'horodatage du moment où l'événement s'est produit (pas nécessairement le même que celui où il a été livré)</p>
            </div>
          </div>
          <div class="d-contents" role="row">
            <div role="cell" class="text-truncate" title="apiVersion">
              apiVersion</div>
            <div role="cell">
              false</div>
            <div role="cell" class="text-truncate">
              <a class="text-monospace" title="string">
                string</a>
            </div>
            <div role="cell">
              <p>La version de l'API Moneris utilisée pour remplir le corps de l'événement.</p>
            </div>
          </div>
          <div class="d-contents" role="row">
            <div role="cell" class="text-truncate" title="objectId">
              objectId</div>
            <div role="cell">
              false</div>
            <div role="cell" class="text-truncate">
              <a class="text-monospace" title="string">
                string</a>
            </div>
            <div role="cell">
              <p>Utilisé pour identifier les ressources API qui peuvent être nécessaires pour les transactions ultérieures futures ; c’est-à-dire les remboursements, les corrections, les achèvements, les annulations, etc.</p>
            </div>
          </div>
          <div class="d-contents" role="row">
            <div role="cell" class="text-truncate" title="href">
              href</div>
            <div role="cell">
              false</div>
            <div role="cell" class="text-truncate">
              <a class="text-monospace" title="string">
                string</a>
            </div>
            <div role="cell">
              <p>Localisateur de ressources uniforme pour récupérer les détails des ressources</p>
            </div>
          </div>
          <div class="d-contents" role="row">
            <div role="cell" class="text-truncate" title="correlationId">
              correlationId</div>
            <div role="cell">
              false</div>
            <div role="cell" class="text-truncate">
              <a class="text-monospace" title="string">
                string</a>
            </div>
            <div role="cell">
              <p>Corrèle une série de requêtes au sein d’un même flux.</p>
            </div>
          </div>
          <div class="d-contents" role="row">
            <div role="cell" class="text-truncate" title="data">
              data</div>
            <div role="cell">
              false</div>
            <div role="cell" class="text-truncate">
              <a class="text-monospace"
                href="/api-details#api=moneris-api-2025-02-20-preview-fr&operation=createPayments" title="payment">
                payment</a>
            </div>
            <div role="cell">
              <p>Les données de paiement associées à l'événement.</p>
            </div>
          </div>
        </div>
      </div>
      <code-snippet id="webhookRequestDefinition" style="display: none;">
        <h4></h4>
        <div></div>
        <div class="flex code-snippet code-snippet-bordered">
          <div class="code-snippet-heading">
            <span class="code-snippet-title">json</span>
            <button class="code-snippet-command" aria-label="Copy to clipboard">
              <i class="icon-emb icon-emb-duplicate"></i>
              <span>Copy</span>
            </button>
          </div>
        </div>
        <pre>

{
"title": "webhookRequest",
"required": [
"eventId",
"eventType",
"occuredAt",
],
"type": "object",
"properties": {
"eventId": {
"type": "string"
"description": "Identifiant unique de l'événement. Peut être utilisé comme clé d'idempotence pour éviter les doublons.",
"pattern": "^[A-Za-z]{2}\d{2}[A-Za-z0-9]{26}$",
"minLength": 30,
"maxLength": 30,
"example": "ev0105ARZ3NDEKTSV4RRFFQ69G5FAV"
},
"eventType": {
"type": "string",
"description": "Il s'agit d'une liste de tous les types d'événements que nous envoyons actuellement. RECURRING_PAYMENT_CONFIRMED",
"enum": [
"RECURRING_PAYMENT_CONFIRMED"
]
"example": RECURRING_PAYMENT_CONFIRMED
},
"occuredAt": {
"type": "string",
"description": "Date et heure à laquelle l'événement s'est produit.",
"format": "date-time",
"example": 2025-02-17T18:00:00Z
},
"apiVersion": {
"type": "string",
"description": "The Moneris API Version used to populate the event payload.",
"nullable": true,
"example": 2024-09-17
},
"objectId": {
"type": "string",
"description": "Utilisé pour identifier les ressources API qui peuvent être nécessaires pour les transactions ultérieures futures ; c’est-à-dire les remboursements, les corrections, les achèvements, les annulations, etc.",
"nullable": true,
"example": pi0105ARZ3NDEKTSV4RRFFQ69G5FAV
},
"href": {
"type": "string",
"description": "Localisateur de ressources uniforme pour récupérer les détails des ressources",
"format": "uri-reference",
"nullable": true,
"example": /payments/pi0105ARZ3NDEKTSV4RRFFQ69G5FAV
},
"correlationId": {
"type": "string",
"description": "Correlation Id transmitted during the original request.",
"nullable": true,
"example": "f0d4c76f-f129-4b91-92a3-9a120829bbe5",
},
"data": {
"type": "object",
"description": "Représentation complète de la ressource qui a déclenché l'événement. Pour les paiements, ce sera l'objet Paiement.",
"nullable": true
}
}

Response 200 OK

Votre implémentation de serveur doit renvoyer ce code d'état HTTP si les données ont été reçues avec succès

Response 400 Bad Request

Votre implémentation de serveur doit renvoyer ce code d'état HTTP si le serveur n'a pas réussi à traiter l'événement de rappel

Demandes récentes

Connectez-vous pour voir l'historique complet des demandes

Heure	Statut	Agent utilisateur
Récupération des demandes récentes…

Loading…

Body Params

idempotencyKey

string

required

length between 1 and 36

Identificateur unique requis pour le traitement des demandes idempotentes.

Remarque : Moneris encourage l’utilisation de la version 4 de l’UUID dans les API comme clé d’idempotence.

orderId

string | null

^[a-zA-Z0-9-_]+$

Indique l’identifiant de transaction défini par le commerçant ou l’ID de commande. Les identifiants sont uniques pour chaque transaction d’achat, de préautorisation et de remboursement indépendant

Remarque : Il n’est pas possible que deux transactions de ce type aient le même ID de commande.

invoiceNumber

string | null

Envoie une valeur unique pour identifier une transaction qui est consignée par Solutions Moneris.

subscriptionType

string

enum

required

Type d'abonnement.

RECURRING : Abonnement récurrent.

Allowed:

billingDetails

object

required

Les abonnements vous permettent de configurer des paiements grâce auxquels Moneris traite automatiquement les transactions et facture les clients en votre nom en fonction des informations sur le cycle de facturation que vous fournissez.

callbackUrl

string | null

URL-encodée, URL de rappel entièrement qualifiée qui reçoit la notification d'abonnement.
Remarque : La demande avec une URL qui n'est pas encodée en URL sera rejetée pour des raisons de sécurité.
Exemple (URL encodée) : https%3A%2F%2Fmerchant.example.com%2Fcallback%3ForderId%3D123

oneTimeAmount

object | null

Montant de la première transaction de l'abonnement. La valeur doit être en cents. Par conséquent, 10,59 $ doivent être envoyés sous la forme 1059

paymentMethod

required

Détails du mode de paiement.

Remarque : Si cette option est définie, cela entraînera la création d’un mode de paiement tel que défini dans l’API du mode de paiement.

ecommerceIndicator

string

enum

Defaults to SSL_MERCHANT

Catégorie de transaction e-commerce renvoyée par l’émetteur.
Lorsqu’elle est renvoyée dans le response, elle peut être différente de la valeur envoyée dans la demande au cas où la transaction aurait été déclassée par l’émetteur.

Allowed:

customerId

string | null

^[A-Za-z]{2}\d{2}[A-Za-z0-9]{26}$

Identification unique du client

customerReference

string | null

Identification unique du client. Il peut s'agir d'un identifiant généré à partir d'un identifiant défini par le marchand.

customData

object | null

Le marchand peut envoyer des métadonnées personnalisées avec la transaction dans cet objet. Moneris fera écho à ces valeurs en réponse.

dynamicDescriptor

string | null

Description définie par le commerçant envoyée par transaction et qui apparaîtra sur le relevé de carte de crédit.

En fonction de l’émetteur de la carte, le relevé affiche généralement le descripteur dynamique ajouté au nom commercial existant du commerçant, séparé par le caractère « / ».

Remarque : La longueur combinée du nom commercial du commerçant, de la barre oblique « / » et du descripteur dynamique ne doit pas dépasser 22 caractères.

threeDSecureData

Données liées à 3-D Secure

ipv4

string | null

Protocole Internet version 4 (IPv4).

ipv6

string | null

Protocole Internet version 6 (IPv6).

Headers

Api-Version

string

required

Defaults to 2025-08-14

Version de l’API du point de terminaison.

Doit être fourni dans la section des en-têtes.

X-Correlation-Id

string

Corrèle une série de requêtes au sein d’un même flux.

Remarque : Cet identifiant est généré par Moneris avec chaque demande ou réponse, s’il n’existe pas.
Les commerçants doivent faire écho à la valeur avec chaque demande qui fait partie du flux d’appels.

X-Merchant-Id

string

required

length between 13 and 13

Code d’identification de treize caractères.

Remarque : Ce code est fourni par Moneris et est nécessaire pour identifier le commerçant qui effectue la transaction.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

201Abonnement créé avec succès

400Mauvaise demande.

401Non autorisé. L’utilisateur ne dispose pas d’une clé API ou d’un jeton d’accès valide.

403Interdit. L’utilisateur n’est pas autorisé à accéder à la ressource demandée.

409La demande n’a pas pu être terminée en raison d’un conflit avec l’état de la ressource ou la clé d’idempotence existante.

422L’API ne peut pas effectuer l’action demandée en raison d’erreurs sémantiques ou de validation métier.

429Trop de requêtes

500Erreur inattendue.

503Service temporairement indisponible