$wsPayPalCheckout - PayPal - WEBSALE Dokumentation

Mit dem $wsPayPalCheckout Modul können Sie PayPal-Zahlungsdaten dynamisch im Frontend verwenden. Es unterstützt verschiedene Zahlungsmethoden wie PayPal Express Checkout, Google Pay und Apple Pay. In diesem Abschnitt erfahren Sie, wie Sie den Zahlungsstatus abfragen und die Payment-Daten für die Integration nutzen können.

Modulübersicht

Beispiel / Ausschnitt über $wsPayPalCheckout

{{= $wsPayPalCheckout | json }}

JSON-Ausgabe

{
  "integrationDate": "...",
  "status": "...",
  "paymentCanceled": false,
  "paymentFailed": false,
  "paymentDeclined": false,
  "expressCheckout": false,
  "expressCheckoutGooglePay": false,
  "expressCheckoutApplePay": false,
  "googlePay": {
    "paymentData": "...",
    "transactionInfo": {
      "countryCode": "...",
      "currencyCode": "...",
      "displayItems": [...],
      "totalPrice": "...",
      "totalPriceLabel": "...",
      "totalPriceStatus": "..."
    }
  },
  "applePay": {
    "billingContact": { },
    "brandName": "...",
    "payLineItems": [...],
    "paymentData": "...",
    "shippingOptions": [...]
  },
  "loadData": "ƒ()",
  "loadConfigData": "ƒ()"
}

Anmerkung: ƒ() kennzeichnet eine Funktion. Variablen und Methoden in der Übersicht

Variable	Rückgabe-Typ	Beschreibung
`integrationDate`	string	Gibt das PayPal Checkout Integrationsdatum aus.
`status`	string	Gibt den aktuellen Payment-Status der Session aus.
`paymentCanceled`	bool	Gibt an, ob die Zahlung abgebrochen wurde.
`paymentFailed`	bool	Gibt an, ob die Zahlung fehlgeschlagen ist.
`paymentDeclined`	bool	Gibt an, ob die Zahlung abgelehnt wurde.
`expressCheckout`	bool	Gibt an, ob PayPal Express Checkout möglich ist.
`expressCheckoutGooglePay`	bool	Gibt an, ob Google Pay Express möglich ist.
`expressCheckoutApplePay`	bool	Gibt an, ob Apple Pay Express möglich ist.
`googlePay`	map	Gibt Google-Pay-spezifische Daten aus.
`applePay`	map	Gibt Apple-Pay-spezifische Daten aus.
`loadData()`	map	Lädt alle Payment-Daten für PayPal Checkout.
`loadConfigData()`	map	Lädt die Konfigurationsdaten des PayPal Checkout, ohne Prüfung des Bestellkontexts.

Templates

Das $wsPayPalCheckout Modul wird typischerweise im Checkout-Bereich verwendet, insbesondere auf der Zahlungsseite und der Bestellbestätigung. Die PayPal-Buttons können auch auf Produktseiten oder im Warenkorb für Express-Checkout eingebunden werden.

Variablen

$wsPayPalCheckout.integrationDate

Gibt das Integrationsdatum der PayPal-Anbindung aus.

Integrationsdatum: {{= $wsPayPalCheckout.integrationDate }}

$wsPayPalCheckout.status

Gibt den Status der PayPal-Zahlung aus(leer, wenn kein Zahlungsvorgang aktiv).

Status: {{= $wsPayPalCheckout.status }}

$wsPayPalCheckout.paymentCanceled

Gibt true aus, wenn der Kunde die Zahlung abgebrochen hat.

{{ if $wsPayPalCheckout.paymentCanceled }}
    // Zahlung wurde abgebrochen
{{ /if }}

$wsPayPalCheckout.paymentFailed

Gibt true aus, wenn ein technischer Fehler bei der Zahlung aufgetreten ist.

