Gestion des Transactions

Vue d'ensemble

Cette section présente l'API de consultation des transactions, qui offre une vue complète et organisée de toutes les opérations financières associées aux plateformes. Elle constitue l'outil principal de reporting et d'analyse des flux financiers.

Fonctionnalités couvertes

Notre API de transactions propose un système complet de consultation et d'analyse :

Consultation des transactions

Visualisation des transactions entrantes par plateforme
Accès aux transactions approuvées et validées
Historique complet avec détails financiers (montants, frais, nets)
Support de la pagination pour de gros volumes de données

Organisation et filtrage

Groupement intelligent des transactions par critères
Tri chronologique par date de création (décroissant par défaut)
Pagination configurée (taille de page et numéro de page)
Filtrage par slug de plateforme spécifique

Informations financières détaillées

Montants dans la devise originale et devise par défaut
Calcul automatique des frais de passerelle de paiement
Frais globaux et montants nets après déductions
Support multidevise avec conversion automatique

Types de transactions

L'API distingue deux catégories principales :

Transactions entrantes (/api/v1/transactions/incoming/{platformSlug})

Toutes les transactions reçues par la plateforme
Incluent les transactions en attente, traitées et échouées
Vue d'ensemble de l'activité commerciale

Transactions approuvées (/api/v1/transactions/approved/{platformSlug})

Uniquement les transactions validées et confirmées
Transactions prêtes pour règlement ou déjà réglées
Base de calcul pour les revenus effectifs

Structure des données

Chaque transaction contient des informations essentielles : identifiant unique, montants détaillés, devises, frais appliqués et dates de création. Les transactions sont automatiquement groupées pour faciliter l'analyse et le reporting financier.

| Action | Endpoint | |---|---| | GET | /api/v1/transactions/incoming/{platformSlug} | | GET | /api/v1/transactions/approved/{platformSlug} |

Lister les transactions entrantes et approuvées pour une plateforme spécifique.

Endpoint: GET /api/v1/transactions/incoming/{platformSlug}

Liste les transactions entrantes pour la plateforme spécifiée.

Paramètres de la requête

page : Numéro de page
size : Taille de la page
sort : createdDate,desc
platformSlug : platformSlug

Exemple

curl -X GET « https://api.nourama.com/api/v1/transactions/incoming/my-platform?size=10&page=0 » \N
     -H « Authorization : Bearer <token> »

Réponse

 
"message": "success message",
  "body": {
    "groupedTransactions": {
      "additionalProp1": [
        {
          "createdDate": "2025-06-01T00:32:39.901Z",
          "transactionId": "IG456-IG44N",
          "amount": 0,
          "currency": "CFA",
          "amountInDefaultCurrency": 0,
          "defaultCurrency": "CFA",
          "paymentGatewayFee": 0,
          "globalFee": 0,
          "netAmount": 0
        }
      ],
      "additionalProp2": [
        {
          "createdDate": "2025-06-01T00:32:39.901Z",
          "transactionId": "IG443-IG665",
          "amount": 0,
          "currency": "CFA",
          "amountInDefaultCurrency": 0,
          "defaultCurrency": "CFA",
          "paymentGatewayFee": 0,
          "globalFee": 0,
          "netAmount": 0
        }
      ],
      "additionalProp3": [
        {
          "createdDate": "2025-06-01T00:32:39.901Z",
          "transactionId": "IG544-IG434",
          "amount": 0,
          "currency": "CFA",
          "amountInDefaultCurrency": 0,
          "defaultCurrency": "CFA",
          "paymentGatewayFee": 0,
          "globalFee": 0,
          "netAmount": 0
        }
      ]
    },
    "totalPages": 0,
    "totalElements": 0
  }

Lister les transactions approuvées pour une plateforme spécifique.

Endpoint: GET /api/v1/transactions/approved/{platformSlug}

Liste les transactions approuvées pour la plateforme.

Paramètres de la requête

page : Numéro de page
size : Taille de la page
sort : createdDate,desc
platformSlug : platformSlug

Réponse

 
{
  "message": "string",
  "body": {
    "groupedTransactions": {
      "additionalProp1": [
        {
          "createdDate": "2025-06-01T00:34:19.747Z",
          "transactionId": "IG909-666",
          "amount": 0,
          "currency": "CFA",
          "amountInDefaultCurrency": 0,
          "defaultCurrency": "CFA",
          "paymentGatewayFee": 0,
          "globalFee": 0,
          "netAmount": 0
        }
      ],
      "additionalProp2": [
        {
          "createdDate": "2025-06-01T00:34:19.747Z",
          "transactionId": "IG665-IG334",
          "amount": 0,
          "currency": "CFA",
          "amountInDefaultCurrency": 0,
          "defaultCurrency": "CFA",
          "paymentGatewayFee": 0,
          "globalFee": 0,
          "netAmount": 0
        }
      ],
      "additionalProp3": [
        {
          "createdDate": "2025-06-01T00:34:19.747Z",
          "transactionId": "IG556-IG665",
          "amount": 0,
          "currency": "CFA",
          "amountInDefaultCurrency": 0,
          "defaultCurrency": "CFA",
          "paymentGatewayFee": 0,
          "globalFee": 0,
          "netAmount": 0
        }
      ]
    },
    "totalPages": 0,
    "totalElements": 0
  }
}

Plateformes

Cash Point