Xsolla-logo
oder
Zum Kundenportal

Stornierung der Bestellung (mit Zahlungs- und Transaktionsdetails)Webhook POST

Xsolla sendet den Webhook order_canceled an die angegebene URL, wenn die Zahlung vom Nutzer, Partner oder automatisch storniert wurde. Der Webhook enthält Informationen über zurückgesandte Artikel, Zahlungsdaten und Details zur stornierten Bestellung.

Der Webhook wird nicht gesendet, wenn die Zahlung nicht erfolgreich war, zum Beispiel:

  • das Zahlungsportal geöffnet wurde, aber der Nutzer die Bestellung nicht bezahlt hat
  • das Zahlungsportal geöffnet wurde, aber während der Zahlung Fehler auftraten

Die empfohlene Verarbeitungszeit für Webhooks beträgt maximal drei Sekunden.

Request
Request Body schema: application/json
notification_type
required
string

Benachrichtigungstyp.

required
Array of Version = 1 (object) or Version = 2 (object)

Liste der vom Nutzer gekauften Artikel.

Die im Array enthaltenen Parameter hängen von der Webhook-Version ab. In Version 2 sind zusätzliche Parameter enthalten: is_free, is_bonus und is_bundle_content. Geben Sie die entsprechende Nummer im Parameter version im API-Aufruf Informationen zu Webhook-Einstellungen aktualisieren an, um die Version zu wechseln.

Array
One of:
sku
required
string

Eindeutige ID des Artikels. Bei Artikeln vom Typ game_key wird ein Wert im Format sku_drm verwendet.

type
required
string

Artikeltyp. Für Artikel vom Typ bundle, einschließlich virtueller Währungspakete, zeigt das Array items Folgendes an:

  • Parameter des Bundles oder des virtuellen Währungspakets
  • Im Bundle enthaltene Artikel oder im Paket enthaltene Währungen

Der Typ value_point wird bei Vorgängen mit Treuepunkten verwendet, d. h., wenn Punkte ausgegeben oder gutgeschrieben werden.

Enum: "virtual_good" "virtual_currency" "game_key" "bundle" "value_point"
quantity
required
integer

Menge der Gegenstände.

amount
required
string

Gesamtkosten der Artikel basierend auf ihrer Menge.

required
Array of objects

Angewandte Werbeaktionen für bestimmte Artikel in der Bestellung. Das Array wird in den folgenden Fällen zurückgegeben:

  • Eine Rabattaktion ist für einen bestimmten Artikel konfiguriert.
  • Ein Promocode mit der Einstellung Rabatt auf ausgewählte Artikel wird angewendet.

Werden keine Werbeaktionen auf Artikelebene angewandt, wird ein leeres Array zurückgegeben.

Array
amount_with_discount
string

Gesamtkosten der Gegenstände inklusive Rabatt.

amount_without_discount
string

Gesamtkosten der Gegenstände ohne Rabatt.

sequence
integer

Reihenfolge der angewandten Werbeaktionen.

is_pre_order
required
boolean

Ist true festgelegt, kann der Artikel vorbestellt werden.

custom_attributes
object

Ein JSON-Objekt mit Artikelattributen und ‑werten.

required
object

Bestellinformationen.

id
required
integer

Eindeutige Kennung der Bestellung des Benutzers aufseiten von Xsolla.

mode
required
string

Zahlungsmodus. default wird bei realen Zahlungen verwendet; sandbox bei Testzahlungen.

Enum: "default" "sandbox"
currency_type
required
string

Zahlungswährungstyp. Bei einer kostenlosen Bestellung ist unknown als Wert angegeben.

Enum: Description
loyalty_point

Treuepunkte

real

echte Währung

unknown

kostenlose Bestellung

virtual

virtuelle Währung

currency
required
string

Währung der Bestellung. Bei virtuellen Währungen wird die SKU und bei echten Währungen der aus drei Buchstaben bestehende Code gemäß ISO 4217 genutzt.

amount
required
string