{{ if $wsPayPalCheckout.paymentFailed }}
    // Zahlung ist fehlgeschlagen
{{ /if }}

$wsPayPalCheckout.paymentDeclined

Gibt true aus, wenn die Zahlung von PayPal oder der Bank abgelehnt wurde.

{{ if $wsPayPalCheckout.paymentDeclined }}
    // Zahlung wurde abgelehnt
{{ /if }}

$wsPayPalCheckout.expressCheckout

Gibt an, ob PayPal Express Checkout möglich ist.

{{ if $wsPayPalCheckout.expressCheckout }}
    // PayPal Express Checkout anzeigen
{{ /if }}

$wsPayPalCheckout.expressCheckoutGooglePay

Gibt an, ob Google Pay Express möglich ist.

{{ if $wsPayPalCheckout.expressCheckoutGooglePay }}
    // Google Pay anzeigen
{{ /if }}

$wsPayPalCheckout.expressCheckoutApplePay

Gibt an, ob Apple Pay Express möglich ist.

{{ if $wsPayPalCheckout.expressCheckoutApplePay }}
    // Apple Pay anzeigen
{{ /if }}

$wsPayPalCheckout.googlePay

Gibt eine Map mit Google Pay spezifischen Inhalten aus.

Google-Pay-Daten: {{= $wsPayPalCheckout.googlePay }}

$wsPayPalCheckout.applePay

Gibt eine Map mit Apple Pay spezifischen Daten aus.

Apple-Pay-Daten: {{= $wsPayPalCheckout.applePay }}

Methoden

$wsPayPalCheckout.loadData()

Lädt alle Payment-Daten für PayPal Checkout. Gibt null zurück, wenn kein aktiver Zahlungsvorgang vorhanden ist. Signatur
$wsPayPalCheckout.loadData(expressCheckout) Rückgabe
Map - Map mit Payment-Daten oder null. Parameter

Name	Typ	Pflicht	Beschreibung
`expressCheckout`	bool	nein	`true` lädt zusätzlich Express-Checkout-Daten.

Beispiel, das die Payment-Daten lädt.

{{ var $myPaypalDataVariable = $wsPayPalCheckout.loadData() }}
{{ if $myPaypalDataVariable }}
    // Payment-Daten verfügbar
{{ /if }}

Mit Verwendung der Funktion $wsPayPalCheckout.loadData() stehen verschiedene Variablen zur Verfügung, um Payment-Daten abzurufen und auszugeben. Nachfolgend eine Übersicht, welche Variablen verfügbar sind.

Payment-Daten (Rückgabe von `$wsPayPalCheckout.loadData()` )

Zunächst ist es notwendig, die Map mit den Payment-Daten, wie im obigen Beispiel dargestellt, einer lokalen Variable zuzuweisen. Diese kann anschließend an verschiedenen Stellen im Template verwendet werden. JSON-Ausgabe der Variablen

{
  "sandbox": true/false,
  "merchantId": "...",
  "payerId": "...",
  "clientId": "...",
  "paymentType": "paypal",
  "languageCode": "...",
  "intent": "capture",
  "approvalUrl": "...",
  "cancelUrl": "...",
  "errorUrl": "...",
  "expressApprovalUrl": "...",
  "getClientToken": "ƒ()",
  "orderId": "...",
  "googlePay": { ... },
  "applePay": { ... }
}

Variablen in der Übersicht Allgemeine Eigenschaften:

Variable	Typ	Beschreibung
`sandbox`	bool	Gibt an, ob der Sandbox-Modus (Testmodus für Zahlungsarten) aktiv ist.
`merchantId`	string	PayPal Merchant-ID.
`payerId`	string	PayPal Payer-ID.
`clientId`	string	PayPal Client-ID.
`paymentType`	string	Zahlungstyp (Standard: “`paypal`”).
`languageCode`	string	Sprachcode.
`approvalUrl`	string	URL für die Payment-Bestätigung.
`cancelUrl`	string	URL bei Abbruch der Zahlung.
`errorUrl`	string	URL bei aufgetretenen Fehlern.
`expressApprovalUrl`	string	URL bei erfolgreicher Express-Zahlung.
`getClientToken`	function	Funktion, die den Client-Token für die PayPal-SDK-Integration zurückgibt.
`orderId`	string	PayPal Order-ID der aktuellen Transaktion.

