$wsPayPalCheckout - PayPal - WEBSALE Dokumentation

With the $wsPayPalCheckout module, you can use PayPal payment data dynamically in the frontend. It supports various payment methods such as PayPal Express Checkout, Google Pay, and Apple Pay. In this section, you learn how to query the payment status and use the payment data for the integration.

Module overview

Example / excerpt of $wsPayPalCheckout

{{= $wsPayPalCheckout | json }}

JSON output

{
  "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": "ƒ()"
}

Note: ƒ() denotes a function. Variables and methods overview

Variable	Return type	Description
`integrationDate`	string	Outputs the PayPal Checkout integration date.
`status`	string	Outputs the current payment status of the session.
`paymentCanceled`	bool	Indicates whether the payment was canceled.
`paymentFailed`	bool	Indicates whether the payment failed.
`paymentDeclined`	bool	Indicates whether the payment was declined.
`expressCheckout`	bool	Indicates whether PayPal Express Checkout is possible.
`expressCheckoutGooglePay`	bool	Indicates whether Google Pay Express is possible.
`expressCheckoutApplePay`	bool	Indicates whether Apple Pay Express is possible.
`googlePay`	map	Outputs Google Pay-specific data.
`applePay`	map	Outputs Apple Pay-specific data.
`loadData()`	map	Loads all payment data for PayPal Checkout.
`loadConfigData()`	map	Loads the configuration data of the PayPal Checkout, without checking the order context.

Templates

The $wsPayPalCheckout module is typically used in the checkout area, in particular on the payment page and the order confirmation. The PayPal buttons can also be embedded on product pages or in the basket for express checkout.

Variables

$wsPayPalCheckout.integrationDate

Outputs the integration date of the PayPal connection.

Integration date: {{= $wsPayPalCheckout.integrationDate }}

$wsPayPalCheckout.status

Outputs the status of the PayPal payment (empty if no payment process is active).

Status: {{= $wsPayPalCheckout.status }}

$wsPayPalCheckout.paymentCanceled

Outputs true if the customer has canceled the payment.

{{ if $wsPayPalCheckout.paymentCanceled }}
    // Payment was canceled
{{ /if }}

$wsPayPalCheckout.paymentFailed

Outputs true if a technical error occurred during the payment.

{{ if $wsPayPalCheckout.paymentFailed }}
    // Payment failed
{{ /if }}

$wsPayPalCheckout.paymentDeclined

Outputs true if the payment was declined by PayPal or the bank.

{{ if $wsPayPalCheckout.paymentDeclined }}
    // Payment was declined
{{ /if }}

$wsPayPalCheckout.expressCheckout

Indicates whether PayPal Express Checkout is possible.

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

$wsPayPalCheckout.expressCheckoutGooglePay

Indicates whether Google Pay Express is possible.

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

$wsPayPalCheckout.expressCheckoutApplePay

Indicates whether Apple Pay Express is possible.

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

$wsPayPalCheckout.googlePay

Outputs a map with Google Pay-specific content.

Google Pay data: {{= $wsPayPalCheckout.googlePay }}

$wsPayPalCheckout.applePay

Outputs a map with Apple Pay-specific data.

Apple Pay data: {{= $wsPayPalCheckout.applePay }}

Methods

$wsPayPalCheckout.loadData()

Loads all payment data for PayPal Checkout. Returns null if no active payment process exists. Signature
$wsPayPalCheckout.loadData(expressCheckout) Returns
Map - map with payment data or null. Parameters

Name	Type	Required	Description
`expressCheckout`	bool	no	`true` additionally loads express checkout data.

Example that loads the payment data.

{{ var $myPaypalDataVariable = $wsPayPalCheckout.loadData() }}
{{ if $myPaypalDataVariable }}
    // Payment data available
{{ /if }}

When using the $wsPayPalCheckout.loadData() function, various variables are available to retrieve and output payment data. Below is an overview of which variables are available.

Payment data (return value of `$wsPayPalCheckout.loadData()`)

First, it is necessary to assign the map with the payment data, as shown in the example above, to a local variable. This can then be used at various places in the template. JSON output of the variables

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

Variables overview General properties:

Variable	Type	Description
`sandbox`	bool	Indicates whether sandbox mode (test mode for payment methods) is active.
`merchantId`	string	PayPal Merchant ID.
`payerId`	string	PayPal Payer ID.
`clientId`	string	PayPal Client ID.
`paymentType`	string	Payment type (default: “`paypal`”).
`languageCode`	string	Language code.
`approvalUrl`	string	URL for the payment confirmation.
`cancelUrl`	string	URL when the payment is canceled.
`errorUrl`	string	URL in case of errors.
`expressApprovalUrl`	string	URL after a successful express payment.
`getClientToken`	function	Function that returns the client token for the PayPal SDK integration.
`orderId`	string	PayPal Order ID of the current transaction.

Properties of Google Pay and Apple Pay Google Pay:

Variable	Type	Description
`paymentData`	string	Response data from Google Pay (unprocessed).
`transactionInfo`	map	Map with transaction info from Google Pay.

Apple Pay:

