LogoLogo
System Status
  • Digital River API
  • Getting started
  • Using our services
    • Local pricing
    • Item classification
    • Subscriptions
    • e-Invoicing
  • Integration options
    • Low-code checkouts
      • Implementing a Prebuilt Checkout
      • Implementing a Components checkout
      • Offering local pricing
      • Using a shipping endpoint
      • Processing subscription acquisitions
      • Adding custom fields
      • Offering store credit
      • Displaying policies and getting consent
      • Collecting e-invoice information
      • Handling completed checkout-sessions
    • Direct integrations
      • Standard flow
      • Building checkouts
        • Checking out guest and registered customers
        • Describing line items
          • Setting the price of an item
          • Managing items with shared SKU identifiers
        • Providing address information
        • Handling shipping choice
        • Tax identifiers
        • Applying a discount
        • Setting the customer type
        • Providing the IP address
        • Selecting a currency
        • Initiating a charge
        • Setting the purchase location
        • Configuring taxes
        • Accessing regulatory fee information
        • Localizing invoices and credit memos
        • Providing an upstream identifier
        • Applying store credit
        • Handling e-invoicing requirements
        • Landed cost
        • Tax calculation inputs
        • Selling entities
        • Payment sessions
        • Applying store credit (legacy)
        • Country specs
      • Building payment workflows
        • Handling redirect payment methods
        • Handling delayed payment methods
      • Subscription acquisitions
        • Handling subscription acquisitions
        • Handling external subscription acquisitions
        • Subscription information
      • Digital River coordinated fulfillments
        • Checking inventory levels
        • Using shipping quotes
        • Reserving inventory items
        • Managing a fulfillment order
        • Cancelling a fulfillment order
    • Connectors
  • Order management
    • Processing orders
    • Handling a rejected order
    • Accessing invoices and credit memos
    • Fulfilling goods and services
    • Capturing and cancelling charges
    • Payment reauthorizations
    • Handling reversals
      • Return basics
        • Digital River coordinated returns
        • Third party coordinated returns
      • Refund basics
        • Issuing refunds
        • Refunding asynchronous payment methods
      • Disputes and chargebacks
    • Customer notifications
    • Responding to events
      • Events
        • Key event types
        • All event types
      • Webhooks
        • Creating a webhook
        • Digital River API safelist
        • Digital River signature
      • Expanding events
      • Preventing webhooks from getting disabled
    • Distributor model
  • Subscription Management
    • Managing a subscription
    • Managing an external subscription
  • Payments
    • Payment solutions
      • Drop-in payments
        • How Drop-in payments work
        • Drop-in payments integration guide
      • DigitalRiver.js with Elements
        • Elements integration guide
        • Configuring payment methods
          • Configuring Afterpay
          • Configuring Alipay+ (cross-border)
          • Configuring Alipay (domestic)
          • Configuring Amazon Pay
          • Configuring Apple Pay
          • Configuring Bancontact
          • Configuring BNP Paribas
          • Configuring BLIK
          • Configuring CCAvenue
          • Configuring Clearpay
          • Configuring Credit Cards
          • Configuring FPX Online Banking
          • Configuring Google Pay
          • Configuring iDEAL
          • Configuring Klarna
          • Configuring Konbini
          • Configuring Online Banking (IBP)
          • Configuring Online Banking (Korea Bank Transfer)
          • Configuring PayCo
          • Configuring PayPal
          • Configuring SEPA Direct Debit
          • Configuring Trustly
          • Configuring Wire Transfer
          • Common payment sources
          • Common payment objects
    • Supported payment methods
      • Afterpay
      • Alipay (domestic)
      • Alipay+ (cross-border)
      • Amazon Pay
      • Apple Pay
      • Bancontact
      • BNP Paribas
      • BLIK
      • CCAvenue
      • Clearpay
      • Credit Cards
      • FPX Online Banking
      • Google Pay
      • iDEAL
      • Klarna
      • Konbini
      • Korea Bank Transfer (Online Banking)
      • Online Banking (IBP)
      • Pay with Installments France
      • PayCo
      • PayPal
      • PayPal Billing Agreement
      • PayPal Credit
      • PayPal Pay in 3
      • PayPal Pay in 4
      • PayPal RatenZahlung (Installment Payment)
      • SEPA Direct Debit
      • Trustly
      • Wire Transfer
    • Source basics
      • Managing sources
      • Handling credit card sources
      • Retrieving sources
    • Authorization declines
    • PSD2 and SCA
      • How to ensure SCA compliance
    • Payment testing scenarios
  • Product management
    • Product basics
    • Managing SKUs
    • Using product details
    • Grouping SKUs
    • SKU-inventory item pairs
    • Managing inventory items
    • Regulatory fees
      • What are regulatory fees?
        • Fees terminology
        • Regulatory fee management
        • European regulatory fees
        • Compliance obligations
        • WEEE directive requirements
        • Copyright directive requirements
        • Compliance challenges
      • Managing regulatory fees
  • Customer management
    • Customer basics
    • Creating and updating customers
    • Setting up tax exemptions
    • Recording a customer's request to be forgotten
  • Financial reporting
    • Financials basics
    • Sales transactions
      • Returning a list of sales transactions
      • Getting a sales transaction by ID
    • Sales summaries
      • Returning a list of sales summaries
      • Getting a sales summary by ID
    • Payouts
      • Returning a list of payouts
      • Getting a payout by ID
      • Get a list of transactions included in payout by ID
  • Developer resources
    • Digital River API reference
    • DigitalRiver.js reference
      • Including DigitalRiver.js
      • Initializing DigitalRiver.js
      • DigitalRiver object
      • Elements
        • Amazon Pay element
        • Apple Pay elements
        • Google Pay elements
        • IBAN element
        • iDEAL element
        • Konbini elements
        • Compliance element
        • Offline Refund elements
        • Online Banking elements
        • Tax Identifier element
        • Invoice attribute element
        • Delayed Payment Instructions element
        • PayPal elements
      • Guidelines for capturing payment details
      • Security
      • Digital River payment objects
      • Error types, codes, and objects
    • DigitalRiverCheckout.js reference
      • Including DigitalRiverCheckout.js
      • Initializing DigitalRiverCheckout.js
        • DigitalRiverCheckout configuration object
      • DigitalRiverCheckout object
        • Configuring Prebuilt Checkout
          • Performing actions
          • Defining experience
        • Components
          • Configuring components
          • Address component
          • Shipping component
          • Tax identifier component
          • Invoice component
          • Wallet component
          • Payment component
          • Compliance component
          • Order summary component
          • Thank you component
        • Rendering a checkout button
          • Performing actions on the checkout button
        • Determining the checkout's status
      • Accessing country and currency
    • DynamicPricing.js reference
    • Postman collection
  • administration
    • Sign in
    • Digital River Dashboard
      • Digital River Dashboard quick start guide
      • Key features
      • Reset your password
      • Test and production environments
      • Account
        • Adding an account
        • Switching accounts
        • Account access
      • Profile settings
        • Viewing your personal information
        • Changing your password
        • Updating your phone number
        • Enabling multi-factor authentication
      • Finance
        • Payouts
          • Viewing your payout details
          • Filtering your payouts
          • Exporting your payouts
        • Sales summaries
          • Viewing your sales summaries details
          • Filtering your sales summaries
          • Exporting your sales summaries
          • Exporting your sales summary details
        • Transactions
          • Viewing your transaction details
          • Filtering your transactions
          • Exporting your transactions
      • Order management
        • Orders
          • Searching for orders
          • Filtering your orders
          • Viewing the order details
          • Cancelling items
          • Fulfilling items
          • Downloading an invoice
          • Downloading a credit memo
          • Creating shipping labels
          • Recording a customer's request to be forgotten
          • Viewing returns and refunds
          • Creating a return
          • Accepting a return
          • Creating a refund
          • Viewing the order's timeline
        • Checkouts
          • Searching for checkouts
          • Filtering your checkouts
          • Viewing the checkout details
        • Prebuilt Checkout links
          • Generate Prebuilt Checkout links
          • View and work with Prebuilt Checkout link details
          • Add a customer during Prebuilt Checkout
          • Add a product during Prebuilt Checkout
      • Customers
        • Viewing customer details
        • Searching for customers
        • Filtering your customers
        • Editing account information
        • Adding a customer
        • Tax IDs and certificates
          • Adding a tax certificate
          • Adding a tax ID
          • Deleting a tax ID
        • Metadata
          • Adding metadata
          • Editing metadata
        • Manage subscriptions from the Customer Details page
        • Disabling a customer
        • Recording a customer's request to be forgotten
        • Deleting a customer
      • Catalog
        • SKUs
          • Viewing the SKU details
          • Searching for SKUs
          • Filtering your SKUs
          • Adding a SKU
          • Editing a SKU
          • Deleting a SKU
          • Adding a fee to a SKU
          • Editing a fee
          • Deleting a fee
          • Viewing product tariff codes
        • Managing customer subscriptions from Digital River Dashboard
      • Developers
        • API keys
          • Updating your API version
          • Getting your API keys
          • Changing the API version for your key
          • Creating a restricted key
          • Editing a restricted key
          • Deleting a restricted key
          • Rotating keys
        • Webhooks
          • Creating a webhook
          • Editing a webhook
          • Deleting a webhook
          • Rotating a webhook's secret
        • API logs
          • Filtering the API log
          • Viewing the API log details
        • Event logs
          • Filtering the events log
          • Viewing the event details
      • Settings
        • Users and roles
          • Roles
          • Searching for a user by name or email
          • Filtering your users and roles
          • Adding a user
          • Editing a user
          • Deleting a user
        • Prebuilt Checkout
        • Payment methods
          • Viewing your payment methods
          • Viewing payment method details
            • Enabling currencies
            • Managing countries
          • Enabling or disabling a payment method
  • General Resources
    • eCompass
    • eCompass documentation
    • Release notes
      • 2024
      • 2023
      • 2022
      • 2021
      • 2020
      • 2019
    • Standards and certifications
      • Certification process
      • Compliance requirements
      • Documentation requirements
      • Integration checklists
        • Admin portal
        • Products and SKUs
        • Customers and tax exemptions
        • Checkouts, payment sources, and orders
        • Disclosures, compliance statements, and emails
        • Fulfillments and cancellations
        • Customer portal
        • Order refund synchronization
        • Reversals
        • Error handling
      • Test and use cases
    • Commerce infrastructure
    • Versioning
    • Glossary
