Guides
Référence
Référence API

Guides

Démarrage rapide
Clés d'API
Référence API

Référence

Codes d'erreur
Glossaire
English

Environnement

Staging — instafuel-backend-staging.up.railway.app

© Instafuel — Abidjan, Côte d'Ivoire

Identité de la cléget

Lister les entreprises du portefeuilleget

Demander l'enrôlement d'une entreprisepost

Lire une entrepriseget

Mettre à jour une entreprisepatch

Lister les comptes web d'une entrepriseget

Créer un compte web chez une entreprise clientepost

Mettre à jour un compte webpatch

Solde du wallet d'une entrepriseget

Écritures du walletget

Téléverser une preuve de versementpost

Déclarer un versement à créditerpost

Soldes de tout le portefeuilleget

Suivre vos déclarations de versementget

Lire une déclaration de versementget

Lister les pleins du portefeuilleget

Lire un pleinget

Portefeuilles chauffeursget

Alertes des entreprises du portefeuilleget

Synthèse du portefeuilleget

powered by Zudoku

API partenaire Instafuel

API partenaire Instafuel

Rapports

Download schema

Agrégats du portefeuille.

Synthèse du portefeuille

GET

https://instafuel-backend-staging.up.railway.app

/v1/papi/reports/portfolio-summary

Scope requis : REPORTS_READ.

Agrégats sur une période — 30 derniers jours par défaut. Ne comptabilise que les transactions confirmées.

Synthèse du portefeuille › query Parameters

from

string · date-time

Borne inférieure, date ISO 8601.

to

string · date-time

Borne supérieure, date ISO 8601.

Synthèse du portefeuille › Responses

Synthèse

PortfolioSummary

GET/v1/papi/reports/portfolio-summary

curl https://instafuel-backend-staging.up.railway.app/v1/papi/reports/portfolio-summary \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "data": {
    "period": {
      "from": "2024-08-25T15:00:00Z",
      "to": "2024-08-25T15:00:00Z"
    },
    "totals": {
      "companies": 0,
      "activeCompanies": 0,
      "transactions": 0,
      "amountFcfa": 0,
      "walletBalanceFcfa": 0,
      "walletHeldFcfa": 0
    },
    "companies": [
      {
        "id": 0,
        "ref": "ref",
        "name": "name",
        "status": "ACTIVE",
        "transactions": 0,
        "amountFcfa": 0,
        "walletBalanceFcfa": 0
      }
    ]
  }
}

json

application/json