Passer au contenu

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

Rapports

Opérations

Remboursement

Opérations

Demander un remboursement partiel

Requête

Envoie une requête de remboursement partiel à l'utilisateur. Pour des informations détaillées sur le processus de remboursement et les modes de paiement qui prennent en charge les remboursements partiels, reportez-vous à notre documentation.

Note

Pour appeler cette méthode API en mode bac à sable, passez les données 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.

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.

transaction_idintegerobligatoire

ID de transaction.

Corpsapplication/jsonobligatoire
descriptionstring<= 4000 charactersobligatoire

Motif de remboursement.

refund_amountnumber(float)obligatoire

Montant de remboursement dans la devise d'achat.

curl -i -X PUT \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/fr/api/pay-station/merchants/{merchant_id}/reports/transactions/{transaction_id}/partial_refund' \
  -H 'Content-Type: application/json' \
  -d '{
    "description": "test refund request",
    "refund_amount": 1.5
  }'

Réponses

Demande de remboursement approuvée.

Réponse
Aucun contenu

Demander un remboursement

Requête

Envoie une demande de remboursement pour restituer un paiement à l'utilisateur. Lisez à propos de la Fonctionnalité de remboursement pour en savoir plus sur le processus.

Note

Pour appeler cette méthode API en mode bac à sable, passez les données 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.

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.

transaction_idintegerobligatoire

ID de transaction.

Corpsapplication/jsonobligatoire
descriptionstring<= 4000 charactersobligatoire

Motif de remboursement.

emailstring<= 100 characters

Adresse e-mail de l'utilisateur.

curl -i -X PUT \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/fr/api/pay-station/merchants/{merchant_id}/reports/transactions/{transaction_id}/refund' \
  -H 'Content-Type: application/json' \
  -d '{
    "description": "test refund request"
  }'

Réponses

OK (Aucune erreur).

Corpsapplication/json
messagestring

Renvoie l'un des messages suivants :

  • No content.
  • The request for a refund has been accepted. Xsolla CS will manually complete the refund. It may take up to two business days.
  • The request for a refund has been accepted. Xsolla CS will automatically send the customer an email with alternative refund options as the user's method does not support direct refunds.
Réponse
application/json
{
  "message": "The request for a refund has been accepted. Xsolla CS will automatically send the customer an email with alternative refund options as the user's method does not support direct refunds."
}

Tests

Opérations