Schemas

Download schema

Error

object · required

Pagination

page

integer

perPage

integer

total

integer

totalPages

integer

KeyIdentity

object

Scope

string · enum

Enum values:

COMPANIES_READ

COMPANIES_WRITE

USERS_READ

USERS_WRITE

WALLET_READ

LEDGER_READ

TRANSACTIONS_READ

DRIVERS_READ

Droit porté par une clé.

Company

id

integer

ref

string | null

name

string

status

string · enum

Enum values:

ACTIVE

INACTIVE

email

string | null

phoneNumber

string | null

rccm

string | null

nif

string | null

headquartersAddress

string | null

createdAt

string | null · date-time

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

CompanyUpdateRequest

Tous les champs sont facultatifs ; seuls ceux fournis sont modifiés.

name

string

email

string · email

phoneNumber

string · maxLength: 32

rccm

string · maxLength: 64

nif

string · maxLength: 64

headquartersAddress

string · maxLength: 500

CompanyUser

id

integer

ref

string | null

name

string

email

string | null

phoneNumber

string | null

role

string · enum

Enum values:

FLEET_ADMINISTRATOR

DAF

companyId

integer | null

status

string · enum

Enum values:

ACTIVE

INACTIVE

SUSPENDED

ARCHIVED

createdAt

string | null · date-time

CompanyUserCreateRequest

name

string · maxLength: 150 · required

email

string · email · required

Sert à l'authentification et reçoit le lien d'activation.

phoneNumber

string · maxLength: 30 · required

role

string · enum · required

Enum values:

FLEET_ADMINISTRATOR

DAF

language

string · enum

Enum values:

CompanyUserUpdateRequest

name

string

email

string · email

phoneNumber

string

role

string · enum

Enum values:

FLEET_ADMINISTRATOR

DAF

status

string · enum

Enum values:

ACTIVE

INACTIVE

SUSPENDED

Wallet

id

integer

ref

string | null

companyId

integer

status

string · enum

Enum values:

ACTIVE

BLOCKED

balanceFcfa

integer

heldFcfa

integer

Montant retenu par des pleins pré-autorisés non encore confirmés.

Example: 120000

availableFcfa

integer

updatedAt

string | null · date-time

LedgerEntry

id

string · uuid

ref

string | null

type

string · enum

Enum values:

CREDIT

DEBIT

REFUND

HOLD

RELEASE

ADJUSTMENT

amountFcfa

integer

balanceAfterFcfa

integer

source

string | null · enum

Enum values:

BANK_TRANSFER

MOBILE_MONEY

CASH_DEPOSIT

CHEQUE

ADJUSTMENT

reference

string | null

Référence du versement, préfixée par votre identifiant d'apporteur.

Example: RS-12-VIR-2026-0831-004

transactionId

string | null · uuid

createdAt

string | null · date-time

Transaction

id

string · uuid

ref

string | null

status

string · enum

Enum values:

CREATED

PREAUTHORIZED

VALIDATED

CONFIRMED

CANCELED

EXPIRED

FAILED

REFUNDED

companyId

integer

amountFcfa

integer

fuelType

string

unitPriceFcfa

integer

object

selfService

boolean

Transaction conduite par le chauffeur seul, sans validation d'un pompiste.

station

object | null

driver

object | null

vehicle

object | null

createdAt

string | null · date-time

confirmedAt

string | null · date-time

canceledAt

string | null · date-time

DriverWallet

id

integer

ref

string | null

companyId

integer

driver

object | null

status

string · enum

Enum values:

ACTIVE

FROZEN

CLOSED

balanceFcfa

integer

heldFcfa

integer

availableFcfa

integer

lastCreditAt

string | null · date-time

lastDebitAt

string | null · date-time

Alert

id

integer

companyId

integer | null

type

string

severity

string · enum

Enum values:

INFO

WARNING

CRITICAL

status

string · enum

Enum values:

OPEN

ACKNOWLEDGED

DISMISSED

RESOLVED

title

string

message

string

triggeredAt

string | null · date-time

