Aller au contenu principal

Transactions et paiements

Consultez l’activité de paiement et téléchargez les factures depuis votre compte YODI authentifié. Le lancement et la gestion d’un abonnement se font dans la Console. Les routes API ci-dessous sont limitées au compte connecté et exigent le cookie de session YODI; une clé API ne le remplace pas.

Toutes les réponses JSON utilisent l’enveloppe standard YODI. Le téléchargement d’une facture renvoie des octets PDF et constitue l’exception binaire documentée.

Lister les transactions​

GET /v1/paygate/transactions

La liste est limitée au compte connecté. Paramètres facultatifs : page (entier, indexé à partir de zéro), limit (1–50), sortBy (date, amount ou status), sortDir (asc ou desc), status (all, SUCCESS, PENDING, FAILED, CANCELLED ou EXPIRED), dateFrom et dateTo (dates ISO 8601). Lorsque page est fourni, data contient data, total, page et limit. Sans page, data est le tableau des transactions.

GET /v1/paygate/transactions?page=0&limit=10 HTTP/1.1
Host: api.yodi.tg
Cookie: <session YODI authentifiée>

Chaque transaction expose un id numérique, status, amount_paid, payment_method, phone_number, tx_reference, payment_reference, description, created_at, datetime_paid et plan ({ id, name } ou null). Les champs nullables peuvent valoir null. Ne déduisez pas la devise à partir du montant; utilisez le résumé pour obtenir les totaux par devise.

Résumé des paiements​

GET /v1/paygate/transactions/summary

Renvoie les totaux groupés par devise, le nombre de transactions réussies et le nombre total de transactions. Les montants de devises différentes ne sont pas additionnés entre eux.

Vérifier un paiement​

GET /v1/paygate/payment-status?identifier=<identifiant>

L’identifiant contient entre 1 et 50 caractères et respecte le motif ^[A-Za-z0-9_-]+$. La recherche est limitée au compte authentifié. Une réponse JSON réussie contient data.initialized et data.status; si aucune transaction correspondante n’existe, initialized vaut false et status vaut null.

GET /v1/paygate/payment-status?identifier=VOTRE_IDENTIFIANT_DE_TRANSACTION HTTP/1.1
Host: api.yodi.tg
Cookie: <session YODI authentifiée>

Télécharger une facture​

GET /v1/paygate/transactions/{id}/invoice

id est un identifiant numérique de transaction. La route renvoie une pièce jointe PDF, pas l’enveloppe JSON, et vérifie que la transaction appartient au compte connecté. Le paramètre facultatif lang sélectionne la langue de la facture.

Gérer les paiements​

Démarrez ou gérez un abonnement depuis la Console YODI. La plateforme choisit le fournisseur et les moyens de paiement disponibles; cette référence API ne garantit aucun fournisseur, aucune devise ni aucun moyen de paiement spécifique.