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

Transactions

Download schema

Pleins réglés via Instafuel.


Lister les pleins du portefeuille

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

Scope requis : TRANSACTIONS_READ.

status accepte plusieurs valeurs séparées par des virgules.

Lister les pleins du portefeuille › query Parameters

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

Plafonné à 100.

Default: 20
companyId
​integer · min: 1

Restreint à une entreprise du portefeuille. Hors portefeuille, 404.

status
​string
from
​string · date-time

Borne inférieure, date ISO 8601.

to
​string · date-time

Borne supérieure, date ISO 8601.

Lister les pleins du portefeuille › Responses

Transactions paginées

​Transaction[]
​Pagination
GET/v1/papi/transactions
curl https://instafuel-backend-staging.up.railway.app/v1/papi/transactions \ --header 'Authorization: Bearer <token>'
Example Responses
{ "data": [ { "id": "00000000-0000-0000-0000-000000000000", "ref": "TRX-88C4A1D0", "status": "CREATED", "companyId": 0, "amountFcfa": 45000, "fuelType": "DIESEL", "unitPriceFcfa": 875, "liters": { "estimate": 51.43, "actual": 51.2 }, "selfService": true, "station": { "id": 0, "name": "Total Marcory" }, "driver": { "id": 0, "name": "name" }, "vehicle": { "id": 0, "registration": "815KJ01" }, "createdAt": "2024-08-25T15:00:00Z", "confirmedAt": "2024-08-25T15:00:00Z", "canceledAt": "2024-08-25T15:00:00Z" } ], "pagination": { "page": 1, "perPage": 20, "total": 137, "totalPages": 7 } }
json
application/json

Lire un plein

GET
https://instafuel-backend-staging.up.railway.app
/v1/papi/transactions/{transactionId}

Scope requis : TRANSACTIONS_READ.

Lire un plein › path Parameters

transactionId
​string · uuid · required

Lire un plein › Responses

Transaction

​Transaction
GET/v1/papi/transactions/{transactionId}
curl https://instafuel-backend-staging.up.railway.app/v1/papi/transactions/:transactionId \ --header 'Authorization: Bearer <token>'
Example Responses
{ "data": { "id": "00000000-0000-0000-0000-000000000000", "ref": "TRX-88C4A1D0", "status": "CREATED", "companyId": 0, "amountFcfa": 45000, "fuelType": "DIESEL", "unitPriceFcfa": 875, "liters": { "estimate": 51.43, "actual": 51.2 }, "selfService": true, "station": { "id": 0, "name": "Total Marcory" }, "driver": { "id": 0, "name": "name" }, "vehicle": { "id": 0, "registration": "815KJ01" }, "createdAt": "2024-08-25T15:00:00Z", "confirmedAt": "2024-08-25T15:00:00Z", "canceledAt": "2024-08-25T15:00:00Z" } }
json
application/json

WalletChauffeurs