Importer les données d'un mandat existant
POST .../mandates
Ce Web Service permet de générer une RUM et donc de permettre les paiements via notre plateforme.
Il ne permet pas de mettre à jour la RUM ni la date de dernière utilisation du mandat.
Paramètres
| iban IBAN. Identifiant du compte bancaire du débiteur. | String Requis |
| last_name Nom du débiteur. | String Requis |
| first_name Prénom du débiteur. | String Requis |
| email E-mail du débiteur. | String Requis |
| payment_type Type de mandat :
| String Requis |
| locale Langue de génération du mandat. Code ISO 639-1 Alpha-2. Ex: FR, DE, ES, IT, EN, PT, PL, NL, SV | String Requis |
| bic BIC. Identifiant international de la banque du débiteur. | String Optionnel |
| title Civilité du débiteur. | String Optionnel |
| callback_url URL de callback appelée après l'import du mandat. | String Optionnel |
| send_mails Si ce champ est valorisé à True, Lyra Collect enverra les e-mails d'enregistrement du mandat à l'acheteur et au marchand à l'issue d'une opération de création ou de mise à jour d'un mandat. Valeur par défaut : False | Bool Optionnel |
| fetch_address Permet d'indiquer si l'objet address est retourné dans la réponse. Valeur par défaut : false. | Bool Optionnel |
| address Adresse du débiteur. | Recommandé |
Objet address
Certaines banques vérifient la présence de ces informations pour accepter une demande de prélèvement.
L'adresse est requise si le client possède un compte bancaire dans les départements, territoires ou pays suivants : Suisse, Monaco, Saint-Marin, Mayotte, Saint-Pierre-et-Miquelon, Guernesey, Jersey, Île de Man.
| country Code du pays suivant la norme ISO 3166 alpha-2. Ex: FR | String Recommandé |
| city Ville. | String Optionnel |
| district Quartier. | String Optionnel |
| state Etat / Région. | String Optionnel |
| street Nom de rue. | String Optionnel |
| street_number Numéro de voie. | String Optionnel |
| street2 Deuxième ligne d'adresse. | String Optionnel |
| zip Code postal. | String Optionnel |
Exemple
Requête
POST https://secure.lyra.com/sdd/mandates{
"bic":"iban":"FR7630002005701234567890158",
"title":"M.",
"last_name":"Durand",
"first_name":"Michel",
"email":"mdurand@ymail.com",
"payment_type":"RECURR",
"locale":"FR",
"address":{
"street_number":"109",
"street":"rue de l'Innovation",
"street2":"Bat 1",
"district":"Labège-Innopole",
"zip":"31670",
"city":"Labège",
"country":"FR",
"state":"Occitanie"
},
"fetch_address": true
}Réponse:
{
"identifier":"94aebef39d0349a09fb525a80a6e0d55",
"rum":"94aebef39d0349a09fb525a80a6e0d55",
"id":"12345678-94aebef39d0349a09fb525a80a6e0d55",
"title":"M.",
"email":"mdurand@ymail.com",
"first_name":"Michel",
"last_name":"Durand",
"address":{
"street_number":"109",
"street":"rue de l'Innovation",
"street2":"Bat 1",
"district":"Labège-Innopole",
"zip":"31670",
"city":"Labège",
"country":"France",
"state":"Occitanie"
},
"site":"12345678",
"created_at":1634047398000,
"fetch_address":true
}