Implementing a Prebuilt Checkout
Gain a basic understanding of how to add a Prebuilt Checkout to your site
Last updated
Gain a basic understanding of how to add a Prebuilt Checkout to your site
Last updated
Prebuilt Checkout is a customizable checkout experience that connects an upstream commerce system with Digital River's local pricing, logistics, subscriptions, payment, fraud detection, tax exemption, and disclosure services.
The Prebuilt Checkout solution simplifies integrating with the and our front-end libraries, thereby shortening the time to deployment.
Once customers build a cart and initiate checkout, a Prebuilt Checkout integration needs to:
During the early stages of an eCommerce transaction, customers land on your storefront, review products, and build a cart. Digital River is typically not involved in these early pre-checkout interactions unless you engage our local pricing service. However, once customers initiate checkout, you must start interacting with Prebuilt Checkout.
Add a click event listener to each checkout button on your site. Handle the event by defining a checkout-session request, passing that request data to your back-end server, and then securely sending a create checkout-session request.
Digital River returns a unique checkout-session identifier that you must pass, along with an optional configuration object, to create checkout window method on your front-end.
A 201 Created response to your create checkout-session request contains a unique id.
Use this checkout-session identifier to create a Prebuilt Checkout.
Make sure you include DigitalRiverCheckout.js by adding the following script to your checkout page.
Next, you'll most likely want to build a configuration object.
Then, depending on whether you'd like Prebuilt Checkout to display in a modal or an iframe, pass that object and the checkout session identifier to either createModal() or embed(), respectively.
After createModal() or embed() is invoked, the checkout window opens and onReady executes.
Customers must always provide their name, phone number, email, and billing address at this stage.
Other required inputs and available options depend on whether the checkout involves:
Once customers successfully submit the required information, onAddressComplete executes.
The experience doesn’t ask for shipping details in checkouts containing digital products. Instead, it simply prompts customers for billing information.
Once customers input their shipping choice, onDeliveryComplete executes.
The experience prompts the customer for their tax identification number for applicable checkouts.
In guest checkouts, customers can enter a tax identifier but are not given the option to save the value to their account.
In countries that require tax identifiers, customers must enter a value before proceeding to the payment stage.
Once customers provide payment, agree to the terms, and successfully submit the order, onCheckout Complete is called.
Prebuilt Checkout can ask customers whether they'd like to save a payment method for future purchases.
If the payment method customers select supports reusability, they are asked whether they'd like to save it for future purchases. If they opt to do so, we save it for that customer after Digital River creates the source.
Prebuilt Checkout presents users with the designated selling entity's terms of sale and privacy policy for each displayed payment method.
If you save your own consents in the Dashboard, they are appended to Digital River's disclosures. Customers must accept all these terms and disclosures before completing the purchase.
Prebuilt Checkout only displays Digital River's disclosures if you don't save customized consents in the Digital River Dashboard
There are various ways to configure the order confirmation stage. The following is an example of the default option.
For details, refer to the page.
To create a checkout-session, send your and in a .
Use your to create a DigitalRiverCheckout object.
Depending on how the is configured, the experience takes customers through various stages:
If any in the represent physical products, customers are prompted for shipping information. Once validated, Digital River uses it to populate the shipTo and billTo.
If you send in the create checkout-session request, customers can save their shipping and billing information for future checkouts. If you pass , customers are presented with these saved addresses for convenience.
If the is business, then customers must provide their company's name when entering shipping and billing information.
If you activate the feature, customers are shown a checkbox asking them whether they’d like to purchase on behalf of a business.
If contains physical goods, and then this toggle is displayed in the shipping information form. Otherwise, when are all digital, customers are presented with this option while supplying their billing information.
The experience prompts the user to choose shipping in transactions containing physical products. For each in the , customers are always shown its description and amount.
with applicable, saved tax identifiers can either select one of the values presented to them or enter a new one.
Registered customers who have no stored, transaction-applicable tax identifiers can save a new value for use in future checkouts. If they select this option, Digital River saves the tax identifier to the .
In the payment collection stage, customers are only shown payment methods that are appropriate to the transaction. Depending on how you configure the and on your Digital River Dashboard settings, the experience can also:
If you pass a in the , we retrieve and display any transaction-applicable payment sources[] that are saved to the referenced .
You must pass in the to activate this feature.
If the resource you reference doesn't exist in your account, Digital River creates a new and assigns it the identifier you passed.
To determine what disclosures customers accepted, you can configure a webhook to listen for the with a type of checkout_session.order.created.