Variable	Type	Description
`shippingOptions`	array	Shipping options.
`billingContact`	map	Billing address.
`payLineItems`	array	Apple Pay line items.
`brandName`	string	Brand name.
`paymentData`	string	Response data from Apple Pay (unprocessed).

$wsPayPalCheckout.loadConfigData()

Loads the configuration data of the PayPal Checkout SDK parameters such as client ID, language code, and mode. This method is the counterpart to loadData() for pages outside the order process, for example a page in the customer account where the customer links their account with the payment provider.

There are two differences to loadData():

The returned object contains less information because the order-related values approvalUrl, cancelUrl, errorUrl, expressApprovalUrl, and orderId are missing.
It is not checked whether a PayPal payment method is selected in the checkout or whether there are products in the basket. Therefore, loadConfigData() never returns null, whereas loadData() returns null outside of an active payment process.

Signature
$wsPayPalCheckout.loadConfigData(paymentId) Returns
Map - map with the configuration data. Never null. Parameters

Name	Type	Required	Description
`paymentId`	string	no	ID of the payment method whose settings should be read. Without specification, the values from the general PayPal Checkout configuration are read.

Example that loads the configuration data for the integration of the PayPal SDK.

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

When using the $wsPayPalCheckout.loadConfigData() function, various variables are available to retrieve and output the configuration data. Below is an overview of which variables are available.

Configuration data (return value of $wsPayPalCheckout.loadConfigData())

First, it is necessary to assign the map with the configuration data, as shown in the example above, to a local variable. This can then be used at various places in the template. JSON output

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

Variables overview

Variable	Type	Description
`sandbox`	bool	Indicates whether sandbox mode (test mode for payment methods) is active.
`merchantId`	string	PayPal Merchant ID of the merchant account (identical to `payerId`, corresponds to `payment.payPalCheckout.payerId`).
`payerId`	string	PayPal Merchant ID of the merchant account (identical to `merchantId`). Both names are provided because the PayPal SDK expects the value under one name or the other depending on the context.
`clientId`	string	PayPal Client ID. Depending on the mode, the live or the sandbox client ID is provided.
`paymentType`	string	Payment type (default: “`paypal`”).
`languageCode`	string	Language code.
`intent`	string	PayPal intent of the transaction for the SDK parameter `intent`. Currently always `"capture"`.
`getClientToken`	function	Function that returns the client token for the integration of the PayPal SDK (`null` if no token can be determined).

getClientToken() always determines the token for the payment method selected in the checkout, regardless of which paymentId was passed to loadConfigData().

Actions

There are no actions available for $wsPayPalCheckout.

Further links

$wsCheckout

Frontend

The basics

Getting started

Feature overview

Examples

Reference – Actions

Reference – Language

Reference – Modules

$wsPayPalCheckout - PayPal

Module overview

Templates

Variables

$wsPayPalCheckout.integrationDate

$wsPayPalCheckout.status

$wsPayPalCheckout.paymentCanceled

$wsPayPalCheckout.paymentFailed

$wsPayPalCheckout.paymentDeclined

$wsPayPalCheckout.expressCheckout

$wsPayPalCheckout.expressCheckoutGooglePay

$wsPayPalCheckout.expressCheckoutApplePay

$wsPayPalCheckout.googlePay

$wsPayPalCheckout.applePay

Methods

$wsPayPalCheckout.loadData()

Payment data (return value of `$wsPayPalCheckout.loadData()`)

$wsPayPalCheckout.loadConfigData()

Configuration data (return value of $wsPayPalCheckout.loadConfigData())

Actions

Further links

​Module overview

​Templates

​Variables

​$wsPayPalCheckout.integrationDate

​$wsPayPalCheckout.status

​$wsPayPalCheckout.paymentCanceled

​$wsPayPalCheckout.paymentFailed

​$wsPayPalCheckout.paymentDeclined

​$wsPayPalCheckout.expressCheckout

​$wsPayPalCheckout.expressCheckoutGooglePay

​$wsPayPalCheckout.expressCheckoutApplePay

​$wsPayPalCheckout.googlePay

​$wsPayPalCheckout.applePay

​Methods

​$wsPayPalCheckout.loadData()

​Payment data (return value of $wsPayPalCheckout.loadData())

​$wsPayPalCheckout.loadConfigData()

​Configuration data (return value of $wsPayPalCheckout.loadConfigData())

​Actions

​Further links

Module overview

Templates

Variables

$wsPayPalCheckout.integrationDate

$wsPayPalCheckout.status

$wsPayPalCheckout.paymentCanceled

$wsPayPalCheckout.paymentFailed

$wsPayPalCheckout.paymentDeclined

$wsPayPalCheckout.expressCheckout

$wsPayPalCheckout.expressCheckoutGooglePay

$wsPayPalCheckout.expressCheckoutApplePay

$wsPayPalCheckout.googlePay

$wsPayPalCheckout.applePay

Methods

$wsPayPalCheckout.loadData()

Payment data (return value of `$wsPayPalCheckout.loadData()`)

$wsPayPalCheckout.loadConfigData()

Configuration data (return value of $wsPayPalCheckout.loadConfigData())

Actions

Further links