Die Gesamtkosten eines Warenkorbs basierend auf der gewählten Währung.

status
required
string

Bestellstatus.

platform
required
string or null

Zahlungsplattform. Bei Zahlungen über Xsolla wird der Wert xsolla verwendet. Bei anderen Zahlungen entspricht der Wert dem Namen der Publishing-Plattform: playstation_network, xbox_live, pc_standalone, nintendo_shop, google_play, app_store_ios, android_standalone, ios_standalone, android_other, ios_other, pc_other.

Enum: "xsolla" "playstation_network" "xbox_live" "pc_standalone" "nintendo_shop" "google_play" "app_store_ios" "android_standalone" "ios_standalone" "android_other" "ios_other" "pc_other"
comment
required
string or null

Benutzeranmerkung der Bestellung.

invoice_id
required
string or null

Rechnungs-ID bei Zahlungen mit echter Währung. Bei Zahlungen mit virtueller Währung oder bei kostenlosen Artikeln wird der Wert null genutzt.

required
Array of objects

Angewandte Werbeaktionen für die gesamte Bestellung. Das Array wird in den folgenden Fällen zurückgegeben:

  • Eine Werbeaktion wirkt sich auf den Gesamtkaufbetrag aus, z. B. ein Aktionscode mit der Einstellung Rabatt auf Kauf.
  • Es wird kein Rabatt auf den Kauf angewandt, aber es werden Bonusartikel der Bestellung hinzugefügt. In diesem Fall werden die Werte für den Preis mit (amount_with_discount) und ohne Rabatt (amount_without_discount) zurückgegeben, wobei beide Werte identisch sind, da kein Rabatt angewandt wird.

Werden keine Werbeaktionen auf Bestellebene angewandt, wird ein leeres Array zurückgegeben.

Array
amount_with_discount
string

Gesamtkosten der Gegenstände inklusive Rabatt.

amount_without_discount
string

Gesamtkosten der Gegenstände ohne Rabatt.

sequence
integer

Reihenfolge der angewandten Werbeaktionen.

Array of objects

Angewandte Gutscheine. Wird der Gutschein nicht angewendet, wird kein Array zurückgegeben.

Array
code
string

Der Code eines angewandten Gutscheins.

external_id
string

Externe ID.

Array of objects

Angewandte Promocodes. Wird der Promocode nicht angewandt, wird kein Array zurückgegeben.

Array
code
string

Der Code eines angewandten Promocodes.

external_id
string

Externe ID.

required
object

Benutzerinformationen.

external_id
required
string

Benutzer-ID.

email
required
string

E-Mail-Adresse des Benutzers.

country
string

Land des Benutzers. Ländercode, bestehend aus 2 Großbuchstaben gemäß ISO 3166-1 ALPHA-2.

object

Transaktions- und Zahlungsdetails.

notification_type
required
string

Benachrichtigungstyp.

required
object

Details zur Transaktion (Objekt).

agreement
integer

ID der Vereinbarung.

dry_run
integer

Testtransaktion. Der Parameter hat den Wert 1, wenn es sich um eine Testtransaktion handelt. Er wird nicht gesendet, wenn es sich um eine echte Transaktion handelt.

external_id
string

Externe ID der Transaktion.

id
integer

ID der Transaktion.

payment_method_order_id
string

Zahlungs-ID im Zahlungssystem.

required
object

Zahlungsdaten (Objekt).

object

Quellensteuer, die in bestimmten Ländern aufgrund grenzüberschreitender Transaktionen anfällt (Objekt).

amount
number <float>

Betrag.

currency
string

Währung. Währungscode, bestehend aus drei Buchstaben gemäß ISO 4217.

percent
number <float>

Quellensteuersatz des Landes (in %).

object

Direkte Quellensteuer.

amount
number <float>

Betrag.

currency
string

Währung. Währungscode, bestehend aus drei Buchstaben gemäß ISO 4217.

percent
number <float>

Direkter Quellensteuersatz.

