Skip to main content

Documentation Index

Fetch the complete documentation index at: https://dokumentation.websale.de/llms.txt

Use this file to discover all available pages before exploring further.

Mit dem $wsStripe Modul können Sie Zahlungsinformationen zu Stripe abrufen. Es stellt die Konfigurationsdaten für die Stripe.js-Integration sowie Statusinformationen zum aktuellen Zahlungsvorgang bereit. In diesem Abschnitt erfahren Sie, wie Sie Stripe im Frontend initialisieren und den Zahlungsstatus auswerten können.

​
Modulübersicht

Beispiel / Ausschnitt über $wsStripe 
{{= $wsStripe | json }}
JSON-Ausgabe 
{
  "configuration": {
    "publishableKey": "...",
    "targetAccount": "..."
  },
  "createCustomerSession": "ƒ()",
  "paymentCanceled": false,
  "paymentFailed": false,
  "paymentPending": false
}
Anmerkung: "ƒ()" kennzeichnet eine Funktion. Variablen und Methoden in der Übersicht
NameTypBeschreibung
configurationmapMap mit Stripe-Konfigurationsdaten.
publishableKeystringÖffentlicher Stripe-Schlüssel für die Integration im Frontend.
targetAccountstringStripe Connected Account ID (für Plattform-Zahlungen).
paymentCanceledbooltrue wenn die Zahlung abgebrochen wurde.
paymentFailedbooltrue wenn die Zahlung fehlgeschlagen ist.
paymentPendingbooltrue wenn die Zahlung noch aussteht.
createCustomerSession()mapErstellt eine Stripe Customer Session für den aktuell eingeloggten Kunden.

​
Templates

Das $wsStripe Modul wird typischerweise im Checkout-Bereich verwendet,
insbesondere auf der Zahlungsseite. Die Konfigurationsdaten werden zur
Initialisierung des Stripe.js-Objekts im Frontend benötigt.

​
Variablen

​
$wsStripe.configuration

Gibt die Stripe-Konfigurationsdaten aus. Wird zur Initialisierung des Stripe-Objekts im Frontend verwendet. 
{{ var $myStripeConfig = $wsStripe.configuration }}

​
$wsStripe.configuration.publishalbeKey

Gibt den öffentlichen Stripe-Schlüssel aus. Dieser Schlüssel wird zur Initialisierung von Stripe.js im Browser benötigt und ist sicher für die Verwendung im Frontend. 
Publishable Key: {{= $wsStripe.configuration.publishableKey }}

​
$wsStripe.configuration.targetAccount

Gibt die Stripe Connected Account ID aus. Wird nur bei Plattform- oder Marktplatz-Zahlungen benötigt, wenn Zahlungen an einen verbundenen Account weitergeleitet werden. 
Target Account: {{= $wsStripe.configuration.targetAccount }}

​
$wsStripe.paymentCanceled

Gibt true aus, wenn die Zahlung abgebrochen wurde. 
{{ if $wsStripe.paymentCanceled }}
  // Die Zahlung wurde abgebrochen
{{ /if }}

​
$wsStripe.paymentFailed

Gibt true aus, wenn die Zahlung fehlgeschlagen ist. 
{{ if $wsStripe.paymentFailed }}
  // Die Zahlung ist fehlgeschlagen
{{ /if }}

​
$wsStripe.paymentPending

Gibt true aus, wenn die Zahlung noch aussteht. 
{{ if $wsStripe.paymentPending }}
  // Die Zahlung wird verarbeitet
{{ /if }}

​
Methoden

​
$wsStripe.createCustomerSession()

Erstellt eine Stripe Customer Session für den aktuell eingeloggten Kunden. Die Session ermöglicht sicheren Zugriff auf gespeicherte Zahlungsmethoden und Kundendaten direkt im Frontend. Signatur
$wsStripe.createCustomerSession() Rückgabe
map - Customer Session Objekt mit folgenden Attributen:
AttributTypBeschreibung
client_secretstringGeheimer Schlüssel für den sicheren Zugriff auf den Kunden.
componentsobjectKonfiguration für aktivierte Stripe-Komponente.
customerstringID des Kunden, für den die Session erstellt wurde.
expires_attimestampZeitpunkt, zu dem die Session abläuft.
Beispiel, das eine Customer Session erstellt. 
{{ var $myCustomerSession = $wsStripe.createCustomerSession() }}
const customerSessionClientSecret = "{{= $myCustomerSession.client_secret }}

​
Aktionen

Für $wsStripe stehen keine Aktionen zur Verfügung.

​
Beispiele

​
Zahlungsstatus prüfen

{{ if $wsStripe.paymentCanceled }}
  <div class="alert">Die Zahlung wurde abgebrochen.</div>
{{ /if }}

{{ if $wsStripe.paymentFailed }}
  <div class="alert error">Die Zahlung ist fehlgeschlagen.</div>
{{ /if }}

{{ if $wsStripe.paymentPending }}
  <div class="alert info">Die Zahlung wird verarbeitet.</div>
{{ /if }}