Eigenschaften von Google Pay und Apple Pay Google Pay:

Variable	Typ	Beschreibung
`paymentData`	string	Antwortdaten von Google Pay (unverarbeitet).
`transactionInfo`	map	Map mit Transaktionsinfos von Google Pay.

Apple Pay:

Variable	Typ	Beschreibung
`shippingOptions`	array	Versandoptionen.
`billingContact`	map	Rechnungsadresse.
`payLineItems`	array	Apple Pay Positionen.
`brandName`	string	Markenname.
`paymentData`	string	Antwortdaten von Apple Pay (unverarbeitet).

$wsPayPalCheckout.loadConfigData()

Lädt die Konfigurationsdaten des PayPal Checkout SDK-Parameter wie Client-ID, Sprachcode und Modus. Diese Methode ist das Gegenstück zu loadData() für Seiten außerhalb des Bestellvorgangs, etwa eine Seite im Kundenkonto, auf der der Kunde sein Konto mit dem Zahlungsanbieter verknüpft.

Es gibt zwei Unterschiede zu loadData() :

Das zurückgegebene Objekt enthält weniger Informationen, weil die bestellbezogenen Werte approvalUrl , cancelUrl , errorUrl , expressApprovalUrl und orderId fehlen.
Es wird nicht geprüft, ob im Checkout eine PayPal-Zahlungsart gewählt ist oder ob sich Produkte im Warenkorb befinden. Deshalb liefert loadConfigData() nie null zurück, während loadData() außerhalb eines aktiven Zahlungsvorgangs null liefert.

Signatur
$wsPayPalCheckout.loadConfigData(paymentId) Rückgabe
Map - Map mit den Konfigurationsdaten. Nie null. Parameter

Name	Typ	Pflicht	Beschreibung
`paymentId`	string	nein	ID der Zahlungsart, deren Einstellungen gelesen werden sollen. Ohne Angabe werden die Werte aus der allgemeinen PayPal-Checkout-Konfiguration gelesen.

Beispiel, das die Konfigurationsdaten für die Einbindung des PayPal-SDK lädt.

{{ var $ppcConfig = $wsPayPalCheckout.loadConfigData() }}
<script src="https://www.paypal.com/sdk/js?client-id={{= $ppcConfig.clientId }}&merchant-id={{= $ppcConfig.merchantId }}&intent={{= $ppcConfig.intent }}"></script>

Mit Verwendung der Funktion $wsPayPalCheckout.loadConfigData() stehen verschiedene Variablen zur Verfügung, um die Konfigurationsdaten abzurufen und auszugeben. Nachfolgend eine Übersicht, welche Variablen verfügbar sind.

Konfigurationsdaten (Rückgabe von $wsPayPalCheckout.loadConfigData() )

Zunächst ist es notwendig, die Map mit den Konfigurationsdaten, wie im obigen Beispiel dargestellt, einer lokalen Variable zuzuweisen. Anschließend kann diese an verschiedenen Stellen im Template verwendet werden. JSON-Ausgabe

{
  "sandbox": true/false,
  "merchantId": "...",
  "payerId": "...",
  "clientId": "...",
  "paymentType": "paypal",
  "languageCode": "...",
  "intent": "capture",
  "getClientToken": "ƒ()"
}

Variablen in der Übersicht