object

Vom Benutzer entrichteter Betrag (Objekt).

amount
number <float>

Betrag.

currency
string

Währung. Währungscode, bestehend aus drei Buchstaben gemäß ISO 4217.

object

Gebühren des Zahlungssystems.

amount
number <float>

Betrag.

currency
string

Währung. Währungscode, bestehend aus drei Buchstaben gemäß ISO 4217.

object

Betrag, der vom Zahlungssystem abgebucht wird.

amount
number <float>

Betrag.

currency
string

Währung. Währungscode, bestehend aus drei Buchstaben gemäß ISO 4217.

object

Details zur Auszahlung (Objekt).

amount
number <float>

Betrag.

currency
string

Währung. Währungscode, bestehend aus drei Buchstaben gemäß ISO 4217.

payout_currency_rate
string

Wechselkurs zwischen Zahlungs- und Auszahlungswährung.

object

Objekt mit Daten über die Rückübertragungskosten, die Xsolla von Dritten auferlegt wurden.

amount
number <float>

Betrag.

currency
string

Währung. Währungscode, bestehend aus drei Buchstaben gemäß ISO 4217.

object

Sales Tax (Objekt; nur in den USA und Kanada).

amount
number <float>

Betrag.

currency
string

Währung. Währungscode, bestehend aus drei Buchstaben gemäß ISO 4217.

percent
number <float>

Sales-Tax-Steuersatz.

object

Der Gesamtbetrag der Nutzerakquisitionsgebühren, der für die durch Affiliate-Netzwerke und Influencer vermittelten Käufe abgezogen wird (Objekt).

amount
number <float>

Betrag.

currency
string

Währung. Währungscode, bestehend aus drei Buchstaben gemäß ISO 4217.

percent
number <float>

Gebührensatz für die Nutzerakquise (in %).

object

Angaben zur MwSt. (Objekt, nur in der EU).

amount
number <float>

Betrag.

currency
string

Währung. Währungscode, bestehend aus drei Buchstaben gemäß ISO 4217.

percent
number <float>

Mehrwertsteuersatz.

object

Betrag, der vom Xsolla-Konto abgebucht wird.

amount
number <float>

Betrag.

currency
string

Währung. Währungscode, bestehend aus drei Buchstaben gemäß ISO 4217.

object

Xsolla-Gebühr (Objekt).

amount
number <float>

Betrag.

currency
string

Währung. Währungscode, bestehend aus drei Buchstaben gemäß ISO 4217.

object

Objekt, welches Angaben zum Kauf enthält.

required
object

Gesamtpreis des Einkaufs (Objekt).

amount
number <float>

Gesamtbetrag der Zahlung.

currency
string

Währung. Währungscode, bestehend aus drei Buchstaben gemäß ISO 4217.

object

Angaben zum Abonnement (Objekt).

amount
number <float>

Preis in echter Währung.

currency
string

Währung. Währungscode, bestehend aus drei Buchstaben gemäß ISO 4217.

date_create
string

Datum, an dem das Abonnement abgeschlossen wurde. Datums- und Zeitangabe gemäß ISO 8601.

plan_id
string

ID des Abo-Modells (extern, falls das Abo-Modell über die API angelegt wurde).

subscription_id
integer

In der Xsolla-Datenbank erfasste Abonnement-ID.

tags
Array of strings

Abo-Modell-Markierungen.

object

Benutzerdaten (Objekt).

author
string

Erstattungsinitiator. Der Feldwert wird gemäß der Tabelle übermittelt:

Erstattungsinitiator Feldwert
Spiel (über API). API
Kundenportal-Nutzer (automatische Erstattung). E-Mail-Adresse des Nutzers
Kundenportal-Nutzer (mit Unterstützung des Xsolla-Kundensupports). support@xsolla.com
Xsolla (mit Unterstützung des Xsolla-Kundensupports). support@xsolla.com
code
integer

Code-ID.

reason
string

Grund für die Rückerstattung.

object

