Indique si le joueur utilise la fonction de chat.
Pay Station API (2.0)
- Version : 2.0.0
- Serveurs :
https://api.xsolla.com/api
Pay Station permet aux partenaires de monétiser leurs produits en fournissant aux utilisateurs une interface pratique pour payer les achats en jeu dans le magasin de jeu. Pour configurer l'ouverture de l'interface de paiement, reportez-vous à ces instructions.
Pay Station API fournit les groupes d'appels suivants :
- Jeton — comprend l'appel API pour générer un jeton avec des paramètres utilisateur arbitraires pour le traitement ultérieur du paiement via l'interface de paiement.
- Tokénisation — comprend les appels API pour traiter les paiements en toute sécurité sans ouvrir l'interface de paiement ni impliquer l'utilisateur.
- Rapports — comprend les appels API pour renvoyer des données sur les transactions des utilisateurs, pour générer des rapports et pour répartir les virements par devises.
- Remboursement — comprend les appels API pour demander des remboursements intégraux et partiels.
- Test — comprend l'appel API pour tester le processus de chargeback.
Pour plus d'informations sur la configuration de l'interface de paiement, reportez-vous au guide d'intégration de la solution Payments.
Note
Vous pouvez également vous référer à la section Xsolla Base API dans la collection Postman pour tester les appels API utilisés pour l'intégration.
Requête
Vous pouvez créer un jeton avec n'importe quels paramètres utilisateur. Envoyez- les lors de la création du jeton et vous les recevez en réponse après le paiement réussi. Un jeton ne peut contenir que les paramètres décrits dans le présent document ou ceux que vous avez préalablement définis.
Si un paramètre est passé dans un format ou un type incorrect, aucun jeton ne sera délivré. Vous recevrez un code HTTP 422 avec la description de l'erreur dans le corps JSON. Dans ce cas, le paramètre extended_message contient les informations sur les paramètres précis qui ont été passés de manière incorrecte.
Par défaut, la durée de vie du jeton est de 24 heures. Si vous souhaitez modifier cette valeur, contactez votre responsable de la réussite client ou envoyez un e-mail à csm@xsolla.com. La nouvelle valeur sera activée pour tous les projets de votre entreprise créés dans le Compte éditeur.
Remarque
Le jeton obtenu suite à l'appel à cette méthode API ne peut être utilisé que pour autoriser d'autres requêtes. Ce jeton peut être utilisé pour ouvrir l'interface de paiement uniquement si vous avez intégré le produit Subscriptions.
Pour ouvrir l'interface de paiement dans une nouvelle fenêtre, utilisez le lien suivant : https://secure.xsolla.com/paystation4/?token={token}, où {token} est le jeton reçu.
À des fins de test, utilisez cette URL : https://sandbox-secure.xsolla.com/paystation4/?token={token}.
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.
Cet objet comprend des paramètres pour configurer les filtres anti-fraude. La liste des paramètres est présentée ci-dessous. Pour des paramètres personnalisés, contactez votre responsable de la réussite client ou envoyez un e-mail à csm@xsolla.com.
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.
Détermine la participation du joueur à des combats JcJ (joueur(s) contre joueur(s)).
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.
Données d'abonnement.
Plans d'abonnement à afficher dans l'interface de paiement.
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 pour la configuration de la procédure de paiement et de l'interface de paiement pour l'utilisateur.
Devise de paiement préférée. Code de devise à trois lettres selon la norme ISO 4217.
ID de transaction dans le jeu. Il doit être unique pour chaque paiement utilisateur. Reportez-vous à la documentation pour des informations détaillées.
Langue d'interface. Code de langue à deux lettres minuscules.
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.
ID Xsolla du jeu. Il se trouve dans le compte éditeur.
Paramètres de la politique de redirection.
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 Revenir au jeu. 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 Revenir au jeu, l'envoi de l'événement return.
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.
Détermine l’affichage d’un minuteur de redirection sur la page d’état du paiement. La durée du compte à rebours est définie par la valeur du paramètre settings.redirect_policy.delay.
URL de la page vers laquelle l'utilisateur est redirigé après le paiement. Reportez-vous à la documentation pour des informations détaillées sur la configuration des redirections.
Paramètres d'interface.
Autre vue de l’écran de l’interface de paiement lorsqu’il est ouvert, pouvant par exemple afficher les modes de paiement les plus utilisés.
Lorsque cette option est définie sur apple-pay, l’utilisateur voit le bouton Apple Pay comme mode de paiement principal, avec un lien vers les autres options. Cette logique ne s’applique pas aux appareils Android.
Détermine l'affichage du bouton de paiement rapide via Apple Pay en haut de l'interface de paiement sur les appareils compatibles. La valeur par défaut est true. Si false, Apple Pay est affiché dans la liste des modes de paiement selon l'algorithme PayRank.
Note
Sur les appareils Android et sur ceux qui ne prennent pas en charge Apple Pay, ce mode de paiement sera toujours masqué, quel que soit le paramètre défini.
Paramètres de menu.
Paramètres du sous-menu des plans d'abonnement.
Paramètres du sous-menu de la monnaie virtuelle.
Détermine si l'utilisateur peut saisir une quantité aléatoire de monnaie virtuelle dans l'interface de paiement.
Détermine l'affichage du sous-menu.
Paramètres du sous-menu des objets virtuels.
Détermine l'affichage du sous-menu.
Groupe à afficher après l'ouverture de l'onglet des objets virtuels.
Définissez sur code pour afficher un code de devise à trois lettres selon la norme ISO 4217 dans l'interface de paiement. Par défaut, le symbole de la devise est affiché à la place du code de devise à trois lettres.
Paramètres de l'interface pour la version de bureau.
Paramètres de l'en-tête.
Détermine l'affichage du bouton Fermer dans l'interface de paiement. Un clic sur ce bouton ferme l'interface de paiement et redirige l'utilisateur vers l'URL passée dans le paramètre settings.return_url. Défini sur false par défaut.
Icône du bouton Fermer dans l'interface de paiement.
| Enum Valeur | Description |
|---|---|
| arrow | Icône ← à gauche de l'en-tête de l'interface de paiement. |
| cross | Icône × à droite de l'en-tête de l'interface de paiement. |
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).
Si true, le logo s'affiche dans l'en-tête. Pour télécharger l'image, ouvrez votre projet dans le Compte éditeur et accédez à la section Pay Station > Settings.
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.
Mode d'affichage du mode de paiement Google Pay. Si la valeur est true, le bouton de paiement rapide via Google Pay s'affiche en haut de l'interface de paiement, quel que soit l'appareil ou le navigateur utilisé. Si la valeur est false, Google Pay apparaît dans la liste des modes de paiement, selon l'algorithme PayRank. Si le paramètre n'est pas passé, Google Pay s'affiche en haut de l'interface de paiement sur tous les appareils et navigateurs, à l'exception de Safari, où il apparaît dans la liste des modes de paiement.
Affichage de la liste des objets du panier et des informations financières dans l’interface de paiement. Lorsque la valeur est définie sur true, les informations s’affichent en vue développée. Si elle est définie sur false (valeur par défaut) ou si le paramètre est omis, les informations s’affichent en vue réduite.
Détermine la redirection des utilisateurs du navigateur du lanceur intégré (WebView) vers leur navigateur par défaut pour effectuer un achat. La valeur par défaut est false.
Détermine l'affichage du sélecteur de langue sur la page de paiement. Si la valeur est false (valeur par défaut), le sélecteur est affiché.
Détermine l'affichage de la liste des modes de paiement disponibles dans le pays de l'utilisateur à l'ouverture de l'interface de paiement. Si false (par défaut), le mode de paiement passé dans le paramètre settings.payment_method ou le mode sélectionné selon l'algorithme du PayRank s'affiche.
Détermine la désactivation des liens de redirection vers une ressource externe. Défini sur false 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.
Détermine l'affichage de la barre de recherche de modes de paiement dans l'interface. Si true, la barre de recherche est cachée. La valeur par défaut est false.
Détermine l'affichage d'une infobulle sur le traitement de la transaction au passage de la souris sur l'icône × avant la fermeture de la page de paiement. Défini sur false, ou si le paramètre n'est pas passé, l'infobulle ne s'affiche pas. La valeur par défaut est true.
Détermine l'ouverture de la vérification 3-D Secure dans une nouvelle fenêtre du navigateur. Définissez sur true, si votre configuration applique une politique de sécurité du contenu (CSP).
Emplacement des principaux éléments de l'interface de paiement. Vous pouvez ouvrir l'interface de paiement à l'intérieur de votre jeu et/ou permuter les colonnes contenant des informations sur la commande et les modes de paiement. Reportez-vous aux instructions de customisation pour des informations détaillées.
Détermine l'affichage du bouton Fermer dans la version mobile 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.
Mode d’affichage de l’interface de paiement pour gérer les modes de paiement enregistrés. Peut être défini sur user_account ou omis. Dans ce mode, l’utilisateur peut uniquement changer la langue, ajouter de nouveaux moyens de paiement et supprimer ceux existants.
Note
Lorsque ce paramètre est passé, le bouton de redirection ne s'affiche pas. Pour rediriger un utilisateur après l'enregistrement d'un moyen de paiement, configurez les redirections automatiques.
Thème d'interface de paiement. Les valeurs possibles sont : 63295a9a2e47fab76f7708e1 pour le thème clair (par défaut) ou 63295aab2e47fab76f7708e3 pour le thème foncé. Vous pouvez également créer un thème personnalisé et passez son ID dans ce paramètre.
Informations de compte utilisateur.
Section Modes de paiement enregistrés.
Détermine l'affichage dans l'interface de paiement de l'icône de crayon qui mène à la page d'édition des modes de paiement. La valeur par défaut est true.
Informations sur l'utilisateur.
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.
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.
Code pays à deux lettres majuscules selon la norme ISO 3166-1 alpha-2.
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.
Détermine si l'utilisateur peut entrer son adresse e-mail dans l'interface de paiement. Par défaut, si le paramètre user.email.value est passé dans le jeton, la valeur est false.
Adresse e-mail de l'utilisateur. Doit être valide selon le protocole RFC 822.
ID utilisateur unique dans le jeu stocké de votre côté. Assurez-vous de passer l'ID existant. En cas d'erreur, consultez les réponses de la FAQ.
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.
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/pay-station/merchants/{merchant_id}/token
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
-u <username>:<password> \
'https://api.xsolla.com/merchant/v2/merchants/{merchant_id}/token' \
-H 'Content-Type: application/json' \
-d '{
"settings": {
"currency": "USD",
"language": "en",
"project_id": 16184,
"ui": {
"size": "medium"
}
},
"user": {
"email": {
"value": "email@example.com"
},
"id": {
"value": "user_2"
},
"name": {
"value": "John Smith"
}
}
}'{ "token": "eop57k1boA7nnYPtewZ6KEXJyJADEwRT" }