Powered by GitBook
On this page
  • Role-based access
  • Understand the uses of Prebuilt Checkout
  • View the configured Prebuilt Checkout settings
  • Configure the Prebuilt Checkout settings
  1. administration
  2. Digital River Dashboard
  3. Settings

Prebuilt Checkout

Learn how to configure a Prebuilt Checkout session and create one-time and reusable Prebuilt Checkout links.

PreviousDeleting a userNextPayment methods

Last updated 2 months ago

You can configure Prebuilt Checkout to generate links that connect to an upstream commerce system with Digital River's payment processing, fraud detection, tax exemption, and disclosure services.

The Digital River Dashboard provides the following features to let you use this capability:

  • A configuration settings page lets you create, save, and manage Prebuilt Checkout scoped configurations. This topic focuses on how to use this page. The Prebuilt Checkout page can be found under the Settings section.

  • A related link generation page lets you after creating a configuration.

Role-based access

Depending on your assigned role, you can access all or part of the Prebuilt Checkout feature using the Digital River Dashboard.

Feature
Customer Service
Administrator

✔

✔

✔

✔

✔

✔

✔

✔

✔

✔

✔

✔

For more information on roles, refer to .

Understand the uses of Prebuilt Checkout

The Prebuilt Checkout feature is ideal for completing order checkouts with limited storefront capabilities. It facilitates transactions by providing a checkout link or modal, enabling purchases without a storefront. Key functionalities include:

  • Checkout options independent of a storefront

  • SKU-based checkout for catalog sales

  • One-time or reusable checkout links for promotions. You can copy and paste these links anywhere.

  • Easy integration of checkout links into emails or social media. For example, you could copy the link to an email or a social media post to provide a quick purchase and checkout.

  • Continuation of sales during storefront downtime or construction by providing this checkout method

