Abonnement

Le service d’abonnement vous permet se réaliser automatiquement des transactions récurrentes sur vos profils clients en se basant sur un modèle d’abonnement défini en amont depuis l’API CentralPay ou le Portail Marchand. Il est ensuite possible d’ajouter des échéances ou de modifier leur montant à la volée depuis les services Invoice & Invoice Item.

Ce service permet de générer soit des transactions carte, soit des transactions SDD (prélèvement SEPA).

Définitions utiles pour cette section : – SubscriptionModel :  modèle d’abonnement (définissant le montant et la fréquence d’abonnement) – Subscription :  abonnement appliqué à un client – Invoice :  facture, option à utiliser si vous devez modifier la valeur à l’intérieur d’un plan d’abonnement – InvoiceItem :  ligne ou article inclus dans la facture. Une facture a potentiellement plusieurs lignes ou éléments

ℹ️ Le service "Subscription" n'est pas le seul moyen de réaliser des transactions récurrentes. 
Consultez la page Transaction carte récurrente ou la page Transaction par prélèvement pour prendre connaissance du détail par moyen de paiement.

1. Créer un modèle d’abonnement (subscriptionModel)

Accès :

Le subcriptionModel vous permet de pouvoir créer différents types d’abonnements en fonction de vos services proposés. Par exemple, si vous avez à votre disposition deux types d’offre d’abonnement, le premier en utilisant les caractéristiques de base de votre service et l’autre en utilisant les fonctionnalités avancées, vous allez devoir créer deux modèles :

• Un pour l’offre d’abonnement « basique »
• Un pour l’offre d’abonnement « avancé »

Chaque « SubscriptionModel » possède un ID unique. Vous fournirez cet identifiant dans vos requêtes API lorsque vous souhaiterez appliquer un abonnement à un client sur la base de ce modèle.

Vous pouvez utiliser les attributs suivants :

• amount : montant à renseigner en centimes
• intervalUnit : DAY / WEEK / MONTH / YEAR (jour / semaine / mois / année)
• intervalCount : nombre de « intervalUnit » entre deux échéances (ex : si intervalUnit = DAY et intervalCount = 10, alors il y aura une transaction tous les 10 jours)
• iterationCount : nombre d’échéances (attention la première transaction n’est pas comptabilisée dans ce paramètre, elle s’ajoute donc à ce nombre)

Exemple :

• amount = 3000
• intervalUnit = DAY
• intervalCount = 3
• iterationCount = 3

Ainsi votre modèle d’abonnement sera configuré pour facturer à votre client 30,00 EUR tous les 3 jours pendant 4 échéances (pour un total d’un abonnement de 12 Jours).

2. Créer un abonnement (subscription)

Pour créer un abonnement, vous devez d’abord créer un Customer contenant au moins :

• Une Card (si vous souhaitez opérer des transactions carte)
• Ou un Mandate (si vous souhaitez opérer des transactions par prélèvement SEPA)

Vous pouvez ensuite créer une Subscription :

• Selon le moyen de paiement souhaité :
  • pour des transactions carte : renseignez l’identifiant du profil client « customerId »
  • pour des transactions par prélèvement SEPA : renseignez l’identifiant du mandat SEPA « mandateId » et renseignez la date souhaitée de la transaction dans « requestedCollectionDate »
  • pour des transactions entre comptes CentralPay : renseignez l’identifiant du compte émetteur « walletId »
• Renseignez l’identifiant du modèle d’abonnement « subscriptionModelId »
• Renseignez l’IP de votre client dans « endUserIp »
• Renseignez l’identifiant de votre point de vente CentralPay dans « pointOfSaleId »

Notez qu’à la création d’un abonnement, votre client reçoit automatiquement un email contenant le détail de ses échéances. Cet email contient également un lien vers notre Portail client qui lui permet de visualiser le statut de ses paiements récurrent, de changer sa carte bancaire ou son mandat SEPA et de résilier un abonnement si besoin est.

ℹ️ Un client pouvant à tout moment résilier son abonnement depuis le portail client mis à sa disposition. Veillez à vous inscrire aux webhooks d'annulation d'abonnement. Si votre abonnement comprend une période d'engagement, il est préférable d'utiliser la méthode d'abonnement par transactions successives, ou demander à CentralPay de ne pas diffuser le lien vers le portail client.

3. Automatisation des nouvelles tentatives en cas d’échec

