GuidesRéférence APIChangelog
Log In
Référence API
  1. API de Moneris
  2. Abonnements

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

Corps de la requête Webhook

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.

Nom

Requis

Information supplémentaire

Description

eventId

true

string

Identifiant unique de l'événement. Peut être utilisé comme clé d'idempotence pour éviter les doublons.

eventType

true

string

Voici une liste de tous les types d'événements que nous envoyons actuellement.

  • RECURRING_PAYMENT_CONFIRMED: Une transaction de paiement d'abonnement a été exécutée.

occuredAt

true

date-time

l'horodatage du moment où l'événement s'est produit (pas nécessairement le même que celui où il a été livré)

apiVersion

false

string

La version de l'API Moneris utilisée pour remplir le corps de l'événement.

objectId

false

string

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.

href

false

string

Localisateur de ressources uniforme pour récupérer les détails des ressources

correlationId

false

string

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

data

false

payment

Les données de paiement associées à l'événement.

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
HeureStatutAgent utilisateur
Récupération des demandes récentes…
LoadingLoading…
Body Params
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.

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.

string | null

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

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.

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.

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:
string | null
^[A-Za-z]{2}\d{2}[A-Za-z0-9]{26}$

Identification unique du client

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.

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

string | null

Protocole Internet version 4 (IPv4).

string | null

Protocole Internet version 6 (IPv6).

Headers
string
required
Defaults to 2026-01-22-preview

Version de l’API du point de terminaison.

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

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.

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

Mise à jour il y a 3 mois

Cette page vous a-t-elle aidé ?
Langue
Identifiants
1 champ d'application requis manquant
URL
LoadingLoading…
Réponse
Cliquez sur Essayer ! pour lancer une requête et voir la réponse ici ! Ou choisissez un exemple:
application/json
application/problem+json
*/*

Mise à jour il y a 3 mois

Cette page vous a-t-elle aidé ?