View the configured Prebuilt Checkout settings

To view the configured Prebuilt Checkout settings, click Prebuilt Checkout under Settings in the navigation pane.

Configure the Prebuilt Checkout settings

To configure the Prebuilt Checkout settings, users with an Administrator role can create or modify configurations, which include options for default shipping settings, consents, and policies. This setup ensures streamlined management of checkout sessions, allowing for efficient session link requests and customization of the checkout modal UI, such as setting single-use or reusable checkout links.

With this saved configuration, you do not need to specifically enter Prebuilt Checkout configuration information every time you want to initiate a new session. Once you create and save a Prebuilt Checkout configuration, administrators and customer service representatives can then request one-time use checkout links using that session ID. The Prebuilt Checkout session ID and URL provided in a session response create a one-time checkout modal window. If you have an Administrator role, you can also decide whether the link is single-use or reusable.

1

Custom options

  1. Click Prebuilt Checkout under Settings in the navigation pane.

  2. Click Edit.

  3. You can turn the following custom options on or off by toggling the settings:

    • Display a "Purchasing for a Business" checkbox: Enable this option to show a checkbox that indicates whether the shopper is purchasing for a business rather than as an individual.

    • Require shoppers to provide a ship-to phone number: Enable this option to mandate that shoppers provide a phone number for shipping during checkout.

    • Require shoppers to provide a bill-to phone number during checkout: Enable this option to require shoppers to give a phone number for billing at checkout.

    • Collect custom information during checkout: Select this checkbox to gather additional customer information during checkout.

      1. To indicate the field is required, turn on the Required toggle.

      2. Choose the field type from the Field type drop-down list. Your options are as follows:

        • Text: The Text field is a customizable input option that lets customers enter free-form text during checkout. It helps collect information that doesn't fit into specific categories, like special requests or comments. You can also make it a required field, so customers must fill it out before purchasing. This makes the Text field flexible for gathering information that suits your business needs.

        • Numeric: The Numeric field is designed to collect numerical input from customers during checkout. This field allows shoppers to input only numbers, making it ideal for collecting information like quantity, percentage, or any other necessary numeric data. You can also designate this field as required, ensuring customers provide a number before purchasing. It helps streamline the checkout process by ensuring you receive the necessary numeric information directly from the customer.

        • Dropdown: If you choose Dropdown, enter an option label and value for each option in the drop-down list. To add drop-down options, click Add custom field dropdown option (at least 1 is required).

      3. Provide a key in the Key field, and enter a label in the Label field.

