Aller à la documentation
SparkGlimSparkGlim Développeurs
Rechercher dans toute la documentation

Essayez un sujet dans votre langue ou un chemin API exact.

    Référence API

    Configurer une règle de versement

    Crée ou modifie une règle de versement après autorisation withdrawals:approve et contrôles financiers existants.

    POSThttps://api.sparkglim.net/api/white-label/portal/reseller/payout-rules

    Modèle d’accès

    Modèle d’accès
    Session SparkGlim et permissions de membre
    Portée requise
    withdrawals:approve
    Disponibilité documentée
    Implémenté dans le code

    La disponibilité est vérifiée dans le code, pas garantie en production.

    Utilisez le parcours de membre d’équipe Créateur. La revente ne donne jamais accès illimité à la base ou à l’administration.

    En-têtes

    NomTypeValidation
    AuthorizationObligatoire

    Session Bearer SparkGlim existante ; appartenance et capacités attribuées autorisent chaque opération côté serveur.

    stringValidation : Jeton Bearer d’une session authentifiée existante.

    Requête

    NomTypeValidation
    ownerMemberIdFacultatif

    Relation ou révision du compte existante ; propriété et capacités sont vérifiées côté serveur.

    string|nullValidation : UUID.
    ownerCreatorIdFacultatif

    Relation ou révision du compte existante ; propriété et capacités sont vérifiées côté serveur.

    string|nullValidation : UUID.
    statusFacultatif

    État de cycle pris en charge ; les règles d’approbation contrôlent encore publication et accès.

    enumValidation : active | paused | revoked.
    currencyFacultatif

    Valeur de politique de versement du compte ; le serveur contrôle soldes, frais, approbations et règlements.

    stringValidation : ISO3.
    resellerFeeRateFacultatif

    Valeur de politique de versement du compte ; le serveur contrôle soldes, frais, approbations et règlements.

    numberValidation : >=0.
    sparkglimFeeRateFacultatif

    Valeur de politique de versement du compte ; le serveur contrôle soldes, frais, approbations et règlements.

    numberValidation : >=0.
    payoutHoldHoursFacultatif

    Valeur de politique de versement du compte ; le serveur contrôle soldes, frais, approbations et règlements.

    integerValidation : >=0.
    minWithdrawalAmountFacultatif

    Valeur de politique de versement du compte ; le serveur contrôle soldes, frais, approbations et règlements.

    numberValidation : >=0.
    maxWithdrawalAmountFacultatif

    Valeur de politique de versement du compte ; le serveur contrôle soldes, frais, approbations et règlements.

    number|nullValidation : >=0.
    autoEscalateAboveAmountFacultatif

    Valeur de politique de versement du compte ; le serveur contrôle soldes, frais, approbations et règlements.

    number|nullValidation : >=0.
    metadataFacultatif

    Métadonnées JSON supplémentaires acceptées ; elles ne remplacent jamais autorisation, prix ou propriété.

    objectValidation : Objet JSON.

    Requête

    Les exemples décrivent le contrat et ne sont pas exécutés. Utilisez des données de test autorisées ; ne saisissez jamais de secret réel ici.

    POST /api/white-label/portal/reseller/payout-rules
    http
    POST /api/white-label/portal/reseller/payout-rules HTTP/1.1
    Host: api.sparkglim.net
    Authorization: Bearer <EXISTING_SESSION_TOKEN>
    Content-Type: application/json
    
    {
      "currency": "GHS",
      "payoutHoldHours": 24,
      "minWithdrawalAmount": 0
    }

    Réponse

    Réponse de succès · HTTP 201
    json
    {
      "success": true,
      "data": {
        "id": "11111111-1111-4111-8111-111111111111",
        "status": "pending"
      }
    }
    Réponse d’erreur · HTTP 400
    json
    {
      "success": false,
      "error": "<ERROR_MESSAGE>"
    }

    Validation, permissions, données indisponibles et pannes utilisent le statut HTTP et l’erreur du gestionnaire.

    Limites et tentatives

    Limite serveur par défaut : 100 requêtes par IP sur 60 secondes. Des contrôles spécifiques s’appliquent.

    Compatibilité du code

    Les opérations autorisées nécessitent des tests propres au compte.

    • server/src/api/router.ts
    • server/src/api/routes/white-label.ts
    • server/src/white-label/reseller-service.ts
    • server/src/white-label/schemas.ts