InstafuelInstafuel
FREN
  • 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

Information
Identité
    Identité de la cléget
Entreprises
    Lister les entreprises du portefeuillegetDemander l'enrôlement d'une entreprisepostLire une entreprisegetMettre à jour une entreprisepatch
Comptes
    Lister les comptes web d'une entreprisegetCréer un compte web chez une entreprise clientepostMettre à jour un compte webpatch
Wallet
    Solde du wallet d'une entreprisegetÉcritures du walletgetTéléverser une preuve de versementpostDéclarer un versement à créditerpostSoldes de tout le portefeuillegetSuivre vos déclarations de versementgetLire une déclaration de versementget
Transactions
    Lister les pleins du portefeuillegetLire un pleinget
Chauffeurs
    Portefeuilles chauffeursget
Alertes
    Alertes des entreprises du portefeuilleget
Rapports
    Synthèse du portefeuilleget
Schemas
powered by Zudoku
API partenaire Instafuel
API partenaire Instafuel

Chauffeurs

Download schema

Portefeuilles chauffeurs des entreprises du portefeuille.


Portefeuilles chauffeurs

GET
https://instafuel-backend-staging.up.railway.app
/v1/papi/drivers

Scope requis : DRIVERS_READ.

Renvoie les soldes chauffeurs des entreprises du portefeuille. Contient des données personnelles (nom, téléphone) : ce scope se demande en conscience.

Portefeuilles chauffeurs › query Parameters

page
​integer · min: 1
Default: 1
perPage
​integer · min: 1 · max: 100

Plafonné à 100.

Default: 20
companyId
​integer · min: 1
status
​string · enum
Enum values:
ACTIVE
FROZEN
CLOSED

Portefeuilles chauffeurs › Responses

Portefeuilles chauffeurs paginés

​DriverWallet[]
​Pagination
GET/v1/papi/drivers
curl https://instafuel-backend-staging.up.railway.app/v1/papi/drivers \ --header 'Authorization: Bearer <token>'
Example Responses
{ "data": [ { "id": 0, "ref": "ref", "companyId": 0, "driver": { "id": 0, "name": "name", "phoneNumber": "phoneNumber" }, "status": "ACTIVE", "balanceFcfa": 0, "heldFcfa": 0, "availableFcfa": 0, "lastCreditAt": "2024-08-25T15:00:00Z", "lastDebitAt": "2024-08-25T15:00:00Z" } ], "pagination": { "page": 1, "perPage": 20, "total": 137, "totalPages": 7 } }
json
application/json

TransactionsAlertes