Synup
Créer une clé
v1Ressources/Clients/getConsulter les crédits du client

Consulter les crédits du client

Lit les crédits affichés dans Clients : reçus, utilisés, disponibles, dernier ajout et les 50 dernières entrées de l’historique. Nécessite un utilisateur identifié de l’agence ayant accès à Clients et au client demandé. L’autorisation client-credits:read est disponible uniquement dans les autorisations personnalisées des clés API. La lecture n’initialise ni ne réinitialise le solde. Aucune quantité d’usage interne, aucun coût fournisseur, identifiant de paiement ou paramètre de crédits n’est renvoyé.

get/api/v1/clients/{id}/credits
client-credits:read
Réponse
dataobjectobligatoire
clientIdstringobligatoire
givenintegerobligatoire
usedintegerobligatoire
remainingintegerobligatoire
lastAddedobjectobligatoire
creditsintegerobligatoire
atstringobligatoire
usedSinceintegerobligatoire
bystringobligatoire
historyarray of objectobligatoire
creditsintegerobligatoire
remainingAfterintegerobligatoire
notestringobligatoire
atstringobligatoire
bystringobligatoire
Erreurs
400Il manque un paramètre requis à la requête, ou elle est invalide.
401Clé API manquante, invalide, expirée ou révoquée.
403La clé n'a pas la permission requise, ou n'est pas autorisée pour ce client/établissement.
404La ressource est introuvable, ou n'appartient pas à votre agence.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
503Le service est temporairement indisponible. Réessayez l’ajout de crédits avec la même clé d’idempotence.
get/api/v1/clients/{id}/credits
Votre clé API
{}

Guides qui utilisent cette ressource