Passer au contenu
/
Supprimer un compte enreg...

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
https://api.xsolla.com/merchant/v2/
Mock server
https://xsolla.redocly.app/_mock/fr/api/pay-station/

Jeton

Opérations

Tokénisation

Opérations

Lire les comptes enregistrés

Requête

Récupère la liste des comptes de paiement enregistrés d'un utilisateur donné.

Note

En mode bac à sable, cet appel API fonctionne uniquement avec les cartes de test dépourvues de la fonction 3-D Secure.

Sécurité
basicAuth
Chemin
project_idintegerobligatoire

ID de projet.

user_idstringobligatoire

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.

Requête
modestring

Définissez sur sandbox pour tester le processus de paiement. Supprimez le paramètre pour effectuer des paiements réels.

curl -i -X GET \
  -u <username>:<password> \
  'https://api.xsolla.com/merchant/v2/projects/{project_id}/users/{user_id}/payment_accounts?mode=string'

Réponses

OK.

Corpsapplication/json
Réponse
application/json
[
  {
    "id": 4612345,
    "name": "PP_saved_account",
    "payment_system": { … },
    "type": "paypal"
  }
]

Supprimer un compte enregistré

Requête

Supprime un compte de paiement enregistré.

Note

En mode bac à sable, cet appel API fonctionne uniquement avec les cartes de test dépourvues de la fonction 3-D Secure.

Note

Pour appeler cette méthode API en mode bac à sable, passez les données du compte de paiement de test dans la requête. Reportez-vous aux instructions pour plus d'informations sur l'accès au mode bac à sable et les scénarios de test.

Sécurité
basicAuth
Chemin
project_idintegerobligatoire

ID de projet.

user_idstringobligatoire

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.

typestringobligatoire

Type de compte de paiement.

Enum ValeurDescription
alipayplus_boost

Boost.

alipayplus_cn

Alipay.

alipayplus_dana

DANA.

alipayplus_gcash

GCash.

alipayplus_hk

Alipay (Hong Kong).

alipayplus_kplus

K PLUS.

alipayplus_maya

Maya.

alipayplus_rabbitlinepay

Rabbit LINE pay.

alipayplus_tng

Touch 'n Go.

alipayplus_truemoney

TrueMoney Wallet.

account_idintegerobligatoire

ID du compte enregistré dans la base de données Xsolla.

curl -i -X DELETE \
  -u <username>:<password> \
  'https://api.xsolla.com/merchant/v2/projects/{project_id}/users/{user_id}/payment_accounts/{type}/{account_id}'

Réponses

No Content.

Prélever sur un compte enregistré

Requête

Facture un utilisateur via un compte de paiement enregistré.

Note

En mode bac à sable, cet appel API fonctionne uniquement avec les cartes de test dépourvues de la fonction 3-D Secure.

Remarque

Pour que l'appel API fonctionne correctement, configurez un délai d'attente de 2 minutes.

Sécurité
basicAuth
Chemin
project_idintegerobligatoire

ID de projet.

user_idstringobligatoire

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.

typestringobligatoire

Type de compte de paiement.

Enum ValeurDescription
alipayplus_boost

Boost.

alipayplus_cn

Alipay.

alipayplus_dana

DANA.

alipayplus_gcash

GCash.

alipayplus_hk

Alipay (Hong Kong).

alipayplus_kplus

K PLUS.

alipayplus_maya

Maya.

alipayplus_rabbitlinepay

Rabbit LINE pay.

alipayplus_tng

Touch 'n Go.

alipayplus_truemoney

TrueMoney Wallet.

account_idintegerobligatoire

ID du compte enregistré dans la base de données Xsolla.

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.

custom_parameters.​active_datestring

Date de dernière visite selon la norme ISO 8601.

custom_parameters.​additional_verificationboolean

Indique si le joueur utilise des méthodes de vérification de compte.

custom_parameters.​character_customizedboolean

Indique si le joueur a personnalisé son personnage.

custom_parameters.​chat_activityboolean

Indique si le joueur utilise la fonction de chat.

custom_parameters.​completed_tasksinteger

Nombre de tâches/objectifs terminés.

custom_parameters.​forum_activityboolean

Indique si le joueur utilise la fonction forum.

custom_parameters.​items_usedboolean

Indique si le joueur utilise des objets achetés dans le jeu.

custom_parameters.​karma_pointsinteger

Karma du joueur.

custom_parameters.​last_change_password_datestring

Date de dernier changement de mot de passe selon la norme ISO 8601.

custom_parameters.​non_premium_currencynumber(float)

Quantité de la monnaie non-premium.

custom_parameters.​notifications_enabledboolean

Indique si le joueur a activé les notifications.

