Umbraco Commerce
CMSCloudHeartcoreDXP
15.latest
15.latest
  • Umbraco Commerce Documentation
  • Release Notes
    • v15.1.0-Rc
    • v15.0.0-Rc
  • Commerce Products
    • Commerce Packages
    • Commerce Payment Providers
    • Commerce Shipping Providers
  • Getting Started
    • Requirements
    • Installation
    • Licensing
    • Configuration
    • User Interface
  • Upgrading
    • Upgrading Umbraco Commerce
    • Version Specific Upgrade Notes
    • Migrate from Vendr to Umbraco Commerce
      • Migrate Umbraco Commerce Checkout
      • Migrate custom Payment Providers
  • Tutorials
    • Build a Store in Umbraco using Umbraco Commerce
      • Installation
      • Creating a Store
        • Configuring your Store
      • Creating your first Product
      • Implementing a Shopping Cart
        • Using the Umbraco.Commerce.Cart Drop-in Shopping Cart
        • Creating a Custom Shopping Cart
      • Implementing a Checkout Flow
        • Using the Umbraco.Commerce.Checkout Drop-in Checkout Flow
        • Creating a Custom Checkout Flow
      • Configuring Store Access Permissions
  • How-To Guides
    • Overview
    • Configure SQLite support
    • Use an Alternative Database for Umbraco Commerce Tables
    • Customizing Templates
    • Configuring Cart Cleanup
    • Limit Order Line Quantity
    • Implementing Product Bundles
    • Implementing Member Based Pricing
    • Implementing Dynamically Priced Products
    • Implementing Personalized Products
    • Implementing a Currency Switcher
    • Building a Members Portal
    • Order Number Customization
    • Sending Payment Links to Customers
    • Create an Order via Code
  • Key Concepts
    • Get to know the main features
    • Base Currency
    • Calculators
    • Currency Exchange Rate Service Provider
    • Dependency Injection
    • Discount Rules / Rewards
    • Events
      • List of validation events
      • List of notification events
    • Fluent API
    • Order Calculation State
    • Payment Forms
    • Payment Providers
    • Pipelines
    • Price/Amount Adjustments
    • Price Freezing
    • Product Adapters
    • Product Bundles
    • Product Variants
      • Complex Variants
    • Properties
    • ReadOnly and Writable Entities
    • Sales Tax Providers
    • Search Specifications
    • Settings Objects
    • Shipping Package Factories
    • Shipping Providers
    • Shipping Range/Rate Providers
    • Tax Sources
    • UI Extensions
      • Analytics Widgets
      • Entity Quick Actions
      • Order Line Actions
      • Order Properties
      • Order Collection Properties
      • Order Line Properties
      • Store Menu Items
    • Umbraco Properties
    • Unit of Work
    • Umbraco Commerce Builder
    • Webhooks
  • Reference
    • Stores
    • Shipping
      • Fixed Rate Shipping
      • Dynamic Rate Shipping
      • Realtime Rate Shipping
    • Payments
      • Configure Refunds
      • Issue Refunds
    • Taxes
      • Fixed Tax Rates
      • Calculated Tax Rates
    • Storefront API
      • Endpoints
        • Order
        • Checkout
        • Product
        • Customer
        • Store
        • Currency
        • Country
        • Payment method
        • Shipping method
        • Content
    • Management API
    • Go behind the scenes
    • Telemetry
Powered by GitBook
On this page
  • Generating a Payment Link
  • Copy to Clipboard
  • Send via Email
  • Payment Link Usage
  • Handling Expired Payment Links
  • Headless Considerations
  • Configuration Options

Was this helpful?

Edit on GitHub
Export as PDF
  1. How-To Guides

Sending Payment Links to Customers

Learn how to send a payment link to customers in Umbraco Commerce.

PreviousOrder Number CustomizationNextCreate an Order via Code

Last updated 8 hours ago

Was this helpful?

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. It could be when customers request a quote, and the store owner wants to send a link to the customer to make the payment.

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.

The payment links feature was introduced in Umbraco Commerce version 15.3.0

Generating a Payment Link

  1. Go to the Commerce section in the Umbraco backoffice.

  2. Expand the associated store and click on the Carts menu item.

  3. Click on the Create Cart button.

  4. Populate the cart with the products you want to include in the payment link.

  5. Click on the Save button to save the cart.

  6. Click on the Generate Payment Link button to launch the payment link generator modal.

  1. Configure the payment link settings in the Payment Link Generator modal. You can set the following options:

    • Validity Period: The period in minutes for which the payment link will be valid.

    • Landing Page URL: The URL to which the customer will be directed when clicking on the payment link.

  1. Use one of the two options to send the payment link to the customer:

Copy to Clipboard

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.

Send via Email

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 the Send button will send the email to the recipient with the payment link.

Umbraco Commerce includes a default email template for sending payment links. You can customize this template by going to the Settings section in the Umbraco backoffice and selecting the Email Templates menu item.

Payment Link Usage

When the customer receives the payment link, they can click on the link to open the cart in the store. The cart will be pre-filled with the products and quantities that were added when the payment link was generated.

The customer can proceed to the checkout and complete the purchase as normal.

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.

Handling Expired Payment Links

If a customer tries to use an expired payment link, they will be redirected to the configured landing page URL along with a payment_link_error querystring parameter. The value of this parameter will contain the reason for the error.

Developers should use this querystring parameter to display a message to the customer explaining that the payment link has expired.

Headless Considerations

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.

Configuration Options

The payment links feature has different configuration options you can set via appsettings.json:

appsettings.json
{
  "Umbraco": {
    "Commerce": {
      "PaymentLinks": {
        "TokenSigningSecret": "your_secret_here",
        "TokenQueryParameterName": "payment_link_token",
        "ErrorQueryParameterName": "payment_link_error",
      }
    }
  }
}

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.

Developers should check for a payment_link_token querystring parameter when a customer lands on the site. If present, the developer should use the to retrieve the cart associated with the payment link token. This can then be loaded into the session for the customer to complete payment.

Copy to Clipboard
Send via Email
Storefront API
Generate Payment Link
Payment Link Generator
Copy to Clipboard Notification
Email Template Selection
Recipient Configuration
Email Payment Link Example
Payment Link Populated Cart