acknowledgedAt

string | null · date-time

resolvedAt

string | null · date-time

CreditRequestBody

amountFcfa

integer · min: 1 · required

source

string · enum · required

Nature réelle du versement constaté.

Enum values:

BANK_TRANSFER

MOBILE_MONEY

CASH_DEPOSIT

CHEQUE

clientReference

string · maxLength: 100 · required

Votre référence de versement. Préfixée côté serveur, sans collision possible avec un autre partenaire.

proofIds

string[] · maxItems: 3 · required

Identifiants renvoyés par POST …/wallet/credit/proof.

note

string · maxLength: 500

CreditRequest

id

string · uuid

status

string · enum

Enum values:

PENDING_APPROVAL

APPROVED

REJECTED

EXPIRED

companyId

integer | null

amountFcfa

integer | null

source

string | null

clientReference

string | null

requestedAt

string | null · date-time

decidedAt

string | null · date-time

expiresAt

string | null · date-time

rejectedReason

string | null

CreditProof

id

string · uuid

fileName

string | null

contentType

string | null

sizeBytes

integer | null

ApprovalPending

status

string

approvalId

string · uuid

expiresAt

string · date-time

message

string

PortfolioSummary

object

object[]

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

CompanyUserCreateRequest

name

string · maxLength: 150 · required

email

string · email · required

Sert à l'authentification et reçoit le lien d'activation.

phoneNumber

string · maxLength: 30 · required

role

string · enum · required

Enum values:

FLEET_ADMINISTRATOR

DAF

language

string · enum

Enum values:

LedgerEntry

id

string · uuid

ref

string | null

type

string · enum

Enum values:

CREDIT

DEBIT

REFUND

HOLD

RELEASE

ADJUSTMENT

amountFcfa

integer

balanceAfterFcfa

integer

source

string | null · enum

Enum values:

BANK_TRANSFER

MOBILE_MONEY

CASH_DEPOSIT

CHEQUE

ADJUSTMENT

reference

string | null

Référence du versement, préfixée par votre identifiant d'apporteur.

Example: RS-12-VIR-2026-0831-004

transactionId

string | null · uuid

createdAt

string | null · date-time

Transaction

id

string · uuid

ref

string | null

status

string · enum

Enum values:

CREATED

PREAUTHORIZED

VALIDATED

CONFIRMED

CANCELED

EXPIRED

FAILED

REFUNDED

companyId

integer

amountFcfa

integer

fuelType

string

unitPriceFcfa

integer

object

selfService

boolean

Transaction conduite par le chauffeur seul, sans validation d'un pompiste.

station

object | null

driver

object | null

vehicle

object | null

createdAt

string | null · date-time

confirmedAt

string | null · date-time

canceledAt

string | null · date-time

Alert

id

integer

companyId

integer | null

type

string

severity

string · enum

Enum values:

INFO

WARNING

CRITICAL

status

string · enum

Enum values:

OPEN

ACKNOWLEDGED

DISMISSED

RESOLVED

title

string

message

string

triggeredAt

string | null · date-time

acknowledgedAt

string | null · date-time

resolvedAt

string | null · date-time

CreditRequestBody

amountFcfa

integer · min: 1 · required

source

string · enum · required

Nature réelle du versement constaté.

Enum values:

BANK_TRANSFER

MOBILE_MONEY

CASH_DEPOSIT

CHEQUE

clientReference

string · maxLength: 100 · required

Votre référence de versement. Préfixée côté serveur, sans collision possible avec un autre partenaire.

proofIds

string[] · maxItems: 3 · required

Identifiants renvoyés par POST …/wallet/credit/proof.

note

string · maxLength: 500

CreditRequest

id

string · uuid

status

string · enum

Enum values:

PENDING_APPROVAL

APPROVED

REJECTED

EXPIRED

companyId

integer | null

amountFcfa

integer | null

source

string | null

clientReference

string | null

requestedAt

string | null · date-time

decidedAt

string | null · date-time

expiresAt

string | null · date-time

rejectedReason

string | null