Checkout from the Product/Basket Page

Overview

Payengine enables merchants to integrate a PayPal widget button for express checkout directly from the product/basket page.

This service empowers customers to complete a purchase without filling in additional data, such as name, email, billing, and shipping address.

All the necessary data is extracted from the customer PayPal account.

Prerequisites

For customers:

• Valid PayPal account

For merchants:

• The feature must be activated by the Payengine support team
• After activation, Integrated Sign-up must be enabled in the Merchant Center from: Settings> Payment Methods > PayPal > Actions> Integrated Sign-up > Sign Up

Customer experience

On clicking the PayPal Checkout button, a PayPal popup window appears.

After the input of the details on the PayPal page, the customer is returned to the merchant Review & Submit Order page with information fields pre-populated for final confirmation of the purchase.

• From the basket page, click the PayPal Checkout button.

• Log in with your PayPal credentials.

• Choose a payment instrument and click Continue.

• Choose a shipping address and click Continue.

• Review and place the order.

• The order is confirmed.

PayEngine Details

General

Supported Features and Services

Types of Integration

Technical Flow

Below diagram shows the technical flow via button widget integration.

Specifications

Integrate the PayPal Checkout Button within the Product/Basket Page

The merchant needs to integrate the PayPal Checkout Button within the Product/Basket page to enable faster checkout with PayPal.

Sample JavaScript code to integrate the PayPal Checkout Button

<script src = "https://pp.payengine.de/widgetjs/payengine.widget.min.js"> </script>

----------------------------------------------

Special Parameters to Initialize the PayPal Checkout Button

Prerequisites for Create Order Intent

Create Order Intent

By clicking on the Checkout Button, the button widget automatically sends an order request to the following endpoint: POST/{{publicApiUrl}}/v1/orders

The transaction is assigned an Order Created status by Payengine. For an example of Create Order transaction see Samples.

Retrieve Order

GET/{{publicApiUrl}}/v1/orders/{orderId}

After redirecting from PayPal (or getting a paypalConfirmCallback), the merchant needs to call the endpoint GET/{{publicApiUrl}}/v1/orders/{orderId} to retrieve the completed customer data (shipping address, payment instrument, name, etc).

Update Order (optional)

PATCH/{{publicApiUrl}}/v1/orders/{orderId}

After the order information is retrieved from PayPal, the merchant can optionally update the order. Reasons to update the basket:

1. add new shipping fee/ update existing one
2. add a new discount article

The following specific input parameters for Update Order transaction should be provided:

For more information on the basket, see our Basket Structure documentation.

Execute Order

After the information is retrieved and updated, the customer confirms the order and an Execute Order transaction is triggered.

The button widget automatically sends an order request to the following endpoint: POST/{{publicApiUrl}}/v1/orders/{orderId}/execute

In case of success, the transaction is assigned an Authorized or Debited status by Payengine. For an example of an Execute Order transaction see Samples.

Capture Order

For transactions in an Authorized status, the merchant could capture the payment partially or fully.

This can be done via the Merchant Center or via API through the following endpoint: POST/orders/{orderId}/transactions/{transactionId}/capture

Samples

Create Order Transaction

POST/{{publicApiUrl}}/v1/orders

{
    "initialAmount": 2000,
    "currency": "EUR",
    "transactionType": "DEBIT",

{
    "createdAt": 1585223502177,
    "modifiedAt": 1585223502177,
    "merchantId": "Merchant-11111111-1111-1111-1111-111111111111",

Update order transaction

PATCH/{{publicApiUrl}}/v1/orders/{orderId}

{
    "initialAmount": 2200,
    "basket": [
        {

{
    "createdAt": 1585828829398,
    "modifiedAt": 1585829006579,
    "merchantId": "Merchant-11111111-1111-1111-1111-111111111111",

Execute order transaction

POST/{{publicApiUrl}}/v1/orders/{orderId}/execute

{
    "orderId": "bsmrvwiwsq",
    "merchantOrderId": null,
    "paymentProviderTransactionId": "27T478753E028525V",

Capture order transaction

POST/{{publicApiUrl}}/v1/orders/{orderId}/transactions/{{transactionId}}/capture

{
    "description": "description for operation.",
    "initialAmount": 1190,
    "currency": "EUR",

{
    "createdAt": 1586164358232,
    "modifiedAt": 1586164358270,
    "type": "CAPTURE",