Passer au contenu
Jeton/
Créer un jeton

Pay Station API (2.0)

Présentation

  • 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.

Télécharger la description d'OpenAPI
index.json
index.yaml
Langues
Serveurs
Mock server
https://xsolla.redocly.app/_mock/fr/api/pay-station/
https://api.xsolla.com/merchant/v2/

Jeton

Opérations

Créer un jeton

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.

Sécurité
basicAuth
Chemin
merchant_idintegerobligatoire

ID de commerçant.

Corpsapplication/jsonobligatoire
custom_parametersobject(custom_parameters)

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.

purchaseobject(purchase)

Informations sur l'achat.

settingsobject(settings)

Paramètres pour la configuration de la procédure de paiement et de l'interface de paiement pour l'utilisateur.

userobject(user)

Informations sur l'utilisateur.

curl -i -X POST \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/fr/api/pay-station/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"
      }
    }
  }'

Réponses

Created.

Corpsapplication/json
tokenstring
Réponse
application/json
{
  "token": "eop57k1boA7nnYPtewZ6KEXJyJADEwRT"
}

Tokénisation

Opérations

Rapports

Opérations

Remboursement

Opérations

Tests

Opérations