Xsolla-logo

ZahlungWebhook POST

Wenn ein Benutzer eine Zahlung abschließt, sendet Xsolla die Zahlungsdetails in einem Webhook vom Typ payment an die Webhook-URL.

Wurde eine Antwort mit dem Code 5xx Code empfangen, sendet Xsolla weitere Webhooks in längeren Zeitabständen, bis Ihr Listener den Empfang bestätigt. Maximal sind 12 Versuche möglich.

Sie können die Berechtigung erteilen, detaillierte Informationen in Webhooks zu erhalten. Dazu müssen Sie im Kundenportal unter Projekteinstellungen > Webhooks > Erweiterte Einstellungen die folgenden Schalter auf Ein stellen.

Schalter Beschreibung
Infos über das gespeicherte Zahlungskonto anzeigen Informationen über die gespeicherte Zahlungsmethode werden in dem benutzerdefinierten Objekt payment_account übermittelt.
Infos über Transaktionen anzeigen, die mit gespeicherten Zahlungsmethoden getätigt wurden

Informationen werden in den folgenden benutzerdefinierten Parametern des Webhooks übermittelt.

  • saved_payment_method:
    • 0 – die gespeicherte Zahlungsmethode wurde nicht verwendet
    • 1 – die Zahlungsmethode wurde während des aktuellen Bezahlvorgangs gespeichert
    • 2 – die zuvor gespeicherte Zahlungsmethode wird verwendet
  • payment_type:
    • 1 – Einmalzahlung
    • 2 – wiederkehrende Zahlung
Bestellobjekt dem Webhook hinzufügen Die Informationen über die Bestellung werden im order-Objekt des Zahlung-Webhooks übermittelt.
Nur notwendige Nutzerparameter ohne vertrauliche Daten senden

Im Webhook werden nur die folgenden Nutzerinformationen übermittelt:

  • ID
  • Land
BLZ und Endziffern von Karten anzeigen

Im Webhook werden nur die folgenden Informationen über die Bankkartennummer übermittelt:

  • die ersten sechs Ziffern im Parameter card_bin
  • die letzten vier Ziffern im Parameter card_suffix
Kartenmarke anzeigen Die Marke der Karte, mit der die Zahlung getätigt wurde. Zum Beispiel: Mastercard oder Visa.
Request
Request Body schema: application/json
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 Transaktions-ID. Ausführliche Informationen finden Sie in den FAQs.

id
integer

ID der Transaktion.

payment_date
string

Zahlungsdatum.

payment_method
integer

ID der Zahlungsart.

payment_method_name
string

Name der Zahlungsmethode.

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.

custom_parameters
object

Ihre benutzerdefinierten Parameter.

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

Objekt, welches Angaben zur Bezahlung enthält.

amount
number <float>

Kaufbetrag.

currency
string

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

object

Angaben zum Gutschein (Objekt; falls ein Gutschein bei Abschluss des Abonnements genutzt wurde).

campaign_code
string

Kampagne.

coupon_code
string

Gutscheincode.

object

Benutzerdaten (Objekt).

giver_id
string

Spender-ID.

hide_giver_from_receiver
string

Legt fest, ob die Identität des Spenders vor dem Beschenkten geheim gehalten werden soll.

message
string

Nachricht vom Spender.

receiver_email
string

E-Mail des Geschenkempfängers.

receiver_id
string

ID des Geschenkempfängers.

object

Objekt mit Informationen über eine Bestellung. Wenn Sie diese Informationen erhalten möchten, stellen Sie den Schalter Bestellobjekt dem Webhook hinzufügen im Kundenportal unter Projekteinstellungen > Webhooks > Erweiterte Einstellungen auf Ein.

id
integer

Bestell-ID.

object

Objekt mit Informationen über einen Artikel.

object

Objekt mit Informationen über einen Artikelpreis.

amount
number <float>

Gesamtpreis des Artikels in der ausgewählten Währung.

currency
string

Währung des Artikelpreises.

quantity
integer

Artikelmenge.

sku
string

Artikel-SKU.

Array of objects

Werbeaktionen, die bei dieser Transaktion Verwendung finden.

Array
id
integer

ID der Werbeaktion.

technical_name
string

Arbeitstitel der Werbeaktion.

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.

date_next_charge
string

Nächstes Rechnungsdatum. Datums- und Zeitangabe gemäß ISO 8601.

plan_id
string

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

product_id
string

Produkt-ID (falls sie im Zugriffstoken versendet wurde).

subscription_id
integer

In der Xsolla-Datenbank erfasste Abonnement-ID.

tags
Array of strings

Abo-Modell-Markierungen.

object

Benutzerdefinierte Projekteinstellungen (Objekt).

merchant_id
integer

Händler-ID.

project_id
integer

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

object

Benutzerdaten (Objekt).

id
required
string

Benutzer-ID.

country
string

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

email
string

E-Mail des Benutzers.

ip
string

Benutzer-IP.

name
string

Benutzername.

phone
string

Telefonnummer des Benutzers.

zip
string

Postleitzahl des Benutzers.

Responses
204

Zur Signalisierung einer erfolgreiche Verarbeitung.

400

Rückgabe im Falle eines Fehlers in den bereitgestellten Informationen (z. B. fehlender erforderlicher Parameter, fehlgeschlagene Autorisierung usw.). In diesem Fall wird zwar das Geld des Nutzers abgebucht, der Kauf schlägt jedoch fehl. Um eine Rückerstattung vorzunehmen, wenden Sie sich an den Xsolla-Kundendienst unter support@xsolla.com.

500

Im Falle von temporären Fehlern mit Ihren Servern.

Request samples 
curl -v 'https://your.hostname/your/uri' \
-X POST \
-d '{
    "notification_type": "payment",
    "settings": {
      "project_id": 18404,
      "merchant_id": 2340
    },
    "purchase": {
        "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
        },
        "total": {
            "currency": "USD",
            "amount": 200
        },
        "promotions": [{
            "technical_name": "Demo Promotion",
            "id": 853
        }],
        "coupon": {
            "coupon_code": "ICvj45S4FUOyy",
            "campaign_code": "1507"
        },
        "order": {
          "id": 1234
          "lineitems": [
          {
            "sku": "test_1",
            "quantity": 1,
            "price": {
              "currency": "EUR",
              "amount": 6.5
              }
          }
          ]
          }
    },
    "user": {
        "ip": "127.0.0.1",
        "phone": "18777976552",
        "email": "email@example.com",
        "id": "1234567",
        "name": "John Smith",
        "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
        },
        "country_wht": {
            "currency": "USD",
            "amount": 2,
            "percent": 10
        },
        "user_acquisition_fee": {
            "currency": "USD",
            "amount": 2,
            "percent": 1
        },
        "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–2024 Xsolla Inc.