Variable	Typ	Beschreibung
`sandbox`	bool	Gibt an, ob der Sandbox-Modus (Testmodus für Zahlungsarten) aktiv ist.
`merchantId`	string	PayPal Merchant-ID des Händlerkontos (identisch mit `payerId`, entspricht `payment.payPalCheckout.payerId`).
`payerId`	string	PayPal Merchant-ID des Händlerkontos (identisch mit `merchantId`). Beide Namen werden geliefert, weil das PayPal-SDK den Wert je nach Kontext unter dem einen oder dem anderen Namen erwartet.
`clientId`	string	PayPal Client-ID. Je nach Modus wird die Live- oder die Sandbox-Client-ID geliefert.
`paymentType`	string	Zahlungstyp (Default: “`paypal`”).
`languageCode`	string	Sprachcode.
`intent`	string	PayPal-Intent der Transaktion für den SDK-Parameter `intent`. Derzeit immer `"capture"`.
`getClientToken`	function	Funktion, die das Client-Token für die Einbindung des PayPal-SDK zurückgibt (`null`, wenn kein Token ermittelt werden kann).

getClientToken() ermittelt das Token immer für die im Checkout gewählte Zahlungsart, unabhängig davon, welche paymentId an loadConfigData() übergeben wurde.

Aktionen

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

Weiterführende Links

$wsCheckout

Frontend

Die Basics

Getting Started

Referenz – Aktionen

Referenz – Sprache

Referenz – Module

Integrationsanleitung

Praxisbeispiele

$wsPayPalCheckout - PayPal

Modulübersicht

Templates

Variablen

$wsPayPalCheckout.integrationDate

$wsPayPalCheckout.status

$wsPayPalCheckout.paymentCanceled

$wsPayPalCheckout.paymentFailed

$wsPayPalCheckout.paymentDeclined

$wsPayPalCheckout.expressCheckout

$wsPayPalCheckout.expressCheckoutGooglePay

$wsPayPalCheckout.expressCheckoutApplePay

$wsPayPalCheckout.googlePay

$wsPayPalCheckout.applePay

Methoden

$wsPayPalCheckout.loadData()

Payment-Daten (Rückgabe von `$wsPayPalCheckout.loadData()` )

$wsPayPalCheckout.loadConfigData()

Konfigurationsdaten (Rückgabe von $wsPayPalCheckout.loadConfigData() )

Aktionen

Weiterführende Links

​Modulübersicht

​Templates

​Variablen

​$wsPayPalCheckout.integrationDate

​$wsPayPalCheckout.status

​$wsPayPalCheckout.paymentCanceled

​$wsPayPalCheckout.paymentFailed

​$wsPayPalCheckout.paymentDeclined

​$wsPayPalCheckout.expressCheckout

​$wsPayPalCheckout.expressCheckoutGooglePay

​$wsPayPalCheckout.expressCheckoutApplePay

​$wsPayPalCheckout.googlePay

​$wsPayPalCheckout.applePay

​Methoden

​$wsPayPalCheckout.loadData()

​Payment-Daten (Rückgabe von $wsPayPalCheckout.loadData() )

​$wsPayPalCheckout.loadConfigData()

​Konfigurationsdaten (Rückgabe von $wsPayPalCheckout.loadConfigData() )

​Aktionen

​Weiterführende Links

Modulübersicht

Templates

Variablen

$wsPayPalCheckout.integrationDate

$wsPayPalCheckout.status

$wsPayPalCheckout.paymentCanceled

$wsPayPalCheckout.paymentFailed

$wsPayPalCheckout.paymentDeclined

$wsPayPalCheckout.expressCheckout

$wsPayPalCheckout.expressCheckoutGooglePay

$wsPayPalCheckout.expressCheckoutApplePay

$wsPayPalCheckout.googlePay

$wsPayPalCheckout.applePay

Methoden

$wsPayPalCheckout.loadData()

Payment-Daten (Rückgabe von `$wsPayPalCheckout.loadData()` )

$wsPayPalCheckout.loadConfigData()

Konfigurationsdaten (Rückgabe von $wsPayPalCheckout.loadConfigData() )

Aktionen

Weiterführende Links