Xsolla-logoXsolla Developers
ou
Vers le Compte éditeur

PaiementWebhook POST

Envoyé chaque fois qu'un utilisateur effectue un paiement. Inclut les informations sur le paiement.

Request
Request Body schema: application/json
notification_type
required
string

Type de notification.

required
object

Détails de la transaction (objet).

agreement
integer

ID de contrat.

dry_run
integer

Transaction test. Le paramètre a la valeur 1 s'il s'agit d'une transaction test ou n'est pas envoyé si la transaction est réelle.

external_id
string

External ID de la transaction.

id
integer

ID de transaction.

payment_date
string

Date de paiement.

payment_method
integer

ID de mode de paiement.

payment_method_name
string

Nom de mode de paiement.

payment_method_order_id
string

ID de paiement dans le système de paiement.

required
object

Informations sur le paiement (objet).

object

Retenue à la source directe.

amount
number <float>

Montant.

currency
string

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

percent
number <float>

Taux de retenue à la source directe.

object

Montant payé par l'utilisateur (objet).

amount
number <float>

Montant.

currency
string

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

object

Frais du système de paiement.

amount
number <float>

Montant.

currency
string

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

object

Montant débité du système de paiement.

amount
number <float>

Montant.

currency
string

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

object

Détails de virement (objet).

amount
number <float>

Montant.

currency
string

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

payout_currency_rate
string

Taux de change entre les devises de paiement et de virement.

object

Données sur les frais de rapatriement imposés à Xsolla par des tiers.

amount
number <float>

Montant.

currency
string

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

object

Taxe de vente (objet ; États-Unis et Canada uniquement).

amount
number <float>

Montant.

currency
string

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

percent
number <float>

Taux de taxe de vente.

object

Informations sur la TVA (objet ; UE uniquement).

amount
number <float>

Montant.

currency
string

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

percent
number <float>

Taux de TVA.

object

Montant débité du solde Xsolla.

amount
number <float>

Montant.

currency
string

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

object

Frais Xsolla (objet).

amount
number <float>

Montant.

currency
string

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

custom_parameters
object

Vos paramètres personnalisés.

object

Informations sur l'achat (objet).

required
object

Prix total d'achat (objet).

amount
number <float>

Montant total du paiement.

currency
string

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

object

Informations au moment du paiement (objet).

amount
number <float>

Montant de l'achat.

currency
string

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

object

