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

Entreprises

Download schema

Le portefeuille — lecture, enrôlement, mise à jour.


Lister les entreprises du portefeuille

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

Scope requis : COMPANIES_READ.

Lister les entreprises du portefeuille › query Parameters

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

Plafonné à 100.

Default: 20
search
​string

Filtre sur le nom, insensible à la casse.

status
​string · enum
Enum values:
ACTIVE
INACTIVE

Lister les entreprises du portefeuille › Responses

Liste paginée

​Company[]
​Pagination
GET/v1/papi/companies
curl https://instafuel-backend-staging.up.railway.app/v1/papi/companies \ --header 'Authorization: Bearer <token>'
Example Responses
{ "data": [ { "id": 4832, "ref": "ENT-B14E77A3", "name": "Transports Kouassi SARL", "status": "ACTIVE", "email": "contact@kouassi.ci", "phoneNumber": "+2250700000099", "rccm": "CI-ABJ-2024-B-1234", "nif": "NIF-99887766", "headquartersAddress": "headquartersAddress", "createdAt": "2024-08-25T15:00:00Z" } ], "pagination": { "page": 1, "perPage": 20, "total": 137, "totalPages": 7 } }
json
application/json

Demander l'enrôlement d'une entreprise

POST
https://instafuel-backend-staging.up.railway.app
/v1/papi/companies

Scope requis : COMPANIES_WRITE.

Répond 202, pas 201. Aucune entreprise n'existe à l'issue de cet appel : une demande d'approbation est ouverte, qu'un opérateur Instafuel doit valider. La demande expire au bout de 7 jours.

rccm et nif sont obligatoires : sans immatriculation, la même entreprise réelle pourrait être enrôlée deux fois, avec deux wallets distincts.

Demander l'enrôlement d'une entreprise › Headers

X-Idempotency-Key
​string · maxLength: 200 · required

Valeur unique par opération — un UUID convient. Rejouée à l'identique dans les 24 h, la requête renvoie la première réponse au lieu de créer un doublon.

Demander l'enrôlement d'une entreprise › Request Body

CompanyCreateRequest
name
​string · maxLength: 150 · required
email
​string · email · required
phoneNumber
​string · maxLength: 30 · required
rccm
​string · maxLength: 64 · required

Registre du commerce. Normalisé en majuscules avant contrôle d'unicité.

nif
​string · maxLength: 64 · required

Identifiant fiscal. Normalisé en majuscules avant contrôle d'unicité.

headquartersAddress
​string · maxLength: 500

Demander l'enrôlement d'une entreprise › Responses

Demande enregistrée, en attente de validation Instafuel

​ApprovalPending
POST/v1/papi/companies
curl https://instafuel-backend-staging.up.railway.app/v1/papi/companies \ --request POST \ --header 'Content-Type: application/json' \ --header 'X-Idempotency-Key: <string>' \ --header 'Authorization: Bearer <token>' \ --data '{ "name": "Transports Kouassi SARL", "email": "contact@kouassi.ci", "phoneNumber": "+2250700000099", "rccm": "CI-ABJ-2024-B-1234", "nif": "NIF-99887766", "headquartersAddress": "Zone 4C, Abidjan" }'
Example Request Body
{ "name": "Transports Kouassi SARL", "email": "contact@kouassi.ci", "phoneNumber": "+2250700000099", "rccm": "CI-ABJ-2024-B-1234", "nif": "NIF-99887766", "headquartersAddress": "Zone 4C, Abidjan" }
json
application/json
Example Responses
{ "data": { "status": "APPROVAL_PENDING", "approvalId": "00000000-0000-0000-0000-000000000000", "expiresAt": "2024-08-25T15:00:00Z", "message": "message" } }
json
application/json

Lire une entreprise

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

Scope requis : COMPANIES_READ.

Lire une entreprise › path Parameters

companyId
​integer · min: 1 · required

Identifiant d'une entreprise de votre portefeuille.

Lire une entreprise › Responses

Entreprise

​Company
GET/v1/papi/companies/{companyId}
curl https://instafuel-backend-staging.up.railway.app/v1/papi/companies/:companyId \ --header 'Authorization: Bearer <token>'
Example Responses
{ "data": { "id": 4832, "ref": "ENT-B14E77A3", "name": "Transports Kouassi SARL", "status": "ACTIVE", "email": "contact@kouassi.ci", "phoneNumber": "+2250700000099", "rccm": "CI-ABJ-2024-B-1234", "nif": "NIF-99887766", "headquartersAddress": "headquartersAddress", "createdAt": "2024-08-25T15:00:00Z" } }
json
application/json

Mettre à jour une entreprise

PATCH
https://instafuel-backend-staging.up.railway.app
/v1/papi/companies/{companyId}

Scope requis : COMPANIES_WRITE.

Modification partielle : seuls les champs fournis sont écrits. Les champs acceptés sont name, email, phoneNumber, rccm, nif et headquartersAddress — tout autre champ est ignoré.

Mettre à jour une entreprise › path Parameters

companyId
​integer · min: 1 · required

Identifiant d'une entreprise de votre portefeuille.

Mettre à jour une entreprise › Headers

X-Idempotency-Key
​string · maxLength: 200 · required

Valeur unique par opération — un UUID convient. Rejouée à l'identique dans les 24 h, la requête renvoie la première réponse au lieu de créer un doublon.

Mettre à jour une entreprise › Request Body

Tous les champs sont facultatifs ; seuls ceux fournis sont modifiés.
CompanyUpdateRequest
name
​string
email
​string · email
phoneNumber
​string · maxLength: 32
rccm
​string · maxLength: 64
nif
​string · maxLength: 64
headquartersAddress
​string · maxLength: 500

Mettre à jour une entreprise › Responses

Entreprise mise à jour

​Company
PATCH/v1/papi/companies/{companyId}
curl https://instafuel-backend-staging.up.railway.app/v1/papi/companies/:companyId \ --request PATCH \ --header 'Content-Type: application/json' \ --header 'X-Idempotency-Key: <string>' \ --header 'Authorization: Bearer <token>' \ --data '{ "phoneNumber": "+2250700000100", "headquartersAddress": "Cocody Riviera 3, Abidjan" }'
Example Request Body
{ "phoneNumber": "+2250700000100", "headquartersAddress": "Cocody Riviera 3, Abidjan" }
json
application/json
Example Responses
{ "data": { "id": 4832, "ref": "ENT-B14E77A3", "name": "Transports Kouassi SARL", "status": "ACTIVE", "email": "contact@kouassi.ci", "phoneNumber": "+2250700000099", "rccm": "CI-ABJ-2024-B-1234", "nif": "NIF-99887766", "headquartersAddress": "headquartersAddress", "createdAt": "2024-08-25T15:00:00Z" } }
json
application/json

IdentitéComptes