Prebuilt Checkout
Learn how to configure a Prebuilt Checkout session and create one-time and reusable Prebuilt Checkout links.
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 Dashboard provides the following features to let you use this capability:
- A configuration settings page that lets you create, save, and manage Prebuilt Checkout scoped configurations. This topic focuses on how to use this page. The Prebuilt Checkout page is found under the Settings section.
- A related link generation page that lets you create a Prebuilt Checkout session and generate checkout links after you have created a configuration.
Note: You can access all or part of the Prebuilt Checkout feature based on your assigned role for using the Dashboard.
If you are assigned a Customer Service role, you can do the following:
If you are assigned an Administrator role, you can do the following with this feature:
The configurable Prebuilt Checkout session is useful if you have limited storefront capabilities but still need to complete order checkouts.
Once you build a cart and initiate a checkout, the Prebuilt Checkout feature handles the rest of the transaction and presents you with a link to a checkout modal to let you complete the purchase.
You can use this feature to:
- Create a checkout method so you do not have to depend on a storefront presence.
- Create a checkout method if you do not have a storefront but have a product catalog with SKUs to enter to sell those particular items.
- Generate a one-time use checkout link if you are running a temporary promotion. Both administrators and customer service representatives have the ability to generate one-time-use links.
- Generate a reusable checkout link if you are running an extended or permanent promotion. You must have an Administrator role to create a reusable link.
- Generate a Prebuilt Checkout link which you can then copy and paste anywhere. For example, the link could be copied to an email or a social media post to provide for a quick purchase and checkout.
- Provide a checkout method if you want to continue selling products but have a temporarily disabled storefront site or a site under construction.
If you are assigned an Administrator role, you can create and save a Prebuilt Checkout configuration with editable settings that let you define future Prebuilt Checkout session link requests.
An Administrator can create, save, update, or replace a scoped configuration for the Prebuilt Checkout feature. This configuration includes default shipping settings, consents, policies, and links that can be configured to appear in all of the checkout modal UI presented in a subsequent Prebuilt Checkout session. 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 a Prebuilt Checkout configuration has been created and saved, administrators and customer service representatives can then make a request for 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 a single-use or reusable link.
The Prebuilt Checkout page is where you create, save, update, or replace a scoped configuration used by the Prebuilt Checkout feature.
To create a new Prebuilt Checkout configuration or manage an existing configuration, go to Settings in the left navigation of Dashboard and click Prebuilt Checkout to go to the correct page.
Use the following steps to create a new Prebuilt Checkout configuration on the Prebuilt Checkout page:
- 1.Under Logistics, Add your Default ship from address in the provided fields. This address will be used to ship physical products from.
- 2.Add your Default shipping methods information. In the fields provided, add the Amount (for example, 5.00), Description, and Service level of each Default shipping method to be used. Default shipping method information must be entered to cover physical products being sold. Click Add row to add each additional shipping method you want to use. Note: Enter Amount information as decimal values.
- 3.Add optional Shipping callout information. You can configure a shipping callout endpoint for Prebuilt Checkout in this section. Use this feature to configure a shipping method for a Prebuilt checkout session if you do not already have default methods configured. Refer to Configure a shipping callout for more complete information. Note: After customers submit shipping information, we pass their address (along with the checkout session’s product data) in a
POST/checkout/shipping-quote. The shipping callout endpoint you provide must be able to receive and handle this request and send a reply that adheres to the response contract. - 4.Add optional Store credit callout information in this section of the Prebuilt Checkout page. When you do this, each time a shopper requests to use store credit, Digital River checks to see if there is a saved endpoint. With the callout configured, the
POST /drop-in/checkout-sessionscall calls the store credit callout endpoint URL to check if the amount is valid. - 5.Under Consents, provide the following information:
- 6.Company name that you want to appear on the checkout modal.
- 7.Email promotions URL to provide links to promotions in the checkout modal.
- 8.EULA URL to provide the end-user license agreement text in the checkout modal.
- 9.Terms of Service URL to provide the company Terms of Service text in the checkout modal
- 10.Under the Policies subsection, provide the following information:
- 1.Return Policy URL to provide a link in the checkout modal to the company return policy information.
- 2.Refund policy URL to provide a link in the checkout modal to the company return policy information link.
- 11.Click Save to save your Prebuilt Checkout configuration settings or click Cancel to discontinue this task.
Note: Entering incorrect or invalid information in these fields will result in an error message. This could include entering invalid URLs, data of an incorrect type, invalid country codes, and so on.
If you previously saved Prebuilt Checkout, you can change or update the settings as needed. Use the following steps to edit or update an existing Prebuilt Checkout:
- 1.Go to Settings in the Dashboard left navigation and click Prebuilt Checkout.
- 2.In the previously saved configuration, an Edit button appears in the upper right corner of the Prebuilt Checkout configuration page instead of a Save button.
- 3.Click Edit to begin editing the information.
- 4.Change the settings in the page form as needed.
- 5.Click Save to re-save the updated Prebuilt Checkout configuration.
Note: Entering incorrect or invalid information in these fields will result in an error message. This could include entering invalid URLs, data of an incorrect type, invalid country codes, and so on.
On the Prebuilt Checkout page, you can also configure a shipping callout endpoint for Prebuilt Checkout. The Shipping callout subsection is located directly below the Default shipping methods subsection on this page.
The shipping callout is an endpoint provided by a client or connector (because every connector has different options for handling shipping). This allows Prebuilt Checkout to query and provide shipping options directly from the shipping settings on the client or connector platform. The endpoint uses the sessionId to get the address data from Prebuilt Checkout, query the platform to get the right shipping option, and return the data to Prebuilt Checkout.
You can use this feature to configure a shipping method for a Prebuilt Checkout session if you do not already have a default method configured. By providing the information requested in this subsection of the page, you can access your own endpoint to bring in your own shipping methods during the Prebuilt Checkout process.
Provide the following information:
- URL for the shipping callout
- Username to authenticate with this URL
- Password to authenticate with this URL
By entering the Shipping callout information, you override other configured shipping methods used during the
POST /drop-in/checkout-sessions call. The information you provide appears on the front end in the session link modal.Note: After customers submit shipping information, we pass their address (along with the checkout session’s product data) in a
POST/checkout/shipping-quote. The shipping callout endpoint you provide must be able to receive and handle this request and send a reply that adheres to the response contract.On the Prebuilt Checkout page, you can configure a store credit callout endpoint. The Store credit callout subsection is located directly below the Shipping callout subsection on this page.
This feature allows you to more closely manage the store credit you offer to customers and to better defeat fraudulent attempts to abuse it.
In the payment collection stage, if customers request to use store credit, Digital River calls this endpoint to determine whether the payment should be authorized. If your hosted service approves the request, Digital River applies the store credit to the purchase. Otherwise, we prevent the customer from using that payment method.
When providing a store credit endpoint URL in Dashboard, you must also enter a username and password. In both the payment authorization request and the removed store credit notification that Digital River sends to your service, these credentials are transmitted using the basic authentication scheme.
Last modified 2mo ago