2

Logistics

Pick your shopper's logistics settings by selecting the appropriate checkbox:

  • Set a default shopping country: To set a default shopping country, select the checkbox and enter the two-letter country code in the field.

  • Set default shipping methods: You must set up the default shipping methods for physical products. To set the default shipping methods:

    1. Select the Set default shipping methods checkbox.

    2. For each shipping method, enter:

      • The shipping cost in the Amount field, for example, 14.00. Note: Enter Amount information as decimal values.

      • The shipping cost in the Description field, for example, USPS.

      • The service level in the Service level field, for example, priority.

    3. To add a shipping method, click Add shipping method and complete the fields.

3

Shopper consents

Pick your shopper's consent settings by selecting the appropriate checkbox:

  • Display additional legal policies: Provides a clickable link to the store's other legal policies at checkout. To display additional legal policies:

    1. Select the Display additional legal policies checkbox.

    2. In the Public company name field, type the company name you want to appear in the checkout modal.

    3. Select the Your End User License Agreement checkbox if you want customers to agree to your End User License Agreement (EULA) and provide the URL of the EULA.

    4. Select the Your Terms of Service checkbox if you want your customers to agree to your Terms of Service (ToS) and provide the TOS's URL.

  • Display marketing opt-in: Provides you with a selectable checkbox that lets the shopper opt-in to the store's marketing information. To display the marketing opt-in checkbox, turn on the Display marketing opt-in checkbox toggle.

Note: Entering incorrect or invalid information in these fields will result in an error message. This could include entering invalid URLs, data of the wrong type, invalid country codes, etc.

4

Store policies

Pick your shopper's store policies settings by selecting the appropriate checkbox:

  • Display a link to your store's return policy: Select the checkbox and provide the URL to your store's return policy. The shopper will see this clickable link at checkout.

  • Display a link to your store's refund policy: Select the checkbox and provide the URL to your store's refund policy. The shopper will see this clickable link at checkout.

Note: Entering invalid URLS in these fields will result in an error message.

5

Webhooks

You can choose to create webhooks for Prebuilt Checkout by selecting the appropriate checkbox:

  • Enable the shipping webhook: Select the checkbox and provide a URL, username, and password. This webhook retrieves shipping options using a sessionId and requires that the provided URL can handle requests and respond correctly. It overrides other shipping methods in the checkout session, displaying the shipping options in the session link modal.

6

Save your changes

Click Save to save your Prebuilt Checkout settings or Cancel to discard your changes.

to a Prebuilt Checkout link

to a Prebuilt Checkout link

Set a default ship-from address: Select the checkbox and enter the shipping address details in the field provided to set a default ship-from address. This is the address from which physical products will be shipped. For more information, see .

To delete a shipping method, click Delete next to the shipping method.

Enable the store credit webhook: Select the checkbox and enter a URL, username, and password. This webhook activates when a shopper tries to use store credit, ensuring the requested credit is valid by calling a specified endpoint. For more information on using this feature in , see .

create a Prebuilt Checkout session and generate checkout links
Users and roles
Providing address information
Prebuilt Checkout
Offering store credit
Add a new or existing product
Add a new or existing customer
View the Configured Prebuilt Checkout settings
Create, save, update, and manage Prebuilt Checkout scoped configurations
Create a Prebuilt Checkout link session
Generate a one-time Prebuilt Checkout link that expires in 24 hours
Generate a reusable Prebuilt Checkout link with no expiration
Delete any one-time or reusable Prebuilt Checkout link