Benutzerdefinierte Projekteinstellungen (Objekt).

merchant_id
integer

Händler-ID.

project_id
integer

Projekt-ID. Dieser Parameter wird im Kundenportal neben dem Projektnamen angezeigt.

custom_parameters
object

Zusätzliche Informationen.

Responses
200

Zur Signalisierung einer erfolgreiche Verarbeitung.

400

Im Falle eines Fehlers in den bereitgestellten Daten (z. B. fehlender erforderlicher Parameter, fehlgeschlagene Autorisierung usw.).

Request samples 
curl -v 'https://your.hostname/your/uri' \
-X POST \
-H 'accept: application/json' \
-H 'content-type: application/json' \
-H 'authorization: Signature d09695066c52c1b8bdae92f2d6eb59f5b5f89843' \
-d '{
    "notification_type": "order_canceled",
    "items": [
      {
        "sku": "com.xsolla.v.item_1",
        "type": "virtual_good",
        "is_pre_order": false,
        "quantity": 3,
        "amount": "1000",
        "promotions": [
          {
            "amount_without_discount": "6000",
            "amount_with_discount": "5000",
            "sequence": 1
          },
          {
            "amount_without_discount": "5000",
            "amount_with_discount": "4000",
            "sequence": 2
          }
        ],
        "custom_attributes": {
            "purchased": 0,
            "attr": "value"
          }
      },
      {
        "sku": "com.xsolla.v.item_new_1",
        "type": "bundle",
        "is_pre_order": false,
        "quantity": 1,
        "amount": "1000",
        "promotions": []
      },
      {
        "sku": "com.xsolla.gold_1",
        "type": "virtual_currency",
        "is_pre_order": false,
        "quantity": 1500,
        "amount": null,
        "promotions": []
      }
    ],
    "order": {
      "id": 1,
      "mode": "default",
      "currency_type": "virtual",
      "currency": "sku_currency",
      "amount": "2000",
      "status": "paid",
      "platform": "xsolla",
      "comment": null,
      "invoice_id": "1",
      "promotions": [
        {
          "amount_without_discount": "4000",
          "amount_with_discount": "2000",
          "sequence": 1
        }
      ],
      "promocodes": [
        {
          "code": "promocode_some_code",
          "external_id": "promocode_sku"
        }
      ],
      "coupons": [
        {
          "code": "WINTER2021",
          "external_id": "coupon_sku"
        }
      ]
    },
    "user": {
      "external_id": "id_xsolla_login_1",
      "email": "email@example.com",
      "country": "US"
    },
    "billing": {
      "notification_type": "refund",
      "settings": {
        "project_id": 18404,
        "merchant_id": 2340
      },
      "purchase": {
              "subscription": {
                  "plan_id": "b5dac9c8",
                  "subscription_id": "10",
                  "date_create": "2014-09-22T19:25:25+04:00",
                  "currency": "USD",
                  "amount": 9.99
              },
              "total":{
                  "currency": "USD",
                  "amount": 200
              }
          },
      "transaction": {
              "id": 1,
              "external_id": 1,
              "dry_run": 1,
              "agreement": 1
          },
      "refund_details": {
              "code": 4,
              "reason": "Potential fraud"
          },
      "payment_details": {
              "sales_tax": {
                  "currency": "USD",
                  "amount": 0
              },
              "direct_wht": {
                  "currency": "USD",
                  "amount": 0.70
              },
              "xsolla_fee": {
                  "currency": "USD",
                  "amount": "10"
              },
              "payout": {
                  "currency": "USD",
                  "amount": "200"
              },
              "payment_method_fee": {
                  "currency": "USD",
                  "amount": "20"
              },
              "payment": {
                  "currency": "USD",
                  "amount": "230"
              },
              "repatriation_commission": {
                  "currency": "USD",
                  "amount": 10
              }
          }
    }
}

Privacy Settings

Privacy PolicyEnd User License Agreement
System statusAll services operational
© 2006–2025 Xsolla Inc.