Documentation

This is the early access documentation preview for Custom Views. This documentation might not be in sync with our official documentation.

Worldpay WPG payment connector

Learn how to add a Worldpay WPG payment connector to your Project.

Add a Worldpay WPG payment connector

Before you add a Worldpay WPG payment connector, do the following:

  • Contact Worldpay and request:

    • Your Worldpay merchant code, username, and password
    • The activation of one or more of following payment methods: Sofort, iDEAL, and PayPal.

  • Create a Composable Commerce API Client with the Orders, Payments, and Types scopes selected.
    These permissions are required to establish a communication between Composable Commerce and commercetools Checkout.

To add a Worldpay WPG payment connector, you must:

  1. Configure a Worldpay WPG payment connector.
  2. Set up a webhook in your Worldpay Merchant Admin Interface.

Configure a Worldpay WPG payment connector

  1. In the Merchant Center navigation menu, select commercetools Checkout > Add payment connector.

    Add payment connector in the Merchant Center navigation menu and the Configure payment connector page.

  2. On the Configure payment connector page, do the following:

    1. From Select payment provider, select Worldpay WPG.

    2. In the General information section, for Payment connector name, enter a plain-text name for the payment connector.

    3. In the Configuration section, do the following:

      1. For Environment, select the environment where you will use the payment connector.

      2. For Worldpay merchant code, enter the Worldpay WPG merchant code provided by Worldpay.

    4. In the Payment method section, click the toggles to activate or deactivate the payment methods, depending on those you activated on your Worldpay account.

    5. In the Connector secrets section, do the following:

      1. For Client ID, enter the client ID you generated while creating the Composable Commerce API Client.
      2. For Client secret, enter the client secret you generated while creating the Composable Commerce API Client.

    6. In the PSP specific connector secrets section, do the following:

      1. For Username, enter your username provided by Worldpay.
      2. For Password, enter your password provided by Worldpay.

  3. Click Save. On saving, a payment connector ID is generated and it will be available in the General Information section.

Set up a Worldpay webhook

Worldpay uses a webhook to call back the commercetools Checkout application and provide notifications about the status of the payment process. To set up a webhook, follow these steps:

  1. In your Worldpay Merchant Admin Interface, select Integration > Merchant Channel.
  2. Set the following configuration values:
    • Protocol: HTTP
    • Active: Yes
    • Content: XML
    • Address: https://wpg.checkout.{region}.commercetools.com/{PaymentConnectorID}/notifications. Replace {region} with the Region where your commercetools Checkout project is deployed (for example, europe-west1.gcp) and {PaymentConnectorID} with the payment connector ID you generated earlier.
    • Method: POST
    • Client Certificate: No
    • Send Idempotency Key: No
  3. From the Merchant Channel Events list, select the following events to listen to:
    • AUTHORIZED
    • REFUSED
    • ERROR
    • CAPTURE
    • CAPTURE_FAILED
    • CANCELLED
    • EXPIRED
    • SENT_FOR_REFUND
    • REFUND_FAILED
    • CHARGED_BACK

After adding the Worldpay WPG payment connector, add the activated payment methods for this payment connector to your application.