Passer au contenu
/
Prélever sur un compte en...

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

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://xsolla.redocly.app/_mock/fr/api/pay-station/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://xsolla.redocly.app/_mock/fr/api/pay-station/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.

purchaseobject

Informations sur l'achat.

settingsobject

Paramètres d'achat.

userobject

Informations sur l'utilisateur.

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