Informations sur le coupon (objet ; si un coupon a été utilisé lors de la création de l'abonnement).

campaign_code
string

Code de campagne.

coupon_code
string

Code de coupon.

object

Informations sur le cadeau (objet).

giver_id
string

ID du donneur.

hide_giver_from_receiver
string

Détermine l'affichage de l'identité du donneur au destinataire.

message
string

Message du donneur.

receiver_email
string

Adresse e-mail du destinataire du cadeau.

receiver_id
string

ID du destinataire du cadeau.

object

Informations sur la commande. Par défaut, ces informations ne sont pas passées dans le webhook. Pour activer cette fonction, contactez votre responsable de compte ou envoyez un e-mail à am@xsolla.com.

id
integer

ID de commande.

object

Informations sur l'objet.

object

Informations sur le prix de l'objet.

amount
number <float>

Prix total de l'objet dans la devise sélectionnée.

currency
string

Devise du prix de l'objet.

quantity
integer

Quantité de l'objet.

sku
string

UGS de l'objet.

object
Deprecated

Clés de jeu (tableau).

amount
number <float>
Deprecated

Prix.

currency
string
Deprecated

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

digital_content
string
Deprecated

UGS de jeu définie dans le Compte éditeur.

drm
string
Deprecated

Plateforme DRM utilisée pour distribuer le jeu. Assurez-vous d'avoir configuré les plateformes DRM requises dans votre Compte éditeur.

Enum: "steam" "playstation" "xbox" "uplay" "origin" "drmfree" "gog" "epicgames" "nintendo_eshop" "discord_game_store" "oculus"
object
Deprecated

Données de mise à niveau.

amount
number <float>
Deprecated

Prix en monnaie réelle.

currency
string
Deprecated

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

object
Deprecated

Données sur le package à partir duquel l'utilisateur a effectué la mise à niveau.

DRM
string
Deprecated

Plateforme de jeu DRM.

digital_content
string
Deprecated

UGS de jeu définie dans le Compte éditeur.

object
Deprecated

Données sur le package vers lequel l'utilisateur a effectué la mise à niveau.

DRM
string
Deprecated

Plateforme de jeu DRM.

digital_content
string
Deprecated

UGS de jeu définie dans le Compte éditeur.

Array of objects

Promotions appliquées à cette transaction.

Array
id
integer

ID de promotion.

technical_name
string

Nom technique de la promotion.

object

Informations de l'abonnement (objet).

amount
number <float>

Prix en monnaie réelle.

currency
string

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

date_create
string

Date de création de l'abonnement. Date et heure selon la norme ISO 8601.

date_next_charge
string

Prochaine date de facturation. Date et heure selon la norme ISO 8601.

plan_id
string

ID de plan (externe si le plan a été créé via API).

product_id
string

ID de produit (s'il est passé dans le jeton d'accès).

subscription_id
integer

ID d'abonnement dans la base de données Xsolla.

tags
Array of strings

Balises du plan.

object
Deprecated

Monnaie virtuelle à acheter (objet).

amount
number <float>
Deprecated

Prix en monnaie réelle.

currency
string
Deprecated

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

name
string
Deprecated

Nom de la monnaie virtuelle.

quantity
number <float>
Deprecated

Quantité.

sku
string
Deprecated

UGS du package de monnaie virtuelle (si définie pour le package de monnaie virtuelle).

object
Deprecated

Objets virtuels en cours d'achat (objet).

amount
number <float>
Deprecated

Montant de l'achat.

currency
string
Deprecated

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

Array of objects
Deprecated
Array
amount
number <float>
Deprecated

Quantité de l'objet.

sku
string
Deprecated

ID de l'objet.

object

Paramètres personnalisés de projet.

merchant_id
integer

ID de commerçant.

project_id
integer

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

object

Informations sur l'utilisateur (objet).

id
required
string

ID utilisateur.

country
string

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

email
string

Adresse e-mail de l'utilisateur.

ip
string

IP de l'utilisateur.

name
string

Nom d'utilisateur.

phone
string

Téléphone de l'utilisateur.

zip
string

ZIP ou code postal de l'utilisateur.

Responses
204

Renvoyez pour indiquer un traitement réussi.

400

Renvoyez en cas d'erreur dans les informations fournies (par exemple, un paramètre requis manquant, une autorisation échouée, etc.). Dans ce cas, l'utilisateur est débité, mais l'achat échoue. Pour procéder au remboursement, contactez le service client Xsolla à support@xsolla.com.

500

Renvoyez pour indiquer des erreurs temporaires liées à vos serveurs.

Request samples 
curl -v 'https://your.hostname/your/uri' \
-X POST \
-d '{
    "notification_type": "payment",
    "settings": {
      "project_id": 18404,
      "merchant_id": 2340
    },
    "purchase": {
        "virtual_currency": {
            "name": "Coins",
            "sku": "com.xsolla.package1",
            "quantity": 10,
            "currency": "USD",
            "amount": 100
        },
        "subscription": {
            "plan_id": "b5dac9c8",
            "subscription_id": "10",
            "product_id": "Demo Product",
            "date_create": "2014-09-22T19:25:25+04:00",
            "date_next_charge": "2014-10-22T19:25:25+04:00",
            "currency": "USD",
            "amount": 9.99
        },
        "checkout": {
            "currency": "USD",
            "amount": 50
        },
        "virtual_items": {
            "items": [
                {
                    "sku": "com.xsolla.item1",
                    "amount": 1
                }
            ],
            "currency": "USD",
            "amount": 50
        },
        "total": {
            "currency": "USD",
            "amount": 200
        },
        "promotions": [{
            "technical_name": "Demo Promotion",
            "id": "853"
        }],
        "coupon": {
            "coupon_code": "ICvj45S4FUOyy",
            "campaign_code": "1507"
        },
        "order": {
          "id": 1234
          "lineitems": [
          {
            "sku": "com.xsolla.item_1",
            "quantity": 1,
            "price": {
              "currency": "EUR",
              "amount": 6.5
              }
          }
          ]
          }
    },
    "user": {
        "ip": "127.0.0.1",
        "phone": "18777976552",
        "email": "email@example.com",
        "id": "1234567",
        "name": "Xsolla User",
        "country": "US"
    },
    "transaction": {
        "id": 1,
        "external_id": 1,
        "payment_date": "2014-09-24T20:38:16+04:00",
        "payment_method": 1,
        "payment_method_name": "PayPal",
        "payment_method_order_id": 1234567890123456789,
        "dry_run": 1,
        "agreement": 1
    },
    "payment_details": {
        "payment": {
            "currency": "USD",
            "amount": 230
        },
        "vat": {
            "currency": "USD",
            "amount": 0,
            "percent": 20
        },
        "sales_tax": {
            "currency": "USD",
            "amount": 0,
            "percent": 0
        },
        "direct_wht": {
            "currency": "USD",
            "amount": 0,
            "percent": 0
        },
        "payout_currency_rate": 1,
        "payout": {
            "currency": "USD",
            "amount": 200
        },
        "xsolla_fee": {
            "currency": "USD",
            "amount": 10
        },
        "payment_method_fee": {
            "currency": "USD",
            "amount": 20
        },
        "repatriation_commission": {
            "currency": "USD",
            "amount": 10
        }
    },
    "custom_parameters": {
        "parameter1": "value1",
        "parameter2": "value2"
    }
}'
Response samples
application/json
{
  • "error": {
    }
}
System statusAll services operational

Privacy Settings

Privacy PolicyEnd User License Agreement© 2006–2025 Xsolla Inc.