Xsolla-logo

Bestellung mit angegebenem kostenlosen Artikel anlegenClient-side

post/v2/project/{project_id}/free/item/{item_sku}

Legt eine Bestellung mit einem angegebenen kostenlosen Artikel an. Der angelegten Bestellung wird der Bestellstatus done zugewiesen.

SecurityXsollaLoginUserJWT
Request
path Parameters
project_id
required
integer

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

Example: 44056
item_sku
required
string

Item SKU.

Example: booster_mega_1
Request Body schema: application/json
currency
string

Währung des Bestellpreises. Dreistelliger Währungscode pro ISO 4217. Detaillierte Informationen zu Von Xsolla unterstützte Währungen.

custom_parameters
object [ 1 .. 200 ] properties

Projektspezifische Parameter.

locale
string

Antwortsprache.

promo_code
string

Löst den Code einer Promocode-Aktion gegen Bezahlung ein.

quantity
integer >= 1
Default: 1

Artikelmenge.

sandbox
boolean
Default: false

Legt eine Bestellung in der Testumgebung an. Die Option steht den Benutzern offen, die in der Liste der Firmennutzer aufgeführt sind.

object

Einstellungen zum Konfigurieren des Zahlungsvorgangs und des Zahlungsportals für einen Benutzer.

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.

Enum: "none" "successful" "successful_or_canceled" "any"
status_for_manual_redirection
string

Zahlungsstatus, der die Anzeige einer Schaltfläche auslöst, bei dessen Klick der Benutzer zur Rückgabe-URL weitergeleitet wird.

Enum: "none" "vc" "successful" "successful_or_canceled" "any"
return_url
string <uri> <= 1000 characters

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 wird das Logo im Header angezeigt. Um das Bild hochzuladen, öffnen Sie Ihr Projekt in Publisher-Konto und gehen Sie zu Pay Station > Abschnitt „Einstellungen“.

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.

Enum: "embed" "column_reverse" "embed_column_reverse"
object
object
close_button
boolean
Default: false

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.

Enum: "63295a9a2e47fab76f7708e1" "63295aab2e47fab76f7708e3"
object

Benutzerkontodetails.

object

Seite Mein Konto.

enable
required
boolean
Default: false

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

Kostenlose Bestellung wurde erfolgreich angelegt.

422

Ungültiger Artikel. Prüfen Sie, ob der Artikel existiert und weder deaktiviert noch gelöscht oder kostenlos ist.

Request samples
application/json
{
  • "custom_parameters": {
    },
  • "promo_code": "discount_code",
  • "quantity": 5,
  • "sandbox": true,
  • "settings": {
    }
}
Response samples
application/json
{
  • "order_id": 641
}