You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: 15/umbraco-commerce/how-to-guides/payment-links.md
+18-17Lines changed: 18 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,54 +1,55 @@
1
1
---
2
-
description: Learn how to send a payment links to customers in Umbraco Commerce.
2
+
description: Learn how to send a payment link to customers in Umbraco Commerce.
3
3
---
4
4
5
5
# Sending Payment Links to Customers
6
6
7
-
A common scenario in ecommerce can be when a store owner wants to send a pre-filled cart to a customer for them to complete. This can be useful in many scenarios. For example, if a customer has requested a quote and the store owner wants to send a link to the customer to make payment.
7
+
A common scenario in e-commerce is when a store owner wants to send a pre-filled cart to a customer for them to complete. This can be useful in many scenarios, such as when a customer has requested a quote and the store owner wants to send a link to the customer to make payment.
8
8
9
-
In Umbraco Commerce it take but a few clicks to create and send a payment link. The customer can then click on the link and complete the purchase.
9
+
In Umbraco Commerce, it only takes a few clicks to create and send a payment link. The customer can then click the link and complete the purchase.
10
10
11
11
{% hint style="info" %}
12
12
The payment links feature was introduced in Umbraco Commerce version 15.3.0
13
13
{% endhint %}
14
14
15
15
## Generating a Payment Link
16
16
17
-
1. In the Umbraco backoffice, go to the **Commerce** section, expand the associated store and click on the **Carts** menu item.
18
-
2. Click on the **Create Cart** button.
19
-
3. Populate the cart with the products you want to include in the payment link.
20
-
4. Click on the **Save** button to save the cart.
21
-
5. Click on the **Generate Payment Link** button to launch the payment link generator modal.
17
+
1. Go to the **Commerce** section in the Umbraco backoffice.
18
+
2. Expand the associated store and click on the **Carts** menu item.
19
+
3. Click on the **Create Cart** button.
20
+
4. Populate the cart with the products you want to include in the payment link.
21
+
5. Click on the **Save** button to save the cart.
22
+
6. Click on the **Generate Payment Link** button to launch the payment link generator modal.
6. In the payment link generator modal, you can configure the payment link settings. You can set the following options:
26
+
7. Configure the payment link settings in the Payment Link Generator modal. You can set the following options:
26
27
27
28
-**Validity Period**: The period in minutes for which the payment link will be valid.
28
29
-**Landing Page URL**: The URL to which the customer will be directed when clicking on the payment link.
29
30
30
31
31
32
32
-
7. With the form filled out, you now have two options to send the payment link to the customer:
33
+
8. Use one of the two options to send the payment link to the customer:
33
34
34
35
-[**Copy to Clipboard**](#copy-to-clipboard)
35
36
-[**Send via Email**](#send-via-email)
36
37
37
38
### Copy to Clipboard
38
39
39
-
Clicking on the **Copy to Clipboard** button will generate the payment link and then copy it to the clipboard. A notification will display to confirm the copy was successful. You can then paste the link into an email or other communication method.
40
+
Clicking on the **Copy to Clipboard** button generates the payment link and then copies it to the clipboard. A notification will display to confirm the copy was successful. You can paste the link into an email or other communication form.
40
41
41
42
42
43
43
44
### Send via Email
44
45
45
-
Clicking on the **Send via Email** button will launch the send email modal. From here you can select the email template to use, along with the email address of the recipient.
46
+
Clicking on the **Send via Email** button launches the Send Email modal. From here, you can select an email template and set the recipient's email address.
Clicking on the **Send** button will send the email to the recipient with the payment link included.
52
+
Clicking the **Send** button will send the email to the recipient with the payment link.
52
53
53
54
54
55
@@ -62,7 +63,7 @@ When the customer receives the payment link, they can click on the link to open
62
63
63
64
64
65
65
-
The customer can then proceed to the checkout and complete the purchase as normal.
66
+
The customer can proceed to the checkout and complete the purchase as normal.
66
67
67
68
{% hint style="info" %}
68
69
The payment link cart will be held in session until the cart is completed or the session expires. Once completed, any previously open carts will be restored.
@@ -76,13 +77,13 @@ Developers should use this querystring parameter to display a message to the cus
76
77
77
78
## Headless Considerations
78
79
79
-
For standard Razor site implementations the handling of the payment links is done automatically. For headless headless Storefront API implementations however, you will need to handle the payment links manually.
80
+
The payment links handling is done automatically for standard Razor site implementations. You need to handle the payment links manually for headless Storefront API implementations.
80
81
81
82
Developers should check for a `payment_link_token` querystring parameter when a customer lands on the site. If present, the developer should use the [Storefront API](../reference/storefront-api/endpoints/order.md#umbraco-commerce-storefront-api-v1-order-paymentlinktoken) to retrieve the cart associated with the payment link token. This can then be loaded into the session for the customer to complete payment.
82
83
83
84
## Configuration Options
84
85
85
-
The payment links feature has a number of configuration options you can set via `appsettings.json`:
86
+
The payment links feature has several configuration options you can set via `appsettings.json`:
86
87
87
88
{% code title="appsettings.json" %}
88
89
```json
@@ -100,4 +101,4 @@ The payment links feature has a number of configuration options you can set via
100
101
```
101
102
{% endcode %}
102
103
103
-
By default Umbraco Commerce payment link tokens are based on the JWT format and are signed using the `TokenSigningSecret` value. The `TokenQueryParameterName` value is used to configure the querystring parameter name used for the payment link token. The `ErrorQueryParameterName` value is used to configure the querystring parameter name used for an error message.
104
+
By default, Umbraco Commerce payment link tokens are based on the JSON Web Token (JWT) format and are signed using the `TokenSigningSecret` value. The `TokenQueryParameterName` value is used to configure the querystring parameter name used for the payment link token. The `ErrorQueryParameterName` value is used to configure the querystring parameter name used for an error message.
0 commit comments