Format V1
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 « ; », 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.
Le nombre d'enregistrements présents dans le fichier influe directement sur le temps de traitement du fichier ainsi que sur la mise à disposition du fichier de retour. Au-delà de 2000 enregistrements, il est conseillé de générer plusieurs fichiers de paiement
Au-delà de 2000 enregistrements, il est conseillé de générer plusieurs fichiers de paiement.
L'enregistrement d'en-tête
Pos. | Description | Valeurs |
---|---|---|
01 | Version du header | 01 |
02 | Identifiant de la boutique | 12345678 |
03 | Mode | TEST ou PRODUCTION |
04 | Canal |
L'enregistrement de détail
Pos. | Description |
---|---|
01 | 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 :
Ex : PAYMENT |
02 | Description : Référence de l'ordre de paiement
ou de la commande. Le seul caractère spécial accepté est le tiret
"-". Type : VARCHAR | Longueur : 64 | Facultatif Équivalent API Formulaire : vads_order_id Équivalent API REST : orderId Ex : CX-1254 |
03 | 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 01) est "REGISTER". Type : NUMERIC | Longueur : 13 | Obligatoire Équivalent API Formulaire : vads_amount Équivalent API REST : amount Ex : 4525 pour 45,25 EUR |
04 | 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) |
05 | Description : Adresse e-mail de l'acheteur. Type : VARCHAR | Longueur : 255 | Obligatoire Équivalent API Formulaire : vads_cust_email Équivalent API REST : customer.email Ex : sample@example.net |
06 | Description : Mode de validation. Pour plus
d'information, 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 :
Ex : 0 |
07 | Description : Description de la facture. Le champ est ignoré pour un ordre de paiement par e-mail. Type : VARCHAR | Longueur : 255 | Facultatif |
08 | 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 |
09 | Description : Champ spécifique à l'Amérique Latine. Taux de taxe
appliqué sur l’ensemble de la commande. La valeur doit être le
pourcentage à appliquer (19.6 pour 19.6%). Type : NUMERIC | Longueur : 4 | Facultatif Équivalent API Formulaire : vads_tax_rate Équivalent API REST : taxRate Ex : 19.6 |
10 | 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 :
Ex : NO_PREFERENCE |
11 | Description : Utilisation du formulaire de collecte de données. Peut
être envoyé à true seulement si l'action à réaliser est
PAYMENT. Type : BOOLEAN | Longueur : 1 | Facultatif |Équivalent API Formulaire : N/A Équivalent API REST : dataCollectionForm Valeurs
possibles :
Ex : true |
Exemples de fichier
- exemple basique :
01;12345678;TEST;MAIL PAYMENT;CX-1254;3000;978;sample@example.net;;;;;; REGISTER;CX-1255;0;978;sample@example.net;;;;;; REGISTER_PAY;CX-1256;3990;978;sample@example.net;;;;;; ASK_REGISTER_PAY;CX-1257;11000;978;sample@example.net;;;;;;
- exemple avancé :
01;12345678;TEST;MAIL PAYMENT;CX-1254;3000;978;sample@example.net;0;;20210603;;NO_PREFERENCE;true REGISTER;CX-1255;0;978;sample@example.net;0;;20210603;;NO_PREFERENCE; REGISTER_PAY;CX-1256;3990;978;sample@example.net;0;;20210603;;NO_PREFERENCE; ASK_REGISTER_PAY;CX-1257;11000;978;sample@example.net;0;;20210603;;NO_PREFERENCE;
Téléchargez le pack d'exemples : https://sogecommerce.societegenerale.eu/doc/files/samples/sample-files.zip.
Vous trouverez les fichiers d'exemple dans le dossier MAIL.