Indique si le joueur utilise la fonction de chat.
Subscriptions API (2.0)
- Version : 2.0
- Serveurs :
https://api.xsolla.com/merchant/v2/
Cette référence API décrit les endpoints pour la gestion des abonnements, des coupons et des promotions. Pour plus d'informations sur les abonnements, consultez le guide du produit et le glossaire.
Télécharger la description d'OpenAPI
Langues
Serveurs
Mock server
https://xsolla.redocly.app/_mock/fr/api/subscriptions/
Requête
Vous pouvez créer un jeton avec des paramètres utilisateur arbitraires. Vous envoyez ces paramètres lors de l'obtention du jeton et les recevez en retour après un paiement réussi. Un jeton ne peut contenir que des paramètres décrits dans ce document ou prédéfinis par vous.
Si un paramètre est envoyé dans un format incorrect ou a un type incorrect, aucun jeton ne sera émis. Vous recevrez un code HTTP 422 avec la description de l'erreur dans le corps JSON. Dans extended_message, vous recevrez une information sur les paramètres exacts qui ont été envoyés de manière incorrecte.
Remarque
Cet appel API ne contient pas le paramètre de chemin project_id, vous devez donc utiliser la clé API valide dans tous les projets de l'entreprise pour l'autorisation.
Sécurité
basicAuth
Vous pouvez passer des paramètres supplémentaires dans le jeton dans l'objet custom_parameters pour configurer les filtres anti-fraude. Les paramètres recommandés sont indiqués dans la liste déroulante. Voir la documentation de Pay Station.
Date de dernière visite selon la norme ISO 8601.
Indique si le joueur utilise des méthodes de vérification de compte.
Date de dernier changement de mot de passe selon la norme ISO 8601.
Indique si le joueur a ajouté des informations supplémentaires à son profil.
Date de création de compte selon la norme ISO 8601.
Durée moyenne de session selon la norme ISO 8601.
Indique si le joueur a connecté des profils de médias sociaux.
Nombre d'événements en jeu auxquels le joueur a participé.
Valeur totale de l'inventaire en monnaie de jeu.
Informations sur l'achat.
Exemple: {"checkout":{"amount":10,"currency":"USD"},"subscription":{"gift":{"email":"recipient_email@email.com","recipient":"test_recipient_v1"}}}
Informations sur le paiement.
Exemple: {"amount":10,"currency":"USD"}
Devise d'achat. Code de devise à trois lettres selon la norme ISO 4217.
Exemple: "USD"
Données d'abonnement.
Exemple: {"gift":{"email":"recipient_email@email.com","recipient":"test_recipient_v1"}}
Plans d'abonnement à afficher dans l'interface de paiement.
Informations sur l'abonnement cadeau
Exemple: {"email":"recipient_email@email.com","recipient":"test_recipient_v1"}
Détermine le masquage du donateur. Si true, le nom de l'expéditeur est masqué dans la notification par e-mail. La valeur par défaut est false.
Adresse e-mail du destinataire.
Exemple: "recipient_email@email.com"
ID du destinataire.
Exemple: "test_recipient_v1"
Fournissez ici un lien vers une page contenant des informations supplémentaires sur l'abonnement cadeau ou vers la page de création de compte. Le destinataire du cadeau peut naviguer vers cette page à partir de la notification par e-mail du cadeau d'abonnement.
Type d'opération appliqué au plan d'abonnement de l'utilisateur. Pour modifier le plan d'abonnement, passez la valeur change_plan. Vous devez passer l'ID du nouveau plan dans le paramètre purchase.subscription.plan_id.
ID externe du plan d'abonnement. Il se trouve dans le compte éditeur sous la section Subscriptions > Subscription plans.
Paramètres personnalisés de projet.
Exemple: {"currency":"USD","language":"en","project_id":16184,"ui":{"components":{"virtual_currency":{"custom_amount":true}},"desktop":{"virtual_item_list":{"button_with_price":true,"layout":"list"}},"size":"medium"}}
Devise de paiement préférée. Code de devise à trois lettres selon la norme ISO 4217.
Exemple: "USD"
ID de transaction dans le jeu. Il doit être unique pour chaque paiement d'utilisateur.
Passez la valeur sandbox pour tester le processus de paiement. Dans ce cas, utilisez l'URL https://sandbox-secure.xsolla.com pour accéder à l'interface de paiement de test.
Widget de paiement. La valeur peut être paybycash ou giftcard. Si le paramètre est défini, l'utilisateur est redirigé vers le widget Pay by Cash ou Gift Cards, respectivement.
Enum"paybycash""giftcard"
ID Xsolla du jeu. Il se trouve dans le compte éditeur.
Exemple: 16184
Paramètres de la politique de redirection.
Détermine si l'utilisateur doit être redirigé automatiquement à partir de la page d'état.
Délai (en secondes) après lequel l'utilisateur est automatiquement redirigé vers l'URL de retour.
Comportement de Pay Station lorsque l'utilisateur ferme la fenêtre ou clique sur le bouton Back to the Game. La valeur peut être redirect (par défaut) ou postmessage. Si le paramètre est défini sur redirect, l'utilisateur est redirigé vers l'URL passée dans le jeton ou spécifiée dans le compte éditeur. S'il est défini sur postmessage, l'utilisateur n'est pas redirigé vers une autre page. Dans ce cas, la fermeture de la fenêtre déclenche l'envoi de l'événement close, tandis qu'un clic sur le bouton Back to the Game, l'envoi de l'événement return.
Enum"redirect""postmessage"
Statut de paiement pour lequel l'utilisateur est redirigé vers l'URL de retour. La valeur peut être none, successful, successful_or_canсeled, ou any.
Enum"none""successful""successful_or_canceled""any"
Page vers laquelle rediriger l'utilisateur après le paiement. Les paramètres user_id, foreigninvoice, invoice_id et status seront automatiquement ajoutés au lien.
Paramètres d'interface.
Exemple: {"components":{"virtual_currency":{"custom_amount":true}},"desktop":{"virtual_item_list":{"button_with_price":true,"layout":"list"}},"size":"medium"}
Paramètres de menu.
Exemple: {"virtual_currency":{"custom_amount":true}}
Paramètres du sous-menu des plans d'abonnement.
Paramètres du sous-menu de la monnaie virtuelle.
Exemple: {"custom_amount":true}
Détermine si l'utilisateur peut saisir une quantité aléatoire de monnaie virtuelle dans l'interface de paiement.
Exemple: true
settings.ui.components.virtual_currency.hiddenboolean
Détermine l'affichage du sous-menu.
Paramètres du sous-menu des objets virtuels.
settings.ui.components.virtual_items.hiddenboolean
Détermine l'affichage du sous-menu.
Groupe à afficher après l'ouverture de l'onglet des objets virtuels.
Paramètres de l'interface pour la version de bureau.
Exemple: {"virtual_item_list":{"button_with_price":true,"layout":"list"}}
Paramètres de l'en-tête.
Détermine l'affichage du bouton Fermer sur la version de bureau de Pay Station. Un clic sur ce bouton ferme Pay Station et redirige l'utilisateur vers l'URL passée dans le paramètre settings.return_url. Défini sur false par défaut.
Détermine l'affichage de l'en-tête dans l'interface de paiement.
Apparence de l'en-tête. La valeur peut être compact (le nom du projet et l'ID utilisateur ne s'affichent pas) ou normal (par défaut).
Enum"compact""normal"
Si défini sur true, votre logo s'affiche dans l'en-tête (vous devez avoir fourni l'image à votre responsable de la réussite client).
Détermine l'affichage du nom du projet dans l'en-tête.
Paramètres de la liste des plans d'abonnement.
Texte à afficher dans l'interface de paiement au-dessus de la liste des plans d'abonnement disponibles.
Si défini sur true, et que la devise locale de l'utilisateur diffère de la devise de base du plan d'abonnement, l'utilisateur voit deux prix : l'un dans la devise locale et l'autre dans la devise de base.
Paramètres de la liste des monnaies virtuelles.
Si défini sur true, le prix s'affiche sur le bouton. Si défini sur false, le prix s'affiche à gauche du bouton. Défini sur false par défaut.
Paramètres de la liste des objets virtuels.
Exemple: {"button_with_price":true,"layout":"list"}
Si défini sur true, le prix s'affiche sur le bouton. Si défini sur false, le prix s'affiche à gauche du bouton. Défini sur false par défaut.
Exemple: true
Modèle de liste. La valeur peut être list (par défaut) ou grid.
Enum"list""grid"
Exemple: "list"
Détermine la désactivation des liens de redirection vers une ressource externe. Défini sur true par défaut. Un clic sur un lien externe déclenche l'envoi de l'événement external-link-open via le mécanisme postMessage. L'adresse du lien de redirection est passée dans le paramètre url.
Mode d'interface dans Pay Station. L'unique valeur possible est user_account. Dans ce mode, l'en-tête ne contient que le menu de navigation du compte, et l'utilisateur ne peut ni sélectionner un produit ni effectuer un paiement. Ce mode est disponible uniquement sur la version de bureau.
Taille de l'interface de paiement. La valeur peut être :
- small : taille minimale possible de l'interface de paiement. Utilisez cette valeur lorsque la taille de la fenêtre est strictement limitée (dimensions : 620 x 630)
- medium : taille recommandée. Utilisez cette valeur pour afficher l'interface de paiement dans une lightbox (dimensions : 740 x 760)
- large : taille optimale pour afficher l'interface de paiement dans une nouvelle fenêtre ou un nouvel onglet (dimensions : 820 x 840)
Enum"small""medium""large"
Exemple: "medium"
Thème de l'interface de paiement. La valeur peut être default ou default_dark.
Enum"default""default_dark"
Informations de compte utilisateur.
Sous-menu History
Page My account.
Sous-menu My payment accounts.
Informations sur l'utilisateur.
Exemple: {"age":19,"country":{"allow_modify":true,"value":"US"},"email":{"value":"john.smith@mail.com"},"id":{"value":"user_2"},"name":{"value":"John Smith"}}
Attributs de l'utilisateur nécessaires pour filtrer la liste des objets. Ils se présentent sous la forme d'un JSON valide de paires clé-valeur.
Exemple: {"allow_modify":true,"value":"US"}
Détermine si l'utilisateur peut changer le pays dans l'interface de paiement. Par défaut, si le paramètre country.value est passé dans le jeton, la valeur est false.
Exemple: true
Code pays à deux lettres majuscules selon la norme ISO 3166-1 alpha-2.
Exemple: "US"
L'objet user.email est essentiel pour construire les modèles anti-fraude et permet d'améliorer les taux d'acceptation. C'est une exigence à la fois de Xsolla et des systèmes de paiement. Si ce paramètre n'est pas passé, un champ obligatoire pour la saisie de l'adresse e-mail apparaît sur la page de paiement. L'utilisateur reçoit ensuite un reçu d'achat à l'adresse e-mail indiquée dans ce paramètre ou celle saisie sur la page de paiement.
Exemple: {"value":"john.smith@mail.com"}
Adresse e-mail de l'utilisateur. Doit être valide selon le protocole RFC 822.
Exemple: "john.smith@mail.com"
Exemple: {"value":"user_2"}
Informations de la personne morale. L'objet et tous ses paramètres sont requis si user.is_legal est défini sur true.
Pays de constitution. Code pays à deux lettres majuscules selon la norme ISO 3166-1 alpha-2.
Exemple: {"value":"John Smith"}
Attributs de trafic.
Canal de trafic (annonces contextuelles, annonces par affichage, e-mailing, etc.).
Mot-clé de la campagne. Si ce paramètre est défini, les statistiques seront basées sur les mots-clés utilisés pour le ciblage des annonces plutôt que sur des requêtes de recherche spécifiques. Dans Google Analytics, le terme utm_term spécifié fait partie du rapport général sur les termes de recherche.
- https://api.xsolla.com/merchant/v2/merchants/{merchant_id}/token
- Mock serverhttps://xsolla.redocly.app/_mock/fr/api/subscriptions/merchants/{merchant_id}/token
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
-u <username>:<password> \
'https://xsolla.redocly.app/_mock/fr/api/subscriptions/merchants/{merchant_id}/token' \
-H 'Content-Type: application/json' \
-d '{
"purchase": {
"checkout": {
"amount": 10,
"currency": "USD"
},
"subscription": {
"gift": {
"email": "recipient_email@email.com",
"recipient": "test_recipient_v1"
}
}
},
"settings": {
"currency": "USD",
"language": "en",
"project_id": 16184,
"ui": {
"components": {
"virtual_currency": {
"custom_amount": true
}
},
"desktop": {
"virtual_item_list": {
"button_with_price": true,
"layout": "list"
}
},
"size": "medium"
}
},
"user": {
"age": 19,
"country": {
"allow_modify": true,
"value": "US"
},
"email": {
"value": "john.smith@mail.com"
},
"id": {
"value": "user_2"
},
"name": {
"value": "John Smith"
}
}
}'Réponse
application/json
{ "token": "eop57k1boA7nnYPtewZ6KEXJyJADEwRT" }