Format V2

Chaque fichier doit être composé d'une série d'enregistrements.

On appelle "enregistrement" une liste de paramètres séparés par le caractère point-virgule ";" et terminés par un retour chariot.

La structure des fichiers est la suivante :

Un enregistrement d'en-tête spécifiant des informations sur la transmission.
Un nombre variable d'enregistrements correspondant chacun à un ordre de paiement.

Notes aux utilisateurs de Microsoft Excel

Un "enregistrement" correspond à une ligne du classeur.
L'enregistrement d'en-tête correspond à la première ligne du fichier.
Les positions ("Pos.") indiquées dans les tableaux ci-dessous (01, 02 etc...) correspondent aux colonnes de votre classeur. Par exemple : "Pos. 01" correspond à la colonne "A", "Pos. 02" correspond à la colonne B.
Si vous ne souhaitez pas valoriser une donnée, laisser la cellule correspondante à vide.
Assurez-vous que toutes les cellules sont au format "Texte".

L'enregistrement d'en-tête

Pos.	Description	Valeurs
01	Version du header	02
02	Identifiant de la boutique	12345678
03	Mode	TEST ou PRODUCTION
04	Canal	ALL

L'enregistrement de détail

Pos.	Description
01	Canal Description : Définit le canal de diffusion. Type : VARCHAR \| Longueur : 32 \| Obligatoire Équivalent API Formulaire : N/A Équivalent API REST : channelOptions.channelType Valeurs possibles : MAIL : ordre de paiement via e-mail SMS : ordre de paiement via SMS URL : ordre de paiement par URL PHONE : ordre de paiement par téléphone WHATSAPP : ordre de paiement via Whatsapp INVOICE : ordre de paiement de facture Ex : MAIL
02	Action Description : Définit l'opération à réaliser. Si le champ est envoyé à vide, la valeur "PAYMENT" est appliquée par défaut. Type : VARCHAR \| Longueur : 32 \| Facultatif Équivalent API Formulaire : vads_page_action Équivalent API REST : formAction Valeurs possibles : PAYMENT : Paiement. REGISTER : Enregistrement du moyen de paiement, sans paiement. Nécessite un montant à "0". Non compatible avec l'utilisation du formulaire de collecte de données. Non disponible pour un ordre de paiement par téléphone. REGISTER_PAY : Enregistrement du moyen de paiement lors du paiement. Non compatible avec l'utilisation du formulaire de collecte de données. Non disponible pour un ordre de paiement par téléphone. ASK_REGISTER_PAY : Paiement avec proposition au porteur de d'enregistrer son moyen de paiement. Non compatible avec l'utilisation du formulaire de collecte de données. Non disponible pour un ordre de paiement par téléphone. Ex : PAYMENT
03	Référence Description : Référence de l'ordre de paiement ou de la commande. Le seul caractère spécial accepté est le tiret "-". Pour un ordre de paiement de facture, cette référence doit être unique et la donnée obligatoire. Type : VARCHAR \| Longueur : 64 \| Facultatif Équivalent API Formulaire : vads_order_id Équivalent API REST : orderId Ex : CX-1254
04	Montant Description : Montant de la transaction exprimé dans la plus petite unité de la devise. Le montant ne peut pas être valorisé à 0, sauf si l'opération à réaliser (Position 02) est "REGISTER". Type : NUMERIC \| Longueur : 13 \| Obligatoire Équivalent API Formulaire : vads_amount Équivalent API REST : amount Ex : 4525 pour 45,25 EUR
05	Devise Description : Code numérique de la devise du paiement (norme ISO 4217). Type : NUMERIC \| Longueur : 3 \| Obligatoire Doit correspondre à la devise de la société. Équivalent API Formulaire : vads_currency Équivalent API REST : currency Ex : 978 pour l'euro (EUR) (Voir chapitre Liste des devises supportées en annexes)
06	E-mail Description : Adresse e-mail de l'acheteur. Obligatoire pour un ordre de paiement via e-mail. Type : VARCHAR \| Longueur : 255 \| Facultatif Équivalent API Formulaire : vads_cust_email Équivalent API REST : customer.email Ex : sample@example.net
07	Téléphone Description : Numéro de téléphone. Obligatoire pour un ordre de paiement via SMS Type : VARCHAR \| Longueur : 255 \| Facultatif Équivalent API Formulaire : N/A Équivalent API REST : channelOptions.smsOptions.phoneNumber Ex : +33600000000
08	Validation Description : Mode de validation. Pour plus d'informations, consultez le chapitre "Paramétrer le mode de validation par défaut" du manuel utilisateur Gestion des transactions. Type : NUMERIC \| Longueur : 1 \| Facultatif \| Équivalent API Formulaire : vads_validation_mode Équivalent API REST : cardOptions.manualValidation Valeurs possibles : 0 : pour validation automatique 1 : pour validation manuelle Vide : pour utiliser le mode de validation configuré par défaut. Ex : 0
09	Description Description : Description de la facture. Le champ n'est pris en compte que pour un ordre de paiement de facture. Cette description sera affichée à l'acheteur après saisie de la référence de la facture sur le formulaire de collecte de données. Pour guider l’acheteur et le rassurer, la zone "Description" permet au marchand d’afficher à son acheteur des informations précisant la facture. Cette description est affichée lorsque l'acheteur clique sur le symbole "?" à droite du champ de saisie "Référence". Pour être en conformité avec la RGPD, il est conseillé de limiter l'affichage d'informations personnelles dans ce champ. Par exemple, pour le règlement d'un loyer, préciser la période de facturation et la référence du logement plutôt que le nom du locataire. Type : VARCHAR \| Longueur :128 \| Facultatif Équivalent API Formulaire : vads_order_description Équivalent API REST : description Ex : My order description
10	Validité Description : Date de fin de validité de l'ordre de paiement. Ne peut pas être antérieure à la date courante et ne peut pas dépasser 90 jours. Si ce paramètre n'est pas envoyé, la valeur appliquée sera celle définie dans le paramétrage de la boutique (menu Paramétrage > Boutique, onglet Configuration). Type : NUMERIC \| Longueur : 8 \| Facultatif \| Équivalent API Formulaire : N/A Équivalent API REST : expirationDate Ex : 20210603
11	Ne pas renseigner.
12	Préférence authentification 3D Secure Description : Préférence marchand relative à l'authentification 3DS. Si le champ est envoyé à vide, la valeur "NO_PREFERENCE" est appliquée par défaut. Type : VARCHAR \| Longueur : 32 \| Facultatif Équivalent API Formulaire : vads_threeds_mpi Équivalent API REST : strongAuthentication Valeurs possibles : FRICTIONLESS : Demande d'authentification sans interaction de l'acheteur. NO_PREFERENCE : Délégation à l'émetteur de la carte. CHALLENGE_REQUESTED : Demande d'authentification avec interaction de l'acheteur. CHALLENGE_MANDATE : Demande d'authentification avec interaction de l'acheteur pour des raisons réglementaires. Ex : NO_PREFERENCE
13	Formulaire de collecte de données Description : Utilisation du formulaire de collecte de données. Ce champ doit être valorisé à true si transmis. Type : BOOLEAN \| Longueur : 1 \| Facultatif Équivalent API Formulaire : N/A Équivalent API REST : dataCollectionForm Ex : true
14	Référence SVI Description : Référence de l'ordre de paiement sur le serveur vocal interactif (SVI). Ce champ n'est pris en compte que pour un ordre de paiement par téléphone. Type : VARCHAR \| Longueur : 20 \| Facultatif Équivalent API Formulaire : N/A Équivalent API REST : channelOptions.ivrOptions.ivrPaymentOrderId Ex : 1234

