English 中文TürkçeРусскийFrançaisTiếng ViệtEspañol日本語
GET /api/v2/server-side-api/vc/balances/

Lister les soldes de monnaie virtuelle

Copy as Markdown

Retourne le solde actuel de chaque monnaie virtuelle pour un profil. Si l'application ne possède aucune monnaie virtuelle, data est un tableau vide.

Header parameters

adapty-customer-user-idstring

L'identifiant unique du client dans votre système. L'un des champs adapty-customer-user-id ou adapty-profile-id est obligatoire.

adapty-profile-idstring

L'identifiant unique du profil dans votre système. Recommandé si vous travaillez avec des profils anonymes. L'un des champs adapty-customer-user-id ou adapty-profile-id est obligatoire.

Responses

Soldes retournés avec succès

Schema

Soldes actuels de toutes les devises virtuelles d'un profil.

response_created_atintegerrequired

Date de génération de la réponse, sous forme d'horodatage Unix en millisecondes.

dataarray of objectrequired
codestringrequired

Code unique de la devise virtuelle au sein de l'application. Lettres ASCII, chiffres et underscore.

namestringrequired

Nom d'affichage de la devise virtuelle.

balanceintegerrequired

Solde total, incluant les montants actuellement retenus.

heldintegerrequired

Somme de toutes les retenues actives (montants réservés). Toujours 0 actuellement.

availableintegerrequired

Solde disponible à dépenser, calculé comme balance - held.

Example 
{
  "response_created_at": 1779791400000,
  "data": [
    {
      "code": "COINS",
      "name": "Gold Coins",
      "balance": 12450,
      "held": 0,
      "available": 12450
    },
    {
      "code": "GEMS",
      "name": "Gems",
      "balance": 3280,
      "held": 0,
      "available": 3280
    },
    {
      "code": "ENERGY",
      "name": "Energy",
      "balance": 840,
      "held": 0,
      "available": 840
    }
  ]
}

Requête invalide.

Schema
errorsarray of objectrequired
sourcestring

Source de l'erreur

errorsarray of string

Tableau de messages d'erreur

error_codestringrequired

Nom court de l'erreur

status_codeintegerrequired

Code de statut HTTP

Non autorisé. La clé API est manquante ou invalide.

Schema
errorsarray of objectrequired
sourcestring

Source de l'erreur

errorsarray of string

Tableau de messages d'erreur

error_codestringrequired

Nom court de l'erreur

status_codeintegerrequired

Code de statut HTTP

Accès refusé. L'API Serveur pour les monnaies virtuelles n'est pas activée pour cette application.

Schema
errorsarray of objectrequired
sourcestring

Source de l'erreur

errorsarray of string

Tableau de messages d'erreur

error_codestringrequired

Nom court de l'erreur

status_codeintegerrequired

Code de statut HTTP

Profil introuvable.

Schema
errorsarray of objectrequired
sourcestring

Source de l'erreur

errorsarray of string

Tableau de messages d'erreur

error_codestringrequired

Nom court de l'erreur

status_codeintegerrequired

Code de statut HTTP

Erreur interne du serveur