support
Retour à la documentation
Rechercher
Catégories
Tags
Paramètres principauxtout montrer
amount
requis
currency
requis
effectDate
requis
paymentMethodToken
requis
rrule
requis
orderId
recommandé
options générales
comment
description
initialAmount
initialAmountNumber
metadata
[1]
:
options relatives à la méthode de paiement
transactionOptions
cardOptions
paymentSource
mid
manualValidation
captureDelay
firstInstallmentDelay
installmentNumber
retry
debitCreditSelector
initiatedTransactionIndicator
initialIssuerTransactionIdentifier
Testez moi
Documentation

Web service Charge/CreateSubscription

L'appel aux Web Services requiert une authentification HTTP Basic Authentication. Plus d'infos : "Phase d'authentification".

POSThttps://api.lyra.com/api-payment/V4/Charge/CreateSubscription

Le Web Service REST Charge/CreateSubscription permet de réaliser des paiements récurrents (abonnements) à partir d’un alias (Création d'un alias).

Pour les prélèvements SEPA, intégrez dans le champ paymentMethodToken la référence unique du mandat (RUM) et une date d'effet supérieure ou égale à 14 jours.

Pour être notifié du résultat d'une échéance, la règle "URL de notification à la création d'un abonnement" doit être activée et configurée depuis le Back Office Expert (menu Paramétrage > Règles de notifications).

Consultez les paramètres de la réponse : Subscription.

Paramètres d'entrée

amount

Montant du paiement dans sa plus petite unité monétaire (le centime pour l'euro).

Exemple: 30050 pour 300,50 EUR.

Format

currency

Devise du paiement. Code alphabétique en majuscule selon la norme ISO 4217 alpha-3.

Exemple: "EUR" pour l'euro.

Format

Valeurs possibles

Les valeurs possibles sont les suivantes:

Devise CODIFICATION ISO 4217 Unité fractionnaire
Dollar australien (036) AUD 2
Dollar canadien (124) CAD 2
Franc suisse (756) CHF 2
Couronne danoise (208) DKK 2
Euro (978) EUR 2
Livre Sterling (826) GBP 2
Yen (392) JPY 0
Couronne norvégienne (578) NOK 2
Couronne suédoise (752) SEK 2
Dollar des États-Unis (840) USD 2

comment

Commentaire libre.

Format

description

Description associée à l'abonnement.

Format

effectDate

Date de début de l’abonnement au format ISO 8601.
Il est recommandé de transmettre une valeur dans le fuseau UTC. L'heure doit être fixée à "00:00:00".

Exemple : 2025-01-14T00:00:00+00:00

La valeur de effectDate ne doit pas être dans le passé.

Ce paramètre ne coïncide pas systématiquement avec la date de la première échéance, qui dépend uniquement du paramètre rrule.

Format

initialAmount

Montant des premières échéances. Sa valeur doit être un entier positif (ex: 1234 pour 12.34 EUR).

Format

initialAmountNumber

Nombre d'échéances auxquelles appliquer le montant défini dans initalAmount.

Format

metadata

Valeurs personnalisées rattachées à la transaction, au format json.

Exemple d'appel

Par exemple, pour passer une valeur personnalisée, ajoutez à votre requête :

{
    "metadata": {
        "MyValueKey": "1234"
    }
}

Cette valeur sera retournée dans l'objet transaction nouvellement créé.

Vous pouvez aussi utiliser les metadatas "orderInfo", "orderInfo2" et "orderInfo3" pour transmettre des informations additionnelles sur la commande.

Ces données seront ensuite visibles dans l'onglet Extra du détail de la transaction depuis votre Back Office Expert.

Format

paymentMethodToken

Alias (ou token) associé à un moyen de paiement.

Format

orderId

Référence de la commande définie par le marchand. Ne prend pas en charge les caractères UTF-8.

Format

rrule

Description de la règle de l'abonnement sous forme de rrule (RFC-5545).

Pour plus d'informations sur comment générer une RRULE:

  • Specification d'une RRULE
  • Générateur de RRULE
  • Exemples de règles de récurrence

Pour des raisons techniques, il est impossible 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.

Format

paymentSource

Chemin: transactionOptions.cardOptions.paymentSource

Origine du paiement.

Format

Valeurs possibles

Les valeurs possibles sont les suivantes:

Valeur Description
EC E-Commerce: les données du moyen de paiement sont saisies par l'acheteur. Cette valeur permet d'avoir une authentification forte lors du paiement.
MOTO MAIL OR TELEPHONE ORDER: Saisie réalisée par un opérateur. Les informations du moyen de paiement sont transmises par courrier ou par e-mail. Nécessite un contrat de type VAD.
CC Call Center: paiement effectué via un centre d’appel. Nécessite un contrat de type VAD.
OTHER Autre canal de vente. Valeur de sortie retournée pour les paiements réalisés depuis le Back Office Marchand, les paiements par fichier, les paiements récurrents, les paiements de proximité, les remboursements depuis le CMS Shopify.
Absent ou null La valeur par défaut est "EC".

mid

Chemin: transactionOptions.cardOptions.mid

Numéro de contrat commerçant. Si ce champ est renseigné, veillez à utiliser le bon contrat en fonction du réseau de la carte.

Un contrat CB ne peut être utilisé pour une transaction AMEX.

Format

manualValidation

Chemin: transactionOptions.cardOptions.manualValidation

Mode de validation de la transaction.

Format

Valeurs possibles

Les valeurs possibles sont les suivantes:

Valeur Description
NO Validation automatique par la plateforme de paiement.
YES Validation manuelle par le marchand.
null Configuration par défaut de la boutique retenue (paramétrable dans le Back Office Marchand).

captureDelay

Chemin: transactionOptions.cardOptions.captureDelay

Délai à appliquer à la date de capture.

Description

Indique le délai en nombre de jours avant remise en banque.

Si ce paramètre n’est pas transmis, alors la valeur par défaut définie dans le Back Office Expert sera utilisée.

Cette dernière est paramétrable dans le Back Office Expert par toutes les personnes dûment habilitées.

Si le délai avant remise est supérieur à 365 jours dans la requête de paiement, il est automatiquement repositionné à 365 jours.

Format

firstInstallmentDelay

Chemin: transactionOptions.cardOptions.firstInstallmentDelay

Nombre de mois de différé à appliquer sur la première échéance d'un paiement en plusieurs fois. Champ spécifique aux acquéreurs d’Amérique Latine.

Format

installmentNumber

Chemin: transactionOptions.cardOptions.installmentNumber

Nombre d'échéances.

Format

retry

Chemin: transactionOptions.cardOptions.retry

Nombre de nouvelles tentatives disponibles en cas de refus de paiement (1 par défaut).

Format

debitCreditSelector

Chemin: transactionOptions.cardOptions.debitCreditSelector

Ce champ est spécifique au Brésil pour la gestion des cartes multiplo.

Les cartes "multiplo" sont des cartes de paiement (Elo, Visa ou Mastercard), permettant de régler :

  • soit en débit immédiat : le montant est débité tout de suite, et le marchand est crédité à J+1.
  • soit en crédit : le débit est différé et le montant peut être débité en une ou plusieurs échéances. Le marchand est crédité plus tard de la totalité ou seulement d'une partie du montant total.

Ce champ permet de forcer l'utilisation de la carte en débit ou en crédit.

Valeurs possibles

valeurs Description
DEBIT Utilisation de la fonction "débit" de la carte
CREDIT Utilisation de la fonction "crédit" de la carte

Format

Référence de la réponse

Le web service retourne l'objet suivant:

Réponse Contexte
SubscriptionCreated Objet contenant le détail de l'abonnement créé.

Voir la référence de la réponse pour plus de détails.