Générer un fichier de paiement (REQ)

Le fichier de demandes de paiement sera constitué 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. On a donc un enregistrement par ligne.

Ce type de format est communément appelé « CSV » (pour Comma Separated Values), et est notamment reconnu par MS Excel.

Le fichier aura la structure suivante :

  • Un enregistrement d’entête spécifiant des informations sur la transmission.
  • Un nombre variable d’enregistrements contenant les informations des paiements à effectuer.
  • Un enregistrement de fin, permettant de s’assurer de la cohérence du fichier transmis.

Le nombre d'enregistrements présents dans le fichiers 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.

Exemple:

Un fichier de test est déposé le 30/11/2018 pour la boutique 12345678. Il contient deux demandes de paiement, avec comme paramètres :

Premier paiement par alias :

  • ID : ‘ALIAS-TEST-1
  • Numéro de transaction : 000001
  • Montant : 935,99 EUR

Deuxième paiement par identifiant :

  • ID : ‘ALIAS-TEST-2
  • Numéro de transaction : 000002
  • Montant : 75,90 EUR

  1. Nommez le fichier en respectant le format <AAAAMMJJ>.<siteID>.PAY.REQ.<z>.<xx>.

    Où :

    • <AAAAMMJJ> représente la date de génération du fichier.
    • <siteID> représente le numéro de boutique qui vous a été attribué (vads_site_id).
    • <z> prend soit la valeur « T » pour un fichier en mode TEST, soit la valeur « P » pour un fichier en mode PRODUCTION.
    • <xx> correspond au numéro séquentiel du fichier dans la journée, sur 2 caractères numériques.

    Le fichier de l'exemple proposé se nomme 20181130.12345678.PAY.REQ.T.01

  2. Renseignez l'enregistrement d'entête avec les valeurs présentées ci-dessous:
    Pos. Description Format Valeurs Equivalence
    01 Code d'enregistrement n2 00  
    02 Type de fichier   PAY  
    03 Version du fichier n2 02  
    04 Identifiant de la boutique n8 12345678 vads_site_id
    05 Environnement (TEST ou PRODUCTION)   TEST vads_ctx_mode
    06 Date de création n8 Au format AAAAMMJJ  
    07 Heure de création n6 Au format HHMMSS  
    08 Date d'éxécution demandée. n8

    Réservé à usage futur.

    Ne pas renseigner
     
  3. Renseignez chaque enregistrement de détail en respectant le format ci-dessous:
    Pos. Description Format Valeurs Equivalence
    01 Code d'enregistrement n2 02  
    02 Numéro de séquence de l’enregistrement détail dans le fichier. n..6 Démarre à 1  
    03 Date de la transaction n8 Au format AAAAMMJJ vads_trans_date
    04 Heure de la transaction n6 Au format HHMMSS vads_trans_date
    05 Identifiant de transaction n..6 Unique sur la journée et partagé avec les autres modes de paiement vads_trans_id
    06 Type de transaction a2 CD  
    07 Montant n..12 Dans sa plus petite unité monétaire. vads_amount
    08 Code de la devise n3 Ex : 978 pour l'euro (EUR) vads_currency
    09 Date de remise demandée n8 Au format AAAAMMJJ.

    Vide pour indiquer la date du jour

     
    10 Mode de validation n..1

    0: pour validation automatique

    1: pour validation manuelle

    Vide: pour utiliser le mode de validation configuré par défaut
    vads_validation_mode
    11 Alias de carte ans..50 Alias de la carte à utiliser lors du prélèvement vads_identifier
    12 Contrat commerçant à utiliser. ans..250 Laisser à vide pour utiliser celui par défaut. vads_contract_used
    13 Référence de commande ans..32 Laisser à vide si non utilisé vads_order_id
    14 Informations sur la commande 1 ans..255 Laisser à vide si non utilisé vads_order_info
    15 Informations sur la commande 2 ans..255 Laisser à vide si non utilisé vads_order_info2
    16 Informations sur la commande 3 ans..255 Laisser à vide si non utilisé vads_order_info3

  4. Renseignez l'enregistrement de fin en respectant le format ci-dessous:
    Pos. Description Format Valeurs
    01 Code enregistrement n2 01
    02 Nombre d’enregistrements détail transmis n..6 Ex:2.

    Il est conseillé de ne pas dépasser 2000 enregistrements par fichier.

Exemple de fichier:

Nom du fichier : 20181130.12345678.PAY.REQ.T.01

00;PAY;02;12345678;TEST;20181130;102008;
02;1;20181130;102008;000001;CD;93599;978;;;ALIAS-TEST-1;;;;;
02;2;20181130;102008;000002;CD;7590;978;;;ALIAS-TEST-1;;;;;
01;2

Pour vous aider dans votre phase d'intégration, une interface de validation est disponible dans le Back Office Expert depuis le menu: Gestion > Abonnements de TEST > Demande de paiement.

Celle-ci permet :

  • la vérification de la structure d’un fichier à déposer
  • l’import d’un fichier de paiement de TEST
  • la création des paiements de TEST à partir du fichier importé.