Passer au contenu

Overview

  • Version: 2.0.0
  • Servers: https://store.xsolla.com/api
  • Contact Us by Email
  • Contact URL: https://xsolla.com/
  • Required TLS version: 1.2

Catalog API fournit des endpoints pour gérer le catalogue de votre boutique en jeu et traiter les achats. Utilisez les endpoints pour configurer des objets virtuels, des monnaies virtuelles, des clés de jeu, des lots, des flux de panier et de paiement, des attributs d'articles et pour importer des articles depuis des sources externes.

Télécharger la description d'OpenAPI
Langues
Serveurs
Mock server
https://xsolla.redocly.app/_mock/fr/api/catalog/
https://store.xsolla.com/api/
Opérations
Opérations
Opérations
Opérations
Opérations
Opérations
Opérations
Opérations
Opérations
Opérations
Opérations
Opérations

Créer un jeton de paiement pour un achatServer-side

Requête

Génère une commande et un jeton de paiement pour celle-ci. La commande est générée sur la base des objets passés dans le corps de la requête.

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

Le paramètre user.country.value est utilisé pour sélectionner une devise pour la commande. Si le pays de l'utilisateur est inconnu, fournir l'adresse IP de l'utilisateur dans l'en-tête X-User-Ip est une option alternative.
L'une de ces deux options est nécessaire au bon fonctionnement de cette méthode.
La devise sélectionnée est utilisée pour les méthodes de paiement sur Pay Station.
Sécurité
basicAuth
Chemin
project_idintegerobligatoire

ID de projet. Ce paramètre se trouve dans le Compte éditeur à côté du nom du projet.

Exemple: 44056
Corpsapplication/json
custom_parametersobject or null(Cart-Payment_custom_parameters)[ 1 .. 200 ] properties

Vos paramètres personnalisés représentés sous la forme d'un JSON valide de paires clé-valeur.
Pour configurer des filtres anti-fraude, passez des paramètres supplémentaires via ce champ. Voir la documentation de Pay Station.

Exemple: {"custom_parameters":{"bool_param":true,"int_param":100,"null_param":null,"string_param":"example"}}
promo_codestring(Promotions_coupon_code)[ 1 .. 128 ] characters^[a-zA-Z0-9]+$

Code unique sensible à la casse. Comprend des lettres et des chiffres.

Par défaut "WINTER2021"
Exemple: "WINTER2021"
purchaseobject(Cart_admin_payment)obligatoire
purchase.​itemsArray of objectsnon-emptyobligatoire
purchase.​items[].​quantitynumber>= 1obligatoire

Quantité de l'objet.

Exemple: 2
purchase.​items[].​skustringnon-emptyobligatoire

ID unique de l'objet. L'UGS ne peut comprendre que des caractères alphanumériques latins minuscules et majuscules, des points, des tirets et des traits bas.

Exemple: "t-shirt"
sandboxboolean(Cart-Payment_settings_sandbox)

Passez la valeur true 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.

Par défaut false
settingsobject

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

userobject(Cart-Payment_admin-user-request-body)obligatoire
user.​ageinteger

Âge de l'utilisateur.

user.​countryobject
user.​emailobject
user.​idobjectobligatoire
user.​id.​valuestring[ 1 .. 255 ] characters

ID utilisateur. Pour les tests, passez une valeur aléatoire. Pour accepter des paiements réels, utilisez la valeur de l'ID utilisateur dans votre système. Cet ID est passé dans le webhook User validation.

user.​is_legalboolean

Détermine si l'utilisateur est une personne morale.

user.​legalobject

Informations de la personne morale. L'objet et tous ses paramètres sont requis si user.is_legal est défini sur true.

user.​nameobject
user.​phoneobject
user.​steam_idobject
user.​tracking_idobject
curl -i -X POST \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/fr/api/catalog/v3/project/44056/admin/payment/token \
  -H 'Content-Type: application/json' \
  -d '{
    "purchase": {
      "items": [
        {
          "quantity": 2,
          "sku": "com.xsolla.cup01"
        },
        {
          "quantity": 1,
          "sku": "com.xsolla.t-shirt01"
        },
        {
          "quantity": 1,
          "sku": "com.xsolla.cup01"
        },
        {
          "quantity": 1,
          "sku": "com.xsolla.hat01"
        }
      ]
    },
    "settings": {
      "currency": "USD",
      "external_id": "AABBCCDD01",
      "language": "de",
      "payment_method": 1380,
      "return_url": "https://developers.xsolla.com/fr/",
      "ui": {
        "theme": "63295aab2e47fab76f7708e3"
      }
    },
    "user": {
      "country": {
        "allow_modify": false,
        "value": "US"
      },
      "email": {
        "value": "user@xsolla.com"
      },
      "id": {
        "value": "user-id"
      },
      "name": {
        "value": "user-name"
      }
    }
  }'

Réponses

La commande et le jeton de paiement ont été créés avec succès.

Corpsapplication/json
order_idinteger

ID de commande.

Exemple: 1
tokenstring

Jeton de paiement.

Réponse
application/json
{ "order_id": 12345, "token": "huooAqbXBSJxB8Q4dYBqJp4ybiInqsPb" }
Opérations
Opérations
Opérations
Opérations
Opérations
Opérations
Opérations

Catalogue

Cette API permet de récupérer tout type d'objet vendable ou tout objet spécifique.

Opérations
Opérations
Opérations