Générer des Rapports
Les rapports Yuno offrent un moyen pratique d'acquérir des informations concernant les différentes étapes des paiements. Vous pouvez demander et télécharger sans effort divers rapports associés à vos opérations Yuno. Yuno fournit quatre types de rapports :
- Paiement
- Transaction
- Rapprochement des transactions
- Règlement
Vous pouvez vérifier la description détaillée de chacun en accédant à la documentation des champs de rapports. Les rapports Rapprochement de Transaction et Règlement fournissent des informations liées au rapprochement. Pour examiner tous les champs disponibles sur chaque rapport et leur description, accédez à la page Champs de Rapports.
Prérequis
Pour demander un rapport, vous devez :
- Accéder à vos Identifiants API sur le Tableau de bord de Yuno, qui consistent en :
public-api-keyprivate-secrete-key
Explorer les Collections Postman de YunoYuno fournit des Collections Postman que vous pouvez utiliser pour reproduire les cas d'utilisation localement.
Résumé des Étapes
Le processus pour recevoir un rapport lors de l'utilisation de Yuno est composé de deux étapes :
Accéder à un rapport
Comme indiqué dans le résumé des étapes, vous devez effectuer deux étapes avant d'accéder à votre rapport.
Étape 1 : Créer un rapport
Pour initier le processus de génération de rapport, demandez à Yuno de créer le rapport en utilisant l'endpoint Créer un Rapport. Premièrement, sélectionnez le type de rapport souhaité (type), qui déterminera le contenu du rapport généré. Deuxièmement, définissez la plage de dates que vous souhaitez inclure dans le rapport en définissant les paramètres start_date et end_date.
Lors de la création du rapport, vous pouvez filtrer les données ajoutées en spécifiant les valeurs de certains champs. Par exemple, vous pourriez vouloir recevoir des données uniquement liées aux transactions effectuées en Argentine et au Brésil. Dans ce cas, vous fourniriez le contenu AR,BR pour le paramètre country.
Vous avez la possibilité de filtrer les champs suivants lors de la création du rapport :
payment_statuspayment_sub_statuspayment_methodcurrencycountrytransaction_typetransaction_statusupdated_at_startupdated_at_end
Format des Valeurs de FiltreLorsque vous définissez les valeurs de filtre, fournissez-les sous forme de liste de chaînes de caractères, comme dans l'exemple ci-dessous :
"payment_status": "CREATED,READY_TO_PAY,DECLINED"
Pour les rapports Paiement ou Transaction, vous avez également la possibilité de sélectionner les champs inclus dans le rapport final en utilisant le paramètre columns.
Lorsque vous utilisez l'endpoint Créer un Rapport pour demander la création d'un rapport, dans la réponse, vous recevrez l' id et status. Vous utiliserez l' id lors de la demande de téléchargement du rapport à l'Étape 3. La status indique s'il est prêt à être téléchargé.
Étape 2 : Vérifier si le rapport est prêt
Après avoir demandé la création du rapport, vous pouvez utiliser les endpoints suivants Récupérer un rapport ou Liste de tous les rapports pour vérifier s'il est prêt à être téléchargé. Lorsque vous utilisez l'endpoint Récupérer un rapport vous devez fournir l' iddu rapport. D'autre part, avec l'endpoint Liste des rapports vous devez informer votre account_id pour recevoir une liste de tous les rapports existants et leur statut.
Lorsque le rapport a le statut SUCCEEDED, vous pouvez demander son téléchargement. Accédez à la Statut du Rapport pour vérifier tous les statuts de rapport possibles.
Étape 3 : Télécharger votre rapport
Utilisez l'endpoint Télécharger un Rapport pour recevoir votre rapport en fournissant son id. Vous recevrez le rapport dans un fichier .zip. Cependant, pour les rapports de Règlement, l'API renverra un fichier .csv.
Mise à jour il y a 3 mois