Configure the Digital River Extension
Learn how to configure the Digital River Extension.
A Digital River account is required to use this extension. If you do not have a Digital River account, you can sign up for one here.
Below are the steps for configuring this extension:
The Digital River Dashboard is your portal to your Digital River account. You can use Dashboard to retrieve your API keys, view Payouts, or search API logs.
- 2.On the API keys page, make note of the Standard keys and Restricted keys. You will use these keys in Step 2. See Getting your API keys in the Dashboard documentation for instructions on retrieving your API credentials.
- 1.From the Magento Admin Panel, select Stores, select Conﬁguration, select Digital River Settings, and then click General Settings.
- 2.Click Configuration to expand it and complete the following fields:SettingsDescriptionEnabledSelect Yes. By selecting Yes, you are electing to include all Digital River payments enabled in the Other Payment Methods section on the store checkout, and for all transactions to be sent and processed by Digital River per your contract.Public KeyEnter the public API key provided by Digital River.Secret KeyEnter the secret key provided by Digital River.Signing SecretEnter the signing secret provided by Digital River.Enable debug loggingBy selecting Yes, extension errors will log debugging data.
- 1.Click Catalog Sync Settings to expand it and complete the fields:SettingsDescriptionCatalog Sync EnabledSelect Yes. By selecting Yes, you are electing to sync your Magento catalog with the Digital River SKU Service. Ensure you have cron jobs set up and configured.Start TimeSet a time of day (hour:minute:second) for the sync to occur.FrequencySet a frequency (Daily:Weekly:Monthly) for the sync to run.Error Email SenderThis is the email address from which the error notification email will be sent.Error Email TemplateChoose your email template. Note: The default Catalog Sync Template contains file-level data that may not be included in other templates.Enable Debug ModeBy selecting Yes, catalog syncing errors will log debugging data.Error Log File NameThe file name for the error log file.Error Notification Via EmailBy selecting Yes, an email will be sent when there is an error in the catalog sync job.Notification Email AddressEmail address to which notifications will be sent.Catalog Batch Size Sync LimitThe number of files that will sync with each sync job. The default is 250.
- 2.Click Save Conﬁg when you are ﬁnished.
You create webhooks to receive integration messages from Digital River. Those messages are triggered by events in Digital River’s application. When triggered, the event messaging will update the Adobe Commerce (Magento) order status (see Exhibit B in the Appendix section).
Create a webhook to receive notifications using the following steps:
- Step 3a: Open your firewall to trusted Digital River IP addresses
- Step 3b: Create a webhook endpoint
- Step 3c: Create webhooks
To receive webhook notifications from Digital River, you will need to open your firewall to all the IP addresses listed in the Digital River safelist.
You can send webhook data as JSON in the POST request body. The POST request body contains the complete event details, and you can use it after parsing the JSON into an Event object.
Your webhook endpoint URL should be the URL to your Magento installation +
- 1.From the Webhooks page, click Create Webhook.
- 2.Toggle Disabled to Enabled.
- 3.If required, select the API version you want to associate with events from the API Version dropdown list. By default, the confidential key version is selected.
- 4.Enter the URL for the endpoint in the Endpoint URL field.
- 5.Select the check box next to each event you want to associate with the endpoint or select the Events Selected check box to select all events. At least one event type must be selected.
- 6.Scroll down and click Save.
Webhooks must be created for the following events:
Since Digital River acts as the merchant of record on all transactions, payment methods must be configured by Digital River. Work with your Digital River representative to configure the selection and display of payment methods in the Digital River Drop-in payment integration. Enabling Digital River payment methods and other payment methods on the configuration page for the same store will result in failures.
- 1.From the Magento Admin panel, select Stores, select Conﬁguration, select Sales, select Payment Methods.
- 2.In Payment Methods, make the following selections:
- Select Check/Money Order. Then set Enabled to No.
- Select Cash On Delivery Payment. Then set Enabled to No.
- Select Bank Transfer Payment. Then set Enabled to No.
- Select Purchase Order. Then set Enabled to No.
- Select Digital River Payment. Then set Enabled to Yes.
Make the following selections to configure other store settings:
- 1.From the Magento Admin panel, select Stores, then select Conﬁguration.
- 2.In Configuration, select General, and then select Store Information. By default, your store address will be used as your ship from address for all transactions.
- 3.Select Sales, and then select Multishipping Settings. Then click No for Allow Shipping to Multiple Addresses.
The Digital River Global Commerce version 2.2.0 Extension for Adobe Commerce is responsible for providing the end tax calculation for the shopper navigating the checkout. The extension supports both tax-inclusive and tax-exclusive pricing models and handles all remittance and tax liabilities to local governments globally. The transactional tax is not calculated until after the shopper conﬁrms their billing and shipping address. Digital River does not support or allow the display of tax calculations that are not provided by Digital River. To ensure estimated tax and tax display is consistent throughout the pre-checkout pages, Digital River recommends the following conﬁgurations for tax, based on pricing models.
Note: Each Magento website or store should be tax-exclusive or tax-inclusive for all products and shipping. One store should not use both or a mixture of inclusive and exclusive pricing.
Note: The Digital River Extension for Magento cannot be used with other Magento tax partners.
To ensure the correct display of taxes in all situations, conﬁgure your Magento tax settings as follows:
- 1.Select Stores, select Conﬁguration, select Sales, and then click Tax.
- 2.In the Tax Classes section, update Tax Class for Shipping to Taxable Goods.
- 3.In the Shopping Cart Display Settings, keep the Display Full Tax Summary set to No.
To display tax exclusive values in your catalog, order summary, and checkout, configure your settings as follows:
- 1.Select Stores, select Conﬁguration, select Sales, select Tax, and then click Calculation Settings.
- 2.Verify Catalog Prices is set to
Excluding Tax—this is the default setting.
- 3.On the same Tax page, click to expand the Price Display Settings section, the Shopping Cart Display Settings section, and the Orders, Invoices, Credit Memos Display Settings section. In each section, verify the following are also conﬁgured for
Excluding Tax—these are the default settings.
- 4.All prices in the catalog must be exclusive of tax.
To display tax inclusive values in your catalog, order summary, and checkout, configure your settings as follows:
- 1.Select Stores, select Conﬁguration, select Sales, select Tax, and then click Calculation Settings.
- 2.Click the Catalog Prices dropdown list and change the setting to
- 3.On the same Tax page, click to expand the Price Display Settings section, the Shopping Cart Display Settings section, and the Orders, Invoices, Credit Memos Display Settings section. In each section, update the configuration to
Map all Magento Product SKUs to Digital River. You must share all your SKU values with Digital River for Digital River to conﬁgure the payment gateway.
The API call executed for syncing products with the Digital River SKU Service is a PUT request as follows:
https://api.digitalriver.com/skus/24-MB01. Because the SKU ID is part of the URL, SKU IDs must not contain spaces or special characters.
Note: SKU IDs should be limited to [a-zA-Z0-9.-:*_]
- 1.Select Catalog, then select Products.
- 2.Click Edit at the right end of the listed product you wish to edit to open a new page.
- 3.Scroll down to the Digital River section and click to expand the section.
Note: For each product, you must deﬁne the following values before launching a live storefront. These values will be imported into the Digital River SKU Service and the data will be used to ensure proper taxation.
From the dropdown list (which is searchable), choose the ECCN that applies to your product, which completes the Classification number and Digital River’s Description and Notes. Pay attention to the Notes, as they may contain important information relevant to your ECCN. If you do not find the ECCN applicable to your product, contact your Digital River account representative.
From the dropdown list, choose the Tax Group that applies to your product. The Tax Group selection will determine the Tax Type options. If you have questions, contact your Digital River account representative.
From the dropdown list, choose the Tax Type that applies to your product.
Country of Origin
Enter the HS Code that applies to your product. This field is only used if you are set up to provide landed costs to your shoppers. If you are interested in enabling landed costs, contact your Digital River account representative.
Note: Every product sold via the Digital River Extension for Magento will be considered Taxable Goods in the Magento production conﬁguration screen.
The catalog will sync according to your Catalog Sync Settings, however, you can also sync your catalog manually. Select Catalog, then click Catalog Sync Grid, and then click Manual Sync To Digital River.
Based on the response from Digital River the individual records in the
dr_sync_queuewill be updated as follows:
synced_to_dr_atwill be updated with the timestamp in the response field updatedTime.
- 2.The status will be updated to Success.
Response_datawill be updated with the response received back from Digital River.
synced_to_dr_atwill be updated with the timestamp in the response field updatedTime.
- 2.The status will be updated to Fail or Pending, depending on the error response code as listed below, and the Failure Response JSON node will be logged in the
response_datacolumn for tracking purposes.
- For the 500 error, the status will be left Pending so that the next time the scheduler starts it will try again to sync the data.
- For the 400 error, the status will be updated to Fail.
- 3.The merchant must update the product data based on the error response against that queue row. When the merchant updates the data from Admin, the product will again get added in the queue with the status Pending and will get synched to Digital River.
- 4.If there is a failure during the sync, even for a single record, then take note at the end of the sync process and try one of these adjustments, depending on the cause of failure:
- Update the product to resolve the error.
- Retry the sync.
Landed costs represent the entire cost a customer must pay to purchase a product from one country and have it shipped to an address in another country. It includes product price, shipping, taxes, duties, and fees. Digital River provides an estimated landed cost for you to display to the customer and adds the cost to the order total. Digital River remits those landed costs to you. Your fulfiller relays the order to your carrier, who completes the customs paperwork, ships the package to the destination country, pays the duties and taxes on behalf of your customer, and invoices you for performing the service.
To take advantage of the landed cost feature, you'll need to complete the following steps:
- 1.Verify your fulfiller ships packages outside their country (not all fulfillers provide this service).
- 2.Verify your carrier offers this service. In other words, does the carrier prepay the landed costs on behalf of the customer and send the invoice to you.
- 3.Sign an addendum in your Digital River contract to enable landed costs.
- 4.Specify the
hsCodeparameter, which represents the Harmonized System code, when creating new SKUs or performing update or upsert operations on the SKUs in your catalog.
- 5.Define the cross-border patterns (that is, the ship-to countries) where you want to collect landed costs.
- 6.Provide samples of completed customs forms to Digital River's Compliance department for approval.
- 7.Provide your Account Manager with a list of the ship from and ship to countries for which you want to enable the collection of landed costs.
- 8.Once the feature is configured and set up, we calculate, collect, and apply landed costs to orders that contain physical goods and are shipped across borders to approved countries.
Note: To prevent double taxation, all of your Tax and Display settings must be set to Excluding Tax.
The Digital River Extension for Magento is conﬁgurable by the website in the Magento Admin Panel interface. This enables administrators to offer different payment methods and different currencies to different regions.
The only ﬁeld that changes is the Base Conﬁguration locale ﬁeld. Digital River will provide the locale needed to meet your language, payment, and currency requirements. Payments are also conﬁgurable via Drop-in by the website.
All content displayed via the Digital River Extension can be modiﬁed by adding an
/i18ndirectory to the DrPay folder. By default the extension supports the following languages: [en, es, it, fr, sv, da, ﬁ, cs, pl, hu, de, nl, pt, nl, fr]
After translation ﬁles are added or updated, rerun the upgrade command:
$ php bin/magento setup:upgrade
To ensure translated text is reﬂected on the Magento website or store view, it is important to update the locale option for that website or store view via the general Magento settings: Select Stores, then Conﬁguration, then General, and then click Locale Options.
Digital River's extension adds two columns to the Sales Orders grid: DR Order ID and DR Payment Method. To access the Sales Orders grid, select Sales, and then select Orders using the Columns dropdown.
Sales Orders Grid
DR Order ID
Lists the primary order identification number in Digital River’s systems. Note: The Magento Commerce ID is a secondary ID in Digital River’s systems.
DR Payment Method
Replaces the standard Payment Method column. One or both can be used, however, the Payment Method column will always display DigitalRiver Payments, where the DR Payment Method will display the actual payment method used on the transaction.
At this time, payment methods can only be saved to a shopper’s account during checkout. The shopper can choose to save the payment method by clicking the box named Yes, please save this account and payment information for future purchases. The saved payment method will not appear in the shopper's My Account pages. This functionality will be added in a future release.
Customers can now use Magento Store Credit to pay for all or part of an order processed by Digital River. Store Credit can be used in combination with multiple payment methods.
For orders paid with a combination of Store Credit and one of the other supported payment methods, the DR Payment Method will be listed as the non-Store Credit payment instrument (for example, PayPal). For orders paid entirely with Store Credit, the DR Payment Method will be CustomerCredit.
Orders paid partially or entirely with Store Credit can be refunded through the normal Magento admin screens.
If a transaction was paid partially with Store Credit and partially with another payment method, Digital River will always refund the payment method first.
Note: Digital River will never refund more to any payment method than was originally paid using that payment method on the original purchase.
When an order has been paid without Store Credit on the initial transaction, refunding to the shopper’s store credit account must be done in accordance with Digital River’s Guidelines and Best Practices.
Due to how Digital River processes refunds, the Refund to Store Credit function has been removed from the Magento Credit Memo page.
The Magento Credit Memo page has been modified to only allow refunds to the original payment methods used on the original purchase.
Store Credit can still be returned to the shopper’s account by adding it directly to their account from the Customer’s Admin page in the Magento Admin UI.
Customers can now use one or more Magento Gift Cards to pay for all or part of an order processed by Digital River. Gift Cards can be used in combination with multiple payment methods.
With Store Credit, orders paid with a combination of Gift Card and one of the other supported payment methods, the DR Payment Method will be listed as the non-Gift Card payment instrument (for example, PayPal). For orders paid entirely with a Gift Card, the DR Payment Method will be CustomerCredit.
Orders paid partially or entirely with Gift Cards can be refunded through the normal Magento admin screens.
If a transaction was paid partially with one or more Gift Cards and partially with another payment method, Digital River will always refund to the other payment method first until that payment method has been refunded the entire amount paid using that payment method on the original purchase. Digital River will then refund any additional amounts to the Gift Card, up to the amount paid with a Gift Card on the original purchase.
Note: Digital River will never refund more to any payment instrument than what was originally paid using that payment instrument on the original purchase.
The Digital River Extension allows shoppers to enter their Tax Identification Number during order placement, have the ID validated, and, if appropriate, the order totals will be updated accordingly.
The shopper must:
- 1.Check the This is a Business Purchase box on the Shipping Address screen, when purchasing physical goods, or on the Payment Information screen when purchasing digital or virtual goods.
- 2.Enter the Tax ID and click Apply.
Shoppers are able to find and download a PDF of their official VAT Invoices and Credit Memos in their My Account screen, for authenticated shoppers, or their Order Lookup screen, for guest shoppers. As Digital River is the MOR/SOR, the official invoices must come from Digital River. To that end, the links on the Invoice and Credit Memo screens replace the standard Magento Invoice and Credit Memo display.
Note: It can take up to an hour after orders have been completed or credit memos given for the links to appear on these pages.
Last modified 9mo ago