Skip to content

Commit f257c0d

Browse files
eshanrnheshanrnh
authored
Merge pull request #7629 from mattbrailsford/uc-worldpay-docs
Worldpay payment provider docs
2 parents 47007f7 + 9bed857 commit f257c0d

File tree

7 files changed

+77
-4
lines changed

7 files changed

+77
-4
lines changed

‎commerce-add-ons/payment-providers/SUMMARY.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,8 @@
7676
## Worldpay
7777

7878
* [Overview](worldpay/README.md)
79+
* [Configure Worldpay](worldpay/configuring-worldpay.md)
80+
* [Configure Umbraco](worldpay/configuring-umbraco.md)
7981
* [Release Notes](worldpay/release-notes.md)
8082

8183
## Buckaroo

‎commerce-add-ons/payment-providers/media/worldpay/wp_docs.png‎

89.2 KB
Loading

‎commerce-add-ons/payment-providers/media/worldpay/wp_umbraco_create.png‎

97.3 KB
Loading

‎commerce-add-ons/payment-providers/media/worldpay/wp_umbraco_settings.png‎

114 KB
Loading

‎commerce-add-ons/payment-providers/worldpay/README.md‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,6 @@ description: Getting Started with the Worldpay payment provider for Umbraco Comm
66

77
The Worldpay payment provider allows you to capture payments via the [Worldpay](https://www.worldpay.com/en) payment gateway. It is a fully featured payment provider allowing full control of the payment flow directly from the Umbraco Commerce backoffice.
88

9-
{% hint style="warning" %}
10-
This page is a work in progress.
11-
{% endhint %}
12-
139
Before you begin, ensure that you have an Umbraco website set up and Umbraco Commerce installed. If not, see the [Umbraco Commerce Documentation](https://docs.umbraco.com/umbraco-commerce/) to get started.
1410

1511
## Install Worldpay

‎commerce-add-ons/payment-providers/worldpay/configuring-umbraco.md‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
---
2+
title: Configuring Umbraco
3+
description: >-
4+
Learn how to configure the Umbraco backoffice for enabling the use of Worldpay
5+
as a payment method.
6+
---
7+
8+
# Configure Umbraco
9+
10+
## Step 1: Create Payment Method
11+
12+
The following steps are all handled through the Umbraco backoffice.
13+
14+
1. Navigate to **Settings > Commerce > Stores > {Store Name} > Payment Methods** section.
15+
2. Select the **Create Payment Method** button to create a new payment method.
16+
3. Choose **Worldpay Business Gateway 350** from the list of available payment providers.
17+
18+
![The "Create Payment Method" dialog in the Commerce section of the Umbraco CMS backoffice.](../media/worldpay/wp_umbraco_create.png)
19+
20+
## Step 2: Configure Payment Provider Settings
21+
22+
The following steps are handled within the payment method editor in the Umbraco backoffice.
23+
24+
1. Configure the standard payment method settings as required.
25+
2. Configure the Worldpay payment provider settings as follows:
26+
27+
| Name | Description |
28+
| --------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
29+
| Continue URL | The URL of the page to navigate to after payment is successful. For example: `/confirmation/` |
30+
| Cancel URL | The URL of the page to navigate to if the customer cancels the payment. For example: `/cart/` |
31+
| Error URL | The URL of the page to navigate to if there is an error with the payment. For example: `/error/` |
32+
| Billing Address (Line 1) Property Alias | The alias of the property containing line 1 of the billing address. For example: addressLine1. Passed to Worldpay for Radar verification. See default aliases [in the Umbraco Commerce documentation](https://docs.umbraco.com/umbraco-commerce/key-concepts/properties#order-property-map). |
33+
| Billing Address (Line 2) Property Alias | The alias of the property containing line 2 of the billing address. For example: addressLine1. Passed to Worldpay for Radar verification. See default aliases [in the Umbraco Commerce documentation](https://docs.umbraco.com/umbraco-commerce/key-concepts/properties#order-property-map). |
34+
| Billing Address City Property Alias | The alias of the property containing the city of the billing address. For example: addressLine1. Passed to Worldpay for Radar verification. See default aliases [in the Umbraco Commerce documentation](https://docs.umbraco.com/umbraco-commerce/key-concepts/properties#order-property-map). |
35+
| Billing Address State Property Alias | The alias of the property containing the state of the billing address. For example: addressLine1. Passed to Worldpay for Radar verification. See default aliases [in the Umbraco Commerce documentation](https://docs.umbraco.com/umbraco-commerce/key-concepts/properties#order-property-map). |
36+
| Billing Address Zip Code Property Alias | The alias of the property containing the zip code of the billing address. For example: addressLine1. Passed to Worldpay for Radar verification. See default aliases [in the Umbraco Commerce documentation](https://docs.umbraco.com/umbraco-commerce/key-concepts/properties#order-property-map). |
37+
| Install ID | The Worldpay installation ID |
38+
| MD5 Secret | The Worldpay MD5 secret to use when creating MD5 hashes |
39+
| Response Password | The Worldpay payment response password to use to validate payment responses |
40+
| Capture | Toggle indicating whether to immediately capture the payment, or whether to authorize the payment for later (manual) capturing. |
41+
| Test Mode | Toggle indicating whether this provider should run in test mode |
42+
43+
In addition to these core settings, other optional advanced settings can be configured:
44+
45+
| Name | Description |
46+
| ---------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
47+
| Verbose Logging | Enable verbose logging |
48+
49+
![Overview of the available Payment Provider Settings in the Umbraco CMS backoffice.](../media/worldpay/wp_umbraco_settings.png)

‎commerce-add-ons/payment-providers/worldpay/configuring-worldpay.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
description: >-
3+
Learn how to configure Worldpay in order to implement the integration with
4+
your Umbraco Commerce installation.
5+
---
6+
7+
# Configure Worldpay
8+
9+
## Step 1: Register with Worldpay
10+
1. Go to [Worldpay Documentation](https://docs.worldpay.com/apis/bg350) and follow the registration instructions.
11+
12+
2. Obtain your **Installation ID** following the documentation.
13+
14+
## Step 2: Enable Payment Responses
15+
16+
1. Follow the [Enable Payment Responses Documentation](https://docs.worldpay.com/apis/bg350/enablepaymentresponses) to enable Payment Responses.
17+
2. Configure the response URL as follows:
18+
19+
```bash
20+
https://{store_domain}/umbraco/commerce/payment/callback/worldpay-bs350/{payment_method_id}/
21+
22+
## Step 3: Enable Enhanced Security
23+
24+
1. Follow the [Enhancing Security with MD5 Documentation](https://docs.worldpay.com/apis/bg350/enhancing-security-with-md5) to configure advanced security.
25+
26+
2. When setting up Enhanced Security, you will be asked to configure an **MD5 secret**. Remember it for later.

0 commit comments

Comments
 (0)