Skip to content

Référence des crédits

Écrans, champs, types de transactions, packs, erreurs de solde insuffisant et endpoints de l'API publique pour les crédits.

ReferenceAdministratorDeveloper

This page has not been translated yet and is shown in French.

Cette page rassemble les écrans de la console, les objets et les endpoints liés aux crédits. L'achat de packs est la seule opération de crédits exposée par l'API publique, https://api.wakastart.app/api.

Accès

ÉlémentCondition
Entrées Tableau de Bord et Consommation du groupe ModulesDroit Facturation, porté par le profil Financier
Badge N crédits de l'en-têteDroit Facturation
Onglet Crédits du paramétrage d'une applicationAccès au Paramétrage de l'application
Page Tarification GénéraleNiveau Propriétaire
GET /api/pay/packsTout appelant authentifié
POST /api/pay/packs/{packCode}/checkout-sessionsNiveau Administrateur client, ou clé API d'un client

Écran Crédits (Tableau de Bord)

ÉlémentContenu
Solde actuelCrédits disponibles du client
Total consomméCumul des débits
Total rechargéCumul des crédits ajoutés
ConsommationGraphique des crédits consommés ; onglets Jour, Semaine, Mois
Top opérationsLes cinq codes d'opération les plus consommateurs
Dernières transactionsLes cinq derniers mouvements ; lien Voir tout

Écran Consommation détaillée

ColonneContenu
DateDate et heure du mouvement
OpérationCode de l'opération facturée
TypeDébit, Crédit, Ajustement ou Remboursement
MontantNombre de crédits du mouvement
Solde aprèsSolde juste après le mouvement
UtilisateurIdentifiant de l'utilisateur à l'origine de l'opération, s'il est connu

L'écran affiche les 20 mouvements les plus récents du filtre choisi. Messages d'état : Aucune transaction, Aucun résultat pour ces filtres.

L'objet Solde

ChampTypeDescription
ownerTypeCUSTOMER ou NETWORKType de titulaire
ownerWidchaîne (6)Identifiant du client ou du réseau
balanceentierCrédits disponibles
totalBoughtentierCumul des crédits ajoutés
totalSpententierCumul des crédits débités

L'objet Transaction

ChampTypeDescription
typeénumérationDEBIT, CREDIT, ADJUSTMENT, REFUND, TRANSFER_IN, TRANSFER_OUT
amountentierNombre de crédits du mouvement
balanceAfterentierSolde après le mouvement
operationCodechaîneCode de l'opération facturée, pour un débit
reasonchaîneMotif, pour un crédit ou un ajustement
createdAtdate ISO 8601Horodatage

Packs de crédits

CodeLibelléCréditsPrix
STARTERPack Starter1009 €
PROPack Pro50039 €
BUSINESSPack Business2 000139 €
ENTERPRISEPack Enterprise10 000599 €

Limites et valeurs

ÉlémentValeur
Coût minimal d'une opération1 crédit
Surcharge0 crédit ou plus ; 0 rend l'opération gratuite
Historique visible dans la console30 jours
Archivage des transactions7 ans, stockage non modifiable
Rafraîchissement du badge de l'en-tête60 secondes
idempotencyKey d'un achat de pack180 caractères, obligatoire

Solde insuffisant

Quand une opération facturée dépasse le solde, le service appelé répond 402 Payment Required et rien n'est débité. Le module Antivirus, par exemple, renvoie le nombre de crédits nécessaires et disponibles :

JSON
{
  "statusCode": 402,
  "message": "Insufficient credits",
  "operation": "SCAN_DOCUMENT",
  "available": 0,
  "required": 1
}

Si votre client n'a encore jamais eu de solde, le message est « No credit account found for customer … », avec le même code 402. Achetez un pack pour ouvrir le solde.

Lister les packs

GET/api/pay/packs

Renvoie les packs en vente : name, creditRatio (crédits par pack), stripeProductId et prices (stripePriceId, unitAmountCents, currency).

Bash
curl -s https://api.wakastart.app/api/pay/packs -H "x-api-key: sk_test_exemple"

Acheter un pack

POST/api/pay/packs/{packCode}/checkout-sessions
ParamètreEmplacementObligatoireDescription
packCodecheminouiSTARTER, PRO, BUSINESS ou ENTERPRISE
successUrlcorpsouiRetour après paiement, sur https://app.wakastart.app
cancelUrlcorpsouiRetour après abandon, même contrainte
idempotencyKeycorpsouiIdentifiant stable de l'achat
customerEmailcorpsnonPrérempli sur la page Stripe
Bash
curl -s -X POST https://api.wakastart.app/api/pay/packs/STARTER/checkout-sessions \
  -H "x-api-key: sk_test_exemple" -H "Content-Type: application/json" \
  -d '{"successUrl":"https://app.wakastart.app/credits","cancelUrl":"https://app.wakastart.app/credits","idempotencyKey":"recharge-0001"}'

Réponse 201 :

JSON
{ "id": "cs_live_Exemple4", "url": "https://checkout.stripe.com/c/pay/cs_live_Exemple4" }
CodeCause
400Pack inconnu, URL de retour hors de la console, champ invalide, ou champ ownerType / ownerWid envoyé dans le corps
403Niveau insuffisant, ou aucun client ni réseau rattaché à l'appelant
404Pack momentanément indisponible à la vente

Voir aussi