custom_parameters.​profile_completedboolean

Indique si le joueur a ajouté des informations supplémentaires à son profil.

custom_parameters.​profile_image_addedboolean

Indique si le joueur a téléchargé une image de profil.

custom_parameters.​pvp_activityboolean

Détermine la participation du joueur à des combats JcJ (joueur(s) contre joueur(s)).

custom_parameters.​registration_datestring

Date de création de compte selon la norme ISO 8601.

custom_parameters.​session_timestring

Durée moyenne de session selon la norme ISO 8601.

custom_parameters.​social_networks_addedboolean

Indique si le joueur a connecté des profils de médias sociaux.

custom_parameters.​total_bansinteger

Nombre de fois que le joueur a été banni du chat/forum.

custom_parameters.​total_charactersinteger

Nombre de personnages dans le jeu.

custom_parameters.​total_clansinteger

Nombre de clans dont le joueur est membre.

custom_parameters.​total_friendsinteger

Nombre d'amis.

custom_parameters.​total_game_eventsinteger

Nombre d'événements en jeu auxquels le joueur a participé.

custom_parameters.​total_giftsinteger

Nombre de cadeaux en jeu que le joueur a envoyés/reçus.

custom_parameters.​total_hoursinteger

Nombre total d'heures passées dans le jeu.

custom_parameters.​total_inventory_valuenumber(float)

Valeur totale de l'inventaire en monnaie de jeu.

custom_parameters.​total_sumnumber(float)

Montant total des paiements.

custom_parameters.​tutorial_completedboolean

Indique si le joueur a terminé le tutoriel du jeu.

custom_parameters.​unlocked_achievementsinteger

Nombre de réalisations débloquées.

custom_parameters.​user_levelinteger

Niveau, réputation ou rang du joueur.

custom_parameters.​win_rateinteger

Taux de victoire du joueur.

purchaseobject

Informations sur l'achat.

purchase.​checkoutobject

Informations sur le paiement.

purchase.​checkout.​amountnumber(float)

Montant de l'achat.

purchase.​checkout.​currencystring

Devise d'achat. Code de devise à trois lettres selon la norme ISO 4217.

purchase.​descriptionobject
purchase.​description.​valuestring<= 4000 characters
purchase.​virtual_currencyobject

Informations sur la monnaie virtuelle.

purchase.​virtual_currency.​quantitynumber(float)

Montant de l'achat en monnaie virtuelle.

settingsobject

Paramètres d'achat.

settings.​currencystring(currency)

Devise de paiement préférée. Code de devise à trois lettres selon la norme ISO 4217.

settings.​external_idstring(external_id)

ID de transaction dans le jeu. Il doit être unique pour chaque paiement utilisateur. Reportez-vous à la documentation pour des informations détaillées.

settings.​mock_codeinteger(mock_code)

Un code d'erreur à reproduire lors des tests du processus de paiement via PayPal en mode bac à sable. Assurez-vous de passer le paramètre "mode":"sandbox" pour que le processus fonctionne correctement.

Enum1002101510391046105710891201120318011803
settings.​modestring

Définissez sur sandbox pour tester le processus de paiement. Supprimez le paramètre pour effectuer des paiements réels.

userobject

Informations sur l'utilisateur.

user.​ipstringobligatoire

Adresse IP de l'utilisateur.

user.​legalobject(legal)

Informations de la personne morale.

user.​legal.​addressstring

Adresse légale complète.

user.​legal.​countrystring

Pays de constitution. Code pays à deux lettres majuscules selon la norme ISO 3166-1 alpha-2.

user.​legal.​namestring

Nom légal complet.

user.​legal.​vat_idstring

Numéro d'identification fiscal.

user.​namestring

Nom d'utilisateur.

curl -i -X POST \
  -u <username>:<password> \
  'https://api.xsolla.com/merchant/v2/projects/{project_id}/users/{user_id}/payments/{type}/{account_id}' \
  -H 'Content-Type: application/json' \
  -d '{
    "purchase": {
      "description": {
        "value": "currency purchase"
      },
      "virtual_currency": {
        "quantity": 100
      }
    },
    "settings": {
      "currency": "USD",
      "external_id": "ext123",
      "mode": "sandbox"
    },
    "user": {
      "ip": "111.11.11.11",
      "legal": {
        "address": "17 Crown Street London SW2 0JW United Kingdom",
        "country": "GB",
        "name": "My Awesome Company",
        "vat_id": "GB111111111"
      },
      "name": "John Smith"
    }
  }'

Réponses

Created.

Corpsapplication/json
transaction_idinteger
Réponse
application/json
{
  "transaction_id": 123458390
}

Rapports

Opérations

Remboursement

Opérations

Tests

Opérations