Mise à jour des Contacts via SFTP

Modifié le  Lun, 7 Sept. à 10:52 H

Vous pouvez mettre à jour vos Contacts en envoyant un fichier de Contact à Payreq via SFTP. Cette méthode est généralement utilisée lorsque vous fournissez des données de Contact dans le cadre d’un processus automatisé ou récurrent à partir d’un système de facturation, de tarification, de paie ou d’un autre système source, que vous le fassiez vous-même ou via un Print Service Provider.

Une présentation technique complète est disponible dans la Spécification de l’interface Payreq.

Comment fonctionne le processus SFTP

  1. Vous préparez un fichier de Contacts.
  2. Le fichier est téléversé sur le serveur SFTP de Payreq.
  3. Payreq traite le fichier.
  4. Les enregistrements de Contact sont ajoutés, mis à jour ou remplacés selon le fichier et ses instructions d’en-tête.
  5. Payreq génère un fichier d’accusé de réception une fois le traitement terminé.
  6. Vous examinez le fichier d’accusé de réception et examinez tous les Abonnements marqués Désactiver?.

Exigences relatives aux fichiers

Les fichiers de Contacts doivent être fournis au format CSV. Chaque fichier doit contenir :

  • Un enregistrement d’en-tête
  • Un ou plusieurs enregistrements de Contact
  • Un enregistrement de fin

Vous pouvez choisir le nom du fichier, à condition que :

  • Chaque nom de fichier est unique
  • L’extension du fichier est .csv
  • Le nom du fichier utilise uniquement des caractères US ASCII standard
  • Les caractères accentués et les caractères de contrôle ne sont pas utilisés dans le nom du fichier

Enregistrement d’en-tête : choisir le bon identifiant de type de fichier

La première ligne du fichier doit être l’enregistrement d’en-tête. Il identifie le fichier et indique à Payreq comment le traiter. L’identifiant du type de fichier contrôle la manière dont le fichier Contact est traité.

Utilisez ADD_CONTACTS lorsque le fichier doit :

  • Ajouter de nouveaux Contacts
  • Mettre à jour les Contacts existants correspondants
  • Laisser les autres Contacts existants inchangés

Utilisez REPLACE_CONTACTS uniquement lorsque le fichier contient la liste complète des Contacts qui doit rester dans Payreq Delivery. Utilisez un fichier de remplacement avec précaution, car les Contacts non inclus dans le fichier peuvent ne plus rester disponibles de la même manière après le traitement.

Avant d’envoyer un fichier de remplacement, confirmez que :

  • Le fichier contient tous les Contacts requis
  • Les identifiants de Contact existants ont été conservés le cas échéant
  • L’effet possible sur les Abonnements actifs a été pris en compte
  • Le fichier a été examiné par la personne appropriée de votre organisation

Champs de Contact

Le fichier Contact comprend plusieurs champs de Contact configurables. Ces éléments sont importants car ils sont utilisés pour faire correspondre les demandes d’Abonnement à l’enregistrement de Contact correct.

Les champs Contact obligatoires sont :

Numéro de champ Nom du champ Descriptif
1 Record TypeValeur codée en dur "1" en début d’enregistrement, pour indiquer qu’il s’agit d’une ligne Contact.
2 Sender IdL’ID d’expéditeur unique pour un canal enregistré. Si un expéditeur ou un mailhouse est configuré pour envoyer à BPAY View, il s’agit de l’identifiant unique du facturier BPAY.
3 Contact IdL’identifiant unique d’un Contact. Il peut s’agir du BVRN, d’un identifiant de propriété ou d’un identifiant d’employé convenu lors de l’intégration.
4 Contact Full NameLe nom complet du client ou de l’employé, jusqu’à 100 caractères, par exemple « M. John Smith » ou « Mme Jane Doe ».
11 Contact Field 1La première valeur du champ Contact ID. Cette valeur est spécifiée lors de l’intégration et peut être consultée sous Paramètres dans la console Payreq.

Confirmez les valeurs requises et l’utilisation des champs lors de l’intégration. Vous pouvez les consulter dans les paramètres de la console Payreq Delivery. Pour plus de détails, voir Comprendre les paramètres des champs de Contact.

Téléversement du fichier

  1. Préparez le fichier Contact au format CSV convenu.
  2. Connectez-vous au serveur SFTP de Payreq en utilisant les identifiants fournis à votre organisation.
  3. Placez le fichier dans le répertoire /incoming.
  4. Laissez Payreq traiter le fichier.
  5. Examinez le fichier d’accusé de réception une fois le traitement terminé.

Ne téléversez pas le même fichier plus d’une fois, sauf si Payreq Support vous le demande.

Fichiers d’accusé de réception

Une fois le fichier de Contacts traité, Payreq place un fichier d’accusé de réception dans le dossier sortant SFTP. Ce fichier indique le résultat global du téléversement et comprend :

  • Le nom du fichier reçu par Payreq
  • L’état global du traitement
  • Un message confirmant le résultat ou expliquant l’échec
  • L’en-tête original que vous avez fourni dans le fichier Contact
  • Le nombre d’enregistrements indiqué dans la ligne de fin

L’état global indique si le fichier a été traité avec succès :

  • OK : le fichier a été traité avec succès
  • ERR : le traitement du fichier a échoué et nécessite une enquête

Si votre organisation n’a pas besoin de fichiers d’accusé de réception, vous pouvez en discuter avec Payreq lors de l’intégration ou en contactant Payreq Support.

Cet article a-t-il été utile ?

C'est super !

Merci pour votre commentaire

Désolé ! Nous n'avons pas pu vous être utile

Merci pour votre commentaire

Dites-nous comment nous pouvons améliorer cet article !

Sélectionner au moins l'une des raisons
La vérification CAPTCHA est requise.

Commentaires envoyés

Nous apprécions vos efforts et nous allons corriger l'article