Exemples de fichier

exemple basique :

02;12345678;TEST;ALL
MAIL;REGISTER_PAY;CX-1253;3500;978;sample@example.net;;;;;;;;
URL;PAYMENT;CX-1255;4000;978;sample@example.net;;;;;;;;
SMS;PAYMENT;CX-1254;3000;978;;+330600000000;;;;;;true;
INVOICE;PAYMENT;CX-1256;2000;978;sample@example.net;;;My order description;;;;;

exemple avancé :

02;12345678;TEST;ALL
MAIL;PAYMENT;CX-1253;3500;978;sample@example.net;+330600000000;0;;20240603;;NO_PREFERENCE;true;
MAIL;REGISTER;CX-1254;0;978;sample@example.net;+330600000000;0;;20240603;;;;
URL;PAYMENT;CX-1255;4500;978;sample@example.net;+330600000000;0;;20240603;;NO_PREFERENCE;true;
SMS;PAYMENT;CX-1256;3000;978;sample@example.net;+330600000000;0;;20240603;;NO_PREFERENCE;;

Téléchargez le pack d'exemples : https://docs.lyra.com/files/samples/sample-files-collect.zip.

Vous trouverez les fichiers d'exemple dans le dossier PaymentOrder/V2.

Catégories

Tags

Format V2