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 :
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 :
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 "-".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 4525 XPF |
| 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 : 953 pour le Franc CFP (XPF) (Voir chapitre Liste des devises supportées en annexes) |
| 06 | 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. 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 :
Ex : 0 |
| 09 | Ne pas renseigner. |
| 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 :
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 | Ne pas renseigner. |
Exemples de fichier
- exemple basique :
02;12345678;TEST;ALL MAIL;REGISTER_PAY;CX-1253;3500;953;sample@example.net;;;;;;;; URL;PAYMENT;CX-1255;4000;953;sample@example.net;;;;;;;;
- exemple avancé :
02;12345678;TEST;ALL MAIL;PAYMENT;CX-1253;3500;953;sample@example.net;+330600000000;0;;20240603;;NO_PREFERENCE;true; MAIL;REGISTER;CX-1254;0;953;sample@example.net;+330600000000;0;;20240603;;;; URL;PAYMENT;CX-1255;4500;953;sample@example.net;+330600000000;0;;20240603;;NO_PREFERENCE;true;
Téléchargez le pack d'exemples : https://epaync.nc/doc/files/samples/sample-files.zip.
Vous trouverez les fichiers d'exemple dans le dossier PaymentOrder/V2.