Docs Modules Crédits Référence des crédits 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.
Référence Administrateur Développeur
Mis à jour le 23 octobre 2026
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ément Condition Entrées Tableau de Bord et Consommation du groupe Modules Droit Facturation , porté par le profil Financier Badge N crédits de l'en-tête Droit Facturation Onglet Crédits du paramétrage d'une application Accès au Paramétrage de l'application Page Tarification Générale Niveau 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ément Contenu Solde actuel Crédits disponibles du client Total consommé Cumul des débits Total rechargé Cumul des crédits ajoutés Consommation Graphique des crédits consommés ; onglets Jour , Semaine , Mois Top opérations Les cinq codes d'opération les plus consommateurs Dernières transactions Les cinq derniers mouvements ; lien Voir tout
Écran Consommation détaillée#
Colonne Contenu Date Date et heure du mouvement Opération Code de l'opération facturée Type Débit , Crédit , Ajustement ou Remboursement Montant Nombre de crédits du mouvement Solde après Solde juste après le mouvement Utilisateur Identifiant 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#
Champ Type Description ownerTypeCUSTOMER ou NETWORKType de titulaire ownerWidchaîne (6) Identifiant du client ou du réseau balanceentier Crédits disponibles totalBoughtentier Cumul des crédits ajoutés totalSpententier Cumul des crédits débités
L'objet Transaction#
Champ Type Description typeénumération DEBIT, CREDIT, ADJUSTMENT, REFUND, TRANSFER_IN, TRANSFER_OUTamountentier Nombre de crédits du mouvement balanceAfterentier Solde après le mouvement operationCodechaîne Code de l'opération facturée, pour un débit reasonchaîne Motif, pour un crédit ou un ajustement createdAtdate ISO 8601 Horodatage
Packs de crédits#
Code Libellé Crédits Prix STARTERPack Starter 100 9 € PROPack Pro 500 39 € BUSINESSPack Business 2 000 139 € ENTERPRISEPack Enterprise 10 000 599 €
Limites et valeurs#
Élément Valeur Coût minimal d'une opération 1 crédit Surcharge 0 crédit ou plus ; 0 rend l'opération gratuite Historique visible dans la console 30 jours Archivage des transactions 7 ans, stockage non modifiable Rafraîchissement du badge de l'en-tête 60 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 :
{
"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).
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ètre Emplacement Obligatoire Description packCodechemin oui STARTER, PRO, BUSINESS ou ENTERPRISEsuccessUrlcorps oui Retour après paiement, sur https://app.wakastart.app cancelUrlcorps oui Retour après abandon, même contrainte idempotencyKeycorps oui Identifiant stable de l'achat customerEmailcorps non Prérempli sur la page Stripe
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 :
{ "id" : "cs_live_Exemple4" , "url" : "https://checkout.stripe.com/c/pay/cs_live_Exemple4" }
Code Cause 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#