Vue d'ensemble API
Comprenez la structure de l'API Genuka Pay et ses endpoints principaux.
Introduction
L'API Genuka Pay est une API REST basée sur JSON organisée autour de quelques familles de ressources opérationnelles : credentials d'application, paiements, payouts, webhooks, et KYC.
URL de base
{{BASE_URL}}/api/v1Headers requis
X-Public-Key: YOUR_PUBLIC_KEY
X-Timestamp: UNIX_TIMESTAMP
X-Signature: HMAC_SHA256_SIGNATURELa signature est calculée avec votre secret_key d'application. Préférez les SDKs officiels quand c'est possible.
Application
Inspectez votre application actuelle et renouvelez sa clé secrète active.
Paiements
Initiez des encaissements et suivez le statut du cycle de vie des transactions.
Payouts
Envoyez des fonds aux destinataires via les rails de décaissement supportés.
Webhooks
Recevez les changements d'état asynchrones via les endpoints webhook.
KYC
Consultez votre statut de conformité et vos limites d'opération.
Ressources principales
Application
Votre intégration API est associée à une application unique qui contient :
public_key- clé publique pour identifier les requêtessecret_key- clé secrète pour signer les requêtesenvironment- l'environnement actuel (test ou production)- historique de rotation des credentials
Endpoints :
GET /api/v1/application
POST /api/v1/application/rotatePaiements
Les paiements (ou encaissements) sont créés via l'API Payments. Chaque paiement reçoit :
track_id- identifiant stable pour le suivistatus- statut du cycle de vie (pending, success, failed, etc.)- horodatage de création et de mise à jour
Endpoints :
POST /api/v1/payments
GET /api/v1/payments
GET /api/v1/payments/:idPayouts
Les payouts vous permettent de verser des fonds aux destinataires. Vous pouvez soit utiliser une méthode de paiement enregistrée, soit fournir les informations du bénéficiaire dans la requête.
Endpoints :
POST /api/v1/payouts
GET /api/v1/payouts
GET /api/v1/payouts/:idWebhooks
Les endpoints webhook reçoivent les événements asynchrones. Vous pouvez les configurer via le dashboard ou les gérer par API pour l'automatisation.
Endpoints :
POST /api/v1/webhooks
GET /api/v1/webhooks
DELETE /api/v1/webhooks/:idKYC
Consultez votre statut de vérification KYC et vos limites opérationnelles actuelles.
Endpoints :
GET /api/v1/kyc/status
GET /api/v1/kyc/limitsConventions API
- Les montants doivent toujours inclure un code ISO de devise explicite comme
XAFouXOF - Les timestamps sont en Unix time (secondes depuis epoch)
- Les réponses utilisent le format JSON standard
- Les erreurs incluent un code d'erreur et une description lisible
Authentification HMAC
Toutes les requêtes authentifiées utilisent HMAC-SHA256 :
- Créez une chaîne à signer :
X-Public-Key|X-Timestamp|METHOD|PATH|BODY - Signez-la avec votre
secret_key - Envoyez la signature en tant que
X-Signature
Utilisez les SDKs officiels pour cette logique plutôt que de l'implémenter manuellement.
How is this guide?