Document API pour dépôt de transaction

Document API pour dépôt de transaction



Soumission d’un fichier CSV dans le système


1.   Soumission des transactions

L’importation du fichier est basée sur les titres des colonnes plutôt que l’ordre de celles-ci.

Les principes de bases suivants doivent être respecté pour le bon fonctionnement de l’importation :
  1. Le fichier doit contenir les colonnes de base obligatoires
  2. Les titres des colonnes doivent être écrite correctement (sans espace superflus)
  3. L’ensemble des lignes du fichier doit être d’un seul type (voir champ « typeTransaction »)
  4. Pour les paiements fournisseurs, chaque transaction d'un dépôt doit être pour le même clientPPA
  5. Les champs ne doivent pas être encadré par des guillemets
  6. La taille de la requête HTTP doit être inférieure à 50Mo

Description des colonnes

Champs de base obligatoires.

Nom du champ
Description
Format
typeTransaction
Type : 0 prélèvement    1 : paiement de fournisseur 2 : mise à jour infos
(/\d+/)
compteppa_no
Votre numéro interne unique du copropriétaire / locataire 
/.{0,20}/
compteppa_firstname
Prénom du copropriétaire / locataire
/.{0,100}/
compteppa_lastname
Nom de famille du copropriétaire / locataire
/.{0,100}/
compteppa_noInstitution
No de l'institution financière du copropriétaire / locataire
/.{0,3}/
compteppa_noTransit
No de transit de l'institution financière du copropriétaire / locataire
/.{0,5}/
compteppa_noCompteBancaire
No de compte bancaire du copropriétaire / locataire
/.{0,20}/
amount
Montant à prélever du copropriétaire / locataire
(/\d+\.\d{2}/)
datePayment
Date du prélèvement pour les transactions de type 0 et date du paiement fournisseur pour les transactions de type 1.
ISO8601 : yyyy-mm-dd
clientppa_token

Chaîne d’identification de sécurité d’identification du client pour le webservice.

Voir section #2 pour plus de détails
/.{0,50}/
clientppa_reference

Numéro d’autorisation du client (Voir dans l’application Web)    1

 

Pour des transactions de type 1, l’ensemble des transactions doit appartenir au même clientPPA.

/.{0,30}/
system_user

Nom de l’usager connecté au système qui a envoyé la transaction à synchroniser dans le système Otonom Solution.

/.{0,25}/


Champs supplémentaires supportés :

Nom du champDescription
Format
compteppa_unitNuméro de l’unité (s’il y a lieu) du copropriétaire / locataire
/.{0,30}/
compteppa_address
Adresse de l’unité (s’il y a lieu) du copropriétaire / locataire
/.{0,250}/
compteppa_city
Ville du copropriétaire / locataire
/.{0,100}/
compteppa_province
Province du copropriétaire / locataire
/.{0,100}/
compteppa_codePostal
Code postal du copropriétaire / locataire
/.{0,16}/
compteppa_pays
Pays du copropriétaire / locataire
/.{0,100}/
compteppa_email
Courriel du copropriétaire / locataire
/.{0,250}/
compteppa_phone
Téléphone du copropriétaire / locataire
/.{0,50}/
emailNotification
Courriel du client principal qui utilise le logiciel
/.{0,250}/
clientPPA_name
Nom du clientsPPA (syndicat, locateur, entreprise)
/.{0,200}/



compteppa_no_cie
Numéro de compagnie

compteppa_no_div
Numéro de division

compteppa_code_immo
Code de l'immeuble

compteppa_sex
Homme-> 2 ou M     Femme->   1 ou F
(/\d+/)
compteppa_phone_office
Téléphone au travail du copropriétaire / locataire

compteppa_phone_cell
Cellulaire du copropriétaire / locataire


Champs supplémentaires pour paiements fournisseurs :

