APIFayma

Introduction

APIFayma est une API de paiement qui permet d'intégrer facilement des solutions de paiement dans vos applications. Notre API supporte plusieurs modes de paiement incluant Orange Money, Wave, KPay, et Mixx.

Note : L'API est actuellement en version 1.0. Toutes les URLs commencent par /v1/

URL de Base

https://api.apifayma.sn/v1

Authentification

Toutes les requêtes à l'API doivent inclure un token JWT dans l'en-tête Authorization. Le token doit être obtenu via le processus d'authentification.

Authorization: Bearer votre_token_jwt

Format du Token JWT

{
    "header": {
        "alg": "HS256",
        "typ": "JWT"
    },
    "payload": {
        "data": {
            "id": "user_id",
            "client": "client_code",
            "exp": 1735689600
        }
    }
}

Endpoints

Création de Transaction

POST /v1/transactions/create

Paramètres requis :

montant (int) : Montant de la transaction en XOF
mode (int) : Mode de paiement (1-6)
emeteur ou telephone (string) : Numéro de téléphone

Paramètres optionnels :

type (int) : Type de transaction (1 par défaut)
description (string) : Description de la transaction
produit (int) : ID du produit
callback (string) : URL de callback
success (string) : URL de succès
failure (string) : URL d'échec
cancel (string) : URL d'annulation

Exemple de requête :

{
    "montant": 10000,
    "mode": 3,
    "emeteur": "777777777",
    "description": "Paiement de facture",
    "callback": "https://votre-site.com/callback",
    "success": "https://votre-site.com/success",
    "failure": "https://votre-site.com/failure",
    "cancel": "https://votre-site.com/cancel"
}

Réponse réussie :

{
    "status": 1,
    "code": "CLIENT_CODE",
    "redirect": "https://api.apifayma.sn/?k=orangemoney&montant=10000&id=TRANSACTION_ID",
    "message": "Transaction initiée"
}

Modes de Paiement

Paiements Internationaux

1 : Stripe (Cartes bancaires internationales)
2 : PayPal (Comptes PayPal)

Paiements Locaux

3 : Orange Money (Mobile Money)
4 : Wave (Mobile Money)
5 : KPay (Mobile Money)
6 : Mixx (Mobile Money)

Webhooks

Les webhooks permettent de recevoir des notifications en temps réel sur le statut de vos transactions.

Format du Webhook

{
    "event": "transaction.status_changed",
    "data": {
        "transaction_id": "TRANSACTION_ID",
        "status": "completed",
        "amount": 10000,
        "currency": "XOF",
        "timestamp": "2024-03-15T10:30:00Z"
    }
}

Gestion des Erreurs

L'API utilise des codes d'erreur HTTP standard et renvoie des messages d'erreur détaillés.

Code	Message	Description
400	INVALID_TOKEN	Token invalide ou manquant
400	INVALID_AMOUNT	Le montant saisi n'est pas autorisé
400	INVALID_MODE	Mode de paiement invalide
400	DUPLICATE_TRANSACTION	Transaction en double détectée
429	RATE_LIMIT_EXCEEDED	Limite de transactions quotidienne atteinte

Limites d'Utilisation

Transactions

Maximum de transactions quotidiennes : 100

Montants

Montant maximum par transaction : 1,000,000 XOF

Commission

Taux de commission : 2%

Documentation