• France
état des services
démonstrations
assistance
FAQContacter le support
Video tutorials
Rechercher
Catégories
Tags
Français
Français
Anglais
Accueil
Cas d'usage
Créer un paiement
Créer un paiement en plusieurs fois
Proposer un paiement complémentaire
Créer un paiement par alias (token)
Créer un lien de paiement
Créer un paiement à l'expédition
Créer un abonnement
Gérer vos abonnements
Gérer vos transactions (rembourser,...)
Analyser vos journaux
Docs API
Formulaire embarqué
API REST
Formulaire en redirection
Intégration mobile
Échange de fichiers
Exemples de code
Moyens de paiement
Modules de paiement
Guides
Back Office Marchand
Guides fonctionnels

vads_sub_desc

Description Paramètre obligatoire utilisé dans le cas de la création d'un abonnement.

Il définit la règle de l’abonnement à appliquer.

La valeur attendue dans ce paramètre est une chaîne de caractères suivant la spécification iCalendar, ou Internet Calendar, décrite dans la RFC5545 (voir http://tools.ietf.org/html/rfc5545).

Cette spécification permet entre autre de définir des règles complexes d’abonnement, via la propriété RRULE.

Pour des raisons techniques, il n’est pas possible de définir des périodes d’abonnement inférieures à une journée.

Les mots clés "SECONDLY" / "MINUTELY" / "HOURLY" ne sont donc pas pris en compte.

Exemple pour un abonnement mensuel :

  • Si le jour courant est inférieur à "28", utilisez la règle :
    RRULE:FREQ=MONTHLY;BYMONTHDAY=15
    Dans cet exemple, le jour courant est le "15".
  • Si le jour courant est supérieur ou égal à "28", utilisez la règle :
    RRULE:FREQ=MONTHLY;BYMONTHDAY=28,29,30,31;BYSETPOS=-1;

Exemples de règles de récurrence courantes :
  • Pour définir des échéances de paiement ayant lieu le dernier jour de chaque mois, pendant 12 mois, la règle s’écrit :

    RRULE:FREQ=MONTHLY;BYMONTHDAY=28,29,30,31;BYSETPOS=-1;COUNT=12

    Cette règle signifie que si le mois courant ne contient pas de 31, alors le moteur prendra en compte le 30. Si le 30 n’existe pas, alors il prendra en compte le 29 et ainsi de suite jusqu’au 28.

    Une autre version de cette règle : RRULE:FREQ=MONTHLY;COUNT=5;BYMONTHDAY=-1

  • Pour définir des échéances de paiement ayant lieu le 10 de chaque mois, pendant 12 mois, alors la règle d’abonnement s’écrit de la manière suivante : RRULE:FREQ=MONTHLY;COUNT=12;BYMONTHDAY=10

  • Pour définir des échéances de paiement ayant lieu chaque trimestre, jusqu’au 31/12/2036 : RRULE:FREQ=YEARLY;BYMONTHDAY=-1;BYMONTH=1,4,7,10;UNTIL=20361231

    Les échéances auront lieu chaque 1er de janvier, avril, juillet et octobre. Leur nombre total dépend de la date d’effet de l’abonnement (voir paramètre vads_sub_effect_date).

  • Pour définir un abonnement toutes les semaines, le lundi: RRULE:FREQ=WEEKLY;BYDAY=MO

    Les échéances auront lieu tous les lundis. Attention la première échéance sera le prochain lundi.

  • Pour définir un abonnement toutes les semaines: RRULE:FREQ=WEEKLY

    Les échéances auront lieu le jour même si la date d'effet est positionnée à "aujourd'hui" puis tous les 7 jours.

  • Pour définir un abonnement toutes les deux semaines le lundi, limité à 4 occurences: RRULE:FREQ=WEEKLY;INTERVAL=2;COUNT=4;BYDAY=MO

  • Pour définir un abonnement toutes les deux semaines, aujourd’hui et tous les 7 jours: RRULE:FREQ=WEEKLY;INTERVAL=2;

  • Pour plus de détails et d'exemples vous pouvez consulter le site http://recurrance.sourceforge.net/.

Champ d'entrée et de sortie, retourné dans la réponse (IPN et URL de retour).

Format string
Code erreur 64
Catégorie Informations sur l'abonnement.
© 2025 Tous droits réservés à Scellius
25.18-1.11