Nom du champDescription
Format
invoice_noNuméro de la facture du fournisseur
Utilisation du caractère '|' pour fichiers multiples (s'il y a lieu).
(/\d+/)
invoice_date
Date de la facture du fournisseur
ISO8601 : yyyy-mm-dd
reference
Référence du paiement fournisseur (ex. numéro de facture, raison du paiement)
Utilisation du caractère '|' pour fichiers multiples (s'il y a lieu).
/.{0,1000}/

signatory

Réinitialise les noms et adresses courriel des signataires requis pour les paiements fournisseurs pour le clientPPA.

<nom du signataire>,<courriel du signataire>;<nom2>,<courriel2>;…
/.{0,1000}/
compteppa_email
Courriel du fournisseur afin que celui-ci reçoive l’avis de paiement.
/.{0,250}/
invoice_content64
Contenu du fichier représentant la facture du fournisseur (en base 64)
Utilisation du caractère '|' pour fichiers multiples (s'il y a lieu).
illimité
invoice_filename

Nom du fichier représentant la facture du fournisseur.

Requis lorsque la valeur invoice_content64 n’est pas vide.
Utilisation du caractère '|' pour fichiers multiples (s'il y a lieu).
/.{0,5000}/

Champs supplémentaires reliés aux transactions :

Nom du champDescription
Format
transac_lot_encaissementChamp pouvant être relié au logiciel Hopem
/.{0,20}/
transac_lot_gl
Champ pouvant être relié au logiciel Hopem
/.{0,20}/
transac_line_lot_gl
Champ pouvant être relié au logiciel Hopem
/.{0,20}/
transac_no_bordereau
Champ pouvant être relié au logiciel Hopem
/.{0,20}/
external_reference
Numéro d'identification de la transaction du côté du client.
/.{0,1024}/


Méthodes d'importation
  1. Dépôt manuel via l'interface web du système
  2. Via HTTP POST (paramètres dans le BODY)       (maximum 50Mo)

Le fichier doit être soumis via http à l’adresse : https://secure.otonomsolution.com/ws/dataImportCSV.php


Paramètres :  

c = <contenu texte de votre fichier>         

p=<votre nip donnée par Otonom Solution> 


      Important : Le numéro de référence du Client/Syndicat/Propriétaire doit exister et être actif chez Otonom Solution pour effectuer le traitement des transactions. 


Code de retour

Le script retournera 0~<message> si le traitement a réussi. Dans le cas contraire il retournera 1~<message>.

Ex. « 1~Numéro de référence invalide : 703543 » indique que le numéro de référence saisie dans le fichier n’existe pas dans le système.


Exemple d'un format
typeTransaction;compteppa_no;compteppa_firstname;compteppa_lastname;compteppa_noInstitution;amount

0;20;Jean;Tremblay;001;29.50

0;50;John;;001;224.68


Environnement de test

Utiliser l’adresse suivante : https://integration.otonompay.dev/ws/dataImportCSV.php

Paramètres :

c = <contenu texte de votre fichier>         
p= <le NIP qui vous a été fourni pour l'environnement d'intégration>

2.   Récupération d'un "token" client

Pour passer une transaction associée à un client, celui-ci doit être identifié à l’aide d’un « token » représenté par une chaine de caractère. Celle-ci peut être généré via un appel à un autre webservice.

Le fichier doit être soumis via http à l’adresse suivante Via HTTP POST(paramètres dans le  BODY) :
Paramètres : 
p=<votre nip donnée par Otonom Solution> 
refNo=<le numéro d’identification unique du clientPPA > 

Important : Le numéro de référence du Client/Syndicat/Propriétaire doit exister chez Otonom Solution pour que le token soit généré. 


Code de retour

Le script retournera 0~<token> si le traitement a réussi. Dans le cas contraire il retournera 1~<message>.

Ex. « 1~Numéro de référence invalide : 703543 » indique que le numéro de référence saisie dans le fichier n’existe pas dans le système.


En environnement de test utiliser l’adresse suivante : https://integration.otonompay.dev/ws/clientPPAToken.php