Centre d'aide SlimPay

Vue d'ensemble du Fichier API

Protocole

Notre File API est principalement accessible via SFTP. Nous pouvons aussi configurer une connexion spécifique sur demande.

Deux environnements sont accessibles :

  • Préprod : pour votre phase de développement et de test
  • Production : une fois vos tests concluants, effectuez vos transactions en situation réelle

 

Pour chaque environnement, vous avez besoin de fournir une clé publique. Une fois votre accès créé, nous vous fournirons :

  • L’hôte
  • Le port
  • Votre identifiant

 

Un dossier dédié vous sera alors créé. Ce dossier contient deux sous-dossiers :

  • in: vous y déposez vos fichiers
  • out: les fichiers .ack/.err et reporting seront déposés ici par SlimPay 

Connexion

Voici un exemple d'un standard pour procéder à la connexion utilisant une ligne de commande :

sftp -o Port=<port> -o IdentityFile=<path_to_private_key> <username>@<host>

Format

La plupart des actions disponibles dans notre File API peuvent être envoyées en utilisant un fichier simplifié au format CSV. L'encodage des caractères doit être en UTF-8 et le séparateur entre les champs doit être un point-virgule. 

Pour l'instant, la documentation pour chaque format n'est pas entièrement disponible en ligne, mais vous pouvez la demander en envoyant une demande

Reconnaître et gérer les erreurs 

  1. Vous nous envoyez un fichier 
  2. Il est immédiatement analysé. Deux possibilités :
    • Le fichier est correctement formaté : un fichier avec le même nom, possédant une extension .ack est créé.
    • Le fichier n'est pas correctement formaté : un fichier avec le même nom, possédant l'extension .err est créé, il comprend le(s) message(s) d'erreur.
  3. Le fichier est ensuite traité. Quand ? Cela dépend de votre configuration de compte. 
  4. Selon le fichier envoyé, un autre fichier de reporting peut être créé pour signaler une erreur survenue après le traitement. 

 

En d'autres termes, un fichier reconnu ne signifie pas forcément que le fichier a été traité avec succès mais que le format est correct. 

NB : Pour un fichier de création des prélèvements : si un fichier.ack est retourné après traitement, que le système découvre que l'un des mandats à utiliser a été révoqué, un fichier NOP est généré pour les paiements concernés.  

 

Cet article vous a-t-il été utile ?
Utilisateurs qui ont trouvé cela utile : 0 sur 0