En cas d’échec de prélèvement d’une échéance, CentralPay réalise de nouvelles tentatives de prélèvement selon les paramètres définis dans le Portail Marchand.

Accès :

Comportement des champs :

• Heure de transaction : heure à laquelle les échéances de prélèvement seront réalisées par CentralPay
  • Sélection d’une valeur de 4 à 23
• 1er échec de paiement de facture : comportement en cas d’un premier échec de prélèvement
  • Réessayer dans 1, 3, 5 ou 7 jours = nouvelle tentative de prélèvement à J+X après la transaction initiale
  • Stop = le système appliquera directement l’action finale, sans prendre en compte les actions suivantes.
• 2nd échec de paiement de facture : comportement en cas d’un deuxième échec de prélèvement
  • Réessayer dans 1, 3, 5 ou 7 jours = nouvelle tentative de prélèvement à J+X après la précédente tentative
  • Stop = le système appliquera directement l’action finale, sans prendre en compte les actions suivantes.
• 3eme échec de paiement de facture : comportement en cas d’un troisième échec de prélèvement
  • Réessayer dans 1, 3, 5 ou 7 jours = nouvelle tentative de prélèvement à J+X après la précédente tentative
  • Stop = le système appliquera directement l’action finale, sans prendre en compte les actions suivantes.
• Action finale : comportement si les actions précédentes ont échoué
  • CANCELED = Annulation de l’abonnement (modification du statut de l’abonnement en CANCELED)
  • FAILURE = Échec de l’abonnement (modification du statut de l’abonnement en FAILURE)
  • UNPAID = Abonnement impayé (modification du statut de l’abonnement en FAILURE + envoi de hook SUBSCRIPTION_UNPAID)

4. Fonctions d’annulation des abonnements

Il existe deux fonctions d’annulation d’abonnement depuis l’API, le Portail Marchand ou le Portail Client :

• Annuler : l’abonnement est annulé immédiatement
• Annuler en fin de période : l’abonnement sera annulé à la fin de l’échéance en cours (afin de laisser l’abonné bénéficier de votre service durant sa dernière période payée). Par API, vous devrez renseigner le champ « atPeriodEnd ».
  • Note : Durant ce laps de temps, vous pouvez réactiver l’abonnement avec le service « reactivate » des Subscription.

ℹ️ Les abonnements dont l'ensemble des échéances ont été réalisées passent automatiquement en statut CANCELED.

5. Modifier le montant d’une échéance d’abonnement

CentralPay crée un invoice pour chaque échéance d’un abonnement (Subscription), selon le modèle d’abonnement associé (subscriptionModel).

Vous pouvez procéder à des actions manuelles à n’importe quel moment pour modifier les échéances (invoice) d’un abonnement (subscription). Vous trouverez ci-dessous une liste d’actions possibles :

• Modifier le montant d’une échéance : Le service invoiceItem vous permet de modifier le montant d’une échéance (invoice) en renseignant un montant positif ou négatif qui s’additionnera au montant initial de l’échéance. L’invoiceItem sera pris en compte lors de la prochaine échéance de l’abonnement, qu’elle soit créée manuellement ou automatiquement. Vous avez également la possibilité de spécifier une échéance donnée dans votre requête en renseignant un invoiceId.
• Créer une échéance supplémentaire : les échéances (invoice) dites « périodiques » sont créées automatiquement selon votre subscriptionModel. Vous avez la possibilité de créer d’autres échéances ponctuelles sur votre abonnement en créant une invoice.
• Supprimer un invoiceItem non traité : s’il n’est pas encore lié à une facture
• Fermer une échéance à venir : si vous souhaitez que CentralPay ne réalise pas le prélèvement d’une échéance (et/ou ses nouvelles tentatives automatiques), vous pouvez fermer cette dernière depuis le service « close » de l’invoice. Au besoin vous pourrez rouvrir cette échéance via le service « reopen » de l’invoice, si elle n’a pas été payée ou qu’il reste des nouvelles tentatives programmées.
• Forcer le paiement d’une échéance : les transactions sont effectuées automatiquement par le service d’abonnement, vous pouvez cependant initier la transaction en avance ou réaliser une nouvelle tentative manuellement avec le service « pay » de l’invoice. Ces paiements « manuels » ne sont pas comptabilisés par le système de nouvelles tentatives automatisées. Cette action peut être effectuée sur une facture fermée.

6. Schéma complet de création d’un abonnement