Skip to content

API Reference

L'API ToonaPay est une API REST/JSON montée sous /api/v1. La spécification complète (OpenAPI) est exposée par le backend :

  • UI interactive : https://api.toonapay.io/docs
  • JSON : https://api.toonapay.io/docs/json

Référence toujours synchronisée

La référence détaillée est générée automatiquement depuis le Swagger du backend (node scripts/gen-api-docs.mjs). Elle reflète le contrat réel — jamais de documentation obsolète.

Conventions

  • Base URL : https://api.toonapay.io/api/v1
  • Réponses : { "data": ... } ou { "error": { "code", "message" } }
  • Authentification : Authorization: Bearer <accessToken> (JWT 15 min)
  • Idempotence : clé idempotencyKey sur les créations de paiement
  • Montants : entiers en unités minimales (jamais de flottants)
  • Pagination : ?page=&limit=

Modules

ModuleDescription
AuthentificationRegister, login, 2FA, sessions, refresh
PaiementsCréer, consulter, annuler, simuler, rembourser
WebhooksCallbacks providers (signature HMAC)
MarchandBoutiques, QR, employés, rapports, intégration
PersonnelMoyens, transactions, reçus, dépenses, support
StaffTransactions, marchands, KYC, commissions, audit

Environnements

EnvironnementBase URL
Sandboxhttps://api.toonapay.io/api/v1 (clés sk_test_)
Livehttps://api.toonapay.io/api/v1 (clés sk_live_)

Passerelle de paiement panafricaine.