Generiert eine Bestellung und den zugehörigen Zahlungstoken. Die Bestellung wird auf Grundlage der im Anfragerumpf übermittelten Artikel generiert.
Hinweis
Der Parameter user.country.value dient dazu, eine Währung für die Bestellung auszuwählen. Ist das Land des Nutzers unbekannt,
ist auch die Angabe der IP-Adresse des Nutzers im Header X-User-Ip möglich. Eine dieser beiden Optionen ist für die korrekte Funktionsweise dieser Methode erforderlich. Die ausgewählte Währung wird für die Zahlungsmethoden in der Pay Station genutzt.
SecuritybasicAuth
Request
path Parameters
project_id
required
integer
Projekt-ID. Dieser Parameter wird im Kundenportal neben dem Projektnamen angezeigt.
Example: 44056
Request Body schema: application/json
required
object
required
object
value
string [ 1 .. 255 ] characters
Benutzer-ID. Zum Testen können Sie einen beliebigen Wert übermitteln. Um echte Zahlungen entgegenzunehmen, müssen Sie die Benutzer-ID aus Ihrem System angeben. Diese ID ist im Webhook Benutzervalidierung zu übermitteln.
age
integer
Alter des Benutzers.
attributes
object [ 1 .. 100 ] items
Benutzerattribute zum Filtern der Liste der Gegenstände; repräsentiert durch eine gültige Reihe von JSON-Objekten bestehend aus Schlüssel-Wert-Paaren.
object
allow_modify
boolean
Default: false
Legt fest, ob der Benutzer das Land im Zahlungsportal ändern kann oder nicht.
value
string
Ländercode bestehend aus zwei Großbuchstaben gemäß ISO 3166-1 ALPHA-2. Der Parameter ist erforderlich, sofern keine IP-Adresse im X-User-Ip-Header übermittelt wird.
object
value
string <email> [ 3 .. 255 ] characters
E-Mail-Adresse des Benutzers. Muss gemäß dem Protokoll RFC 822 gültig sein.
is_legal
boolean
Legt fest, ob der Benutzer eine juristische Person ist.
object
Objekt mit Angaben zur juristischen Person. Objekt und alle seine Parameter sind erforderlich, falls für user.is_legaltrue festgelegt ist.
address
string
Vollständige Unternehmensanschrift.
country
string
Land des Unternehmenssitzes. Ländercode, bestehend aus 2 Großbuchstaben gemäß ISO 3166-1 ALPHA-2.
name
string
Vollständiger Name des Unternehmens.
vat_id
string
Steuerliche Identifikationsnummer.
object
value
string [ 1 .. 255 ] characters
Benutzername.
object
value
required
string
Telefonnummer des Benutzers.
allow_modify
boolean
Default: false
Legt fest, ob ein Benutzer das Telefon im Zahlungsportal ändern darf. Wenn phone.value im Token übermittelt wird, ist der Wert standardmäßig auf false gestellt.
hidden
boolean
Default: true
object
value
required
string = 17 characters ^\d{17}$
Steam-ID.
object
value
required
string = 32 characters ^[A-Za-z0-9]{32}$
Eindeutige Tracking-ID (wird in Marketingkampagnen verwendet).
object
Datenverkehrsattribute.
utm_campaign
string
Kampagnenbezeichnung, ins Englische transliteriert oder übersetzt.
Kampagnen-Keyword. Falls festgelegt, basieren die Statistiken auf den Keywords, die für die Zielgruppenwerbung verwendet werden, anstatt auf spezifischen Suchanfragen. In Google Analytics ist der angegebene utm_term Teil des allgemeinen Berichts zu Suchbegriffen.
required
object
required
Array of objects non-empty
Array (non-empty)
sku
required
string non-empty
Eindeutige Artikel-ID. Die SKU darf nur lateinische alphanumerische Kleinbuchstaben, Punkte, Bindestriche und Unterstriche enthalten.
quantity
required
number >= 1
Artikelmenge.
object or null [ 1 .. 200 ] properties
Ihre benutzerdefinierten Parameter werden in Form eines gültigen JSON-Satz von Schlüssel-Wert-Paaren dargestellt.
Sie können über dieses Feld zusätzliche Parameter übermitteln und so Betrugsschutzfilter konfigurieren. Siehe Bezahlstation-Dokumentation.
additional property
string or integer or number or boolean
One of:
string
sandbox
boolean
Default: false
Stellen Sie den Wert auf true, um den Bezahlvorgang zu testen. Verwenden Sie in diesem Fall https://sandbox-secure.xsolla.com, um auf die Benutzeroberfläche für Testzahlungen zuzugreifen.
object
Einstellungen zum Konfigurieren des Zahlungsvorgangs und des Zahlungsportals für einen Benutzer.
currency
string
Bevorzugte Zahlungswährung. Währungscode bestehend aus drei Buchstaben gemäß ISO 4217.
external_id
string [ 1 .. 255 ] characters
Externe ID der Transaktion.
language
string
Sprache der Benutzeroberfläche. Sprachencode, bestehend aus 2 Kleinbuchstaben.
payment_method
integer >= 1
ID der Zahlungsmethode.
object
delay
integer
Verzögerung, nach der der Benutzer automatisch zur Rückgabe-URL weitergeleitet wird.
redirect_button_caption
string
Lokalisierte Beschriftungen der Weiterleiten-Schaltfläche.
redirect_conditions
string
Zahlungsstatus, der eine Benutzerweiterleitung zur Rückgabe-URL auslöst.
Seite, auf die der Benutzer nach der Zahlung weitergeleitet wird. Die folgenden Parameter werden dem Link automatisch hinzugefügt: user_id, foreigninvoice, invoice_id, status.
object
Benutzeroberflächeneinstellungen.
currency_format
string
Damit ein Währungscode bestehend aus drei Buchstaben gemäß ISO 4217 im Zahlungsportal angezeigt wird, müssen Sie code als Wert festlegen. Standardmäßig wird das Währungssymbol anstelle des Währungscodes angezeigt.
object
Benutzeroberflächeneinstellungen für die Desktopversion.
object
Header-Einstellungen.
close_button
boolean
Default: false
Ob in der Desktop-Version des Zahlungsportals eine Schließen-Schaltfläche angezeigt werden soll. Die Schaltfläche schließt das Zahlungsportal und leitet den Nutzer zu der im Parameter settings.return_url angegebenen URL weiter. Standardmäßig ist false voreingestellt.
is_visible
boolean
Ob der Header im Zahlungsportal angezeigt wird.
type
string
Default: "normal"
Wie der Header angezeigt wird. Möglich sind compact (Projektname und Benutzer-ID sind ausgeblendet) oder normal (Standard).
Enum:"compact""normal"
visible_logo
boolean
Wenn true festgelegt ist, wird im Header Ihr Logo angezeigt (dafür müssen Sie das Bild zuerst Ihrem Account Manager übermitteln).
visible_name
boolean
Ob der Projektname im Header angezeigt wird.
visible_purchase
boolean
Default: true
Ob die Kaufbeschreibung (purchase.description.value) im Header angezeigt wird. true ist voreingestellt.
object
visible_virtual_currency_balance
boolean
Default: true
Ob dieses Element im Zahlungsportal ausgeblendet werden kann oder nicht.
is_cart_open_by_default
boolean
Default: false
Wie die Artikelliste im Warenkorb beim Öffnen der mobilen Zahlungsportal-Version angezeigt wird. Wenn true festgelegt ist, wird die Liste ausgeklappt angezeigt. Wenn false (Standard) festgelegt ist oder der Parameter nicht übermittelt wird, wird die Liste zusammengeklappt angezeigt.
is_independent_windows
boolean
Default: false
Ob Nutzer zum Bezahlen vom im Launcher eingebetteten Browser (WebView) zu ihrem Standardbrowser weitergeleitet werden sollen.
is_payment_methods_list_mode
boolean
Default: false
Ob die Liste der im Land des Benutzers verfügbaren Zahlungsmethoden beim Öffnen des Zahlungsportals angezeigt wird. Ist false festgelegt (Standard), wird die im Parameter settings.payment_method übermittelte Zahlungsmethode oder die vom PayRank-Algorithmus ausgewählte Zahlungsmethode angezeigt.
is_prevent_external_link_open
boolean
Default: false
Ob die Weiterleitung per Link zu einer externen Ressource deaktiviert ist oder nicht. Wenn Sie auf einen externen Link klicken, wird das Ereignis external-link-open über den postMessage-Mechanismus gesendet. Die Adresse für den Weiterleitungs-Link wird im Parameter url übermittelt.
is_show_close_widget_warning
boolean
Default: true
Ob während der Transaktionsverarbeitung eine Warnmeldung angezeigt werden soll, wenn der Mauszeiger über das Schließen-Symbol (×) bewegt wird. Wird false oder kein Parameter übermittelt, wird die Warnmeldung nicht angezeigt.
is_three_ds_independent_windows
boolean
Default: false
Ob die "3-D Secure"-Prüfung in einem neuen Browserfenster geöffnet werden soll. Übermitteln Sie true, wenn Sie die Content Security Policy (CSP) verwenden.
layout
string
Position der Hauptelemente des Zahlungsportals. Sie können das Zahlungsportal im Spiel öffnen und/oder die Spalte mit den Bestellinformationen und den Angaben zu den Zahlungsmethoden vertauschen. Ausführliche Informationen finden Sie in den Anpassungsanweisungen.
Ob in der mobilgeräteoptimierten Version des Zahlungsportals eine Schließen-Schaltfläche angezeigt werden soll. Die Schaltfläche schließt das Zahlungsportal und leitet den Nutzer zu der im Parameter settings.return_url angegebenen URL weiter.
mode
string
Benutzeroberflächen-Modus im Zahlungsportal. Nur user_account ist möglich. Der Header enthält nur das Navigationsmenü, und der Nutzer kann kein Produkt auswählen oder eine Zahlung vornehmen. Dieser Modus ist nur für die Desktop-Version verfügbar.
Value:"user_account"
theme
string
Default: "63295a9a2e47fab76f7708e1"
Zahlungsportal-Theme. Möglich sind "63295a9a2e47fab76f7708e1" (helles Theme – voreingestellt) oder "63295aab2e47fab76f7708e3" (dunkles Theme). Sie können außerdem ein individuelles Theme erstellen und dessen ID im Parameter übermitteln.
Ob das Untermenü angezeigt wird. false ist voreingestellt.
order
required
integer >= 1
Position des Untermenüs im Hauptmenü.
object
Untermenü Meine Zahlungskonten.
enable
required
boolean
Default: false
Ob das Untermenü angezeigt wird. false ist voreingestellt.
object
Untermenü Abonnements verwalten.
enable
required
boolean
Default: false
Ob das Untermenü angezeigt wird. false ist voreingestellt.
order
required
integer >= 1
Position des Untermenüs im Hauptmenü.
Responses
200
Zahlungstoken und Bestellung erfolgreich erstellt.
401
Basisauthentifizierung nicht bestanden oder falsch. Prüfen Sie die Anmeldedaten und vergewissern Sie sich, dass Sie die Basisauthentifizierung verwenden.
422
Fehler beim Prüfen des Anfragerumpfs und beim Zusammenstellen des Warenkorbs.
Ungültiger Warenkorb, zusammengestellt aus übermittelten Artikeln. Prüft, dass der Warenkorb nicht leer und kein darin enthaltener Artikel kostenlos ist.
