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
  • 2020/12/30
  • 2020/12/28
  • 2020/12/17
  • 2020/12/10
  • 2020/11/19
  • 2020/11/17
  • 2020/11/10
  • 2020/11/5
  • 2020/10/13
  • 2020/10/12
  • 2020/10/6
  • 2020/10/1
  • 2020/09/30
  • 2020/9/24
  • 2020/9/23
  • 2020/9/18
  • 2020/9/16
  • 2020/9/9
  • 2020/8/20
  • 2020/8/11
  • 2020/8/5
  • 2020/6/16
  • 2020/6/3
  • 2020/5/26
  • 2020/5/19
  • 2020/5/5
  • 2020/4/21
  • 2020/4/7
  • 2020/3/31
  • 2020/3/24
  • 2020/3/20
  • 2020/3/19
  • 2020/3/17
  • 2020/3/10
  • 2020/2/14
  • 2020/1/31
  • 2020/1/28
  • 2020/1/15
  • 2020/01/07
  1. General Resources
  2. Release notes

2020

Digital River API release notes for 2020.

Previous2021Next2019

Last updated 2 months ago

2020/12/30

  • We now offer a to help you integrate the Digital River API into your commerce application. Before building your integration, we recommend reviewing our . You'll find information on the , our , and the available .

  • You can now to non-recurring transactions. Store credit allows merchants to offer customers a store credit as a payment type at checkout.

2020/12/28

We updated 's to show the minimum and maximum order amount and the payment method type.

2020/12/17

Breaking changes

We made the following changes in the 2020-12-17:

  • You can no longer set the visible boolean parameter in a or request. By default, all to customers.

  • taxes are no longer included in the totalTax of an order. They are now returned in .

  • We now return several attributes at the and representing the on an order. We now also provide the ability to .

  • We now return .

  • We added the best practices for using the Digital River API, which includes , , , , and .

  • We made the following changes to the :

    • You can apply a different to each individual key (and ), or you can simultaneously in the current mode (test or production).

    • You can now .

    • Changed the Orders section to .

    • Changed the All orders topic to .

    • The now displays the item discount, purchase amount, and payment and billing details.

    • Added to the section.

2020/12/10

2020/11/19

2020/11/17

2020/11/10

2020/11/5

2020/10/13

2020/10/12

2020/10/6

2020/10/1

2020/09/30

Breaking change

    • startTime

    • endTime

2020/9/24

2020/9/23

2020/9/18

2020/9/16

  • POST and GET Checkout requests now return a unique item-level identifier.

2020/9/9

2020/8/20

2020/8/11

2020/8/5

2020/6/16

  • You can now create checkouts and orders containing duplicate SKU items with different prices and metadata.

  • You can now only request refunds for amounts or percentages less than or equal to those available to refund on an order, order item, invoice, or invoice item.

  • We can not use any tax identifiers you pass us on the checkout, rather than any tax identifiers associated with the customer.

  • You can now retry failed order refunds by requesting a new refund when a refund fails.

  • You can now only request refunds for amounts or percentages less than, or equal to, those available to refund on an order or order item.

  • We now automatically retry any failed order charge captures for up to 30 days with exponential backoff.

2020/6/3

2020/5/26

2020/5/19

  • You can now create Checkouts and Orders with a division parameter. The division parameter allows customers to provide their division within an organization when they provide their business addresses in Japan.

2020/5/5

  • We will inform you if a tax identifier is required and is missing for customers with multiple tax identifiers and apply those tax identifiers to the order.

2020/4/21

  • You can now create Checkout items with a new freeTrial parameter.

  • You can now receive order.charge.cancel.pending and order.charge.cancel.pending information, and order.charge.cancel.failed and order.charge.cancel.complete events and webhooks.

2020/4/7

  • You can now create Checkout items with an aggregatePrice parameter that represents the aggregate (or quantity) price of that line item.

  • You can now receive an order.chargeback webhook when a chargeback occurs for an order.

  • We made it easier to see if an Order has been fulfilled and its charge has been captured by adding a complete state to the state enumeration.

2020/3/31

  • We now create refunds in a pending state and publish a refund.pending event. We removed the refund.created event.

2020/3/24

  • Checkout sourceId now uses the default source identifier of the customer.

  • We will return tax rates as simple amounts rather than percentages (0.067, not 6.75).

  • You can now receive order.charge.capture.pending, order.charge.refund.pending, order.charge.refund.complete, and refund.complete event webhooks. We no longer support the order.charge.capture.created, order.charge.refund.created, order.charge.refund.completed, and refund.completed webhooks.

  • Renamed order.charge.created to order.charge.pending and order.charge.capture.completed to order.charge.capture.complete.

2020/3/20

In live mode, we will attempt to deliver your webhooks for up to three days with an exponential backoff; in test mode, we will retry four times over a couple of hours.

2020/3/19

2020/3/17

  • You can now retrieve a source with the new clientSecret attribute.

2020/3/10

We have changed item-level amounts to represent the amount to pay for an item, including any item-level discounts.

2020/2/14

You can now create Checkouts with shippingChoice parameters with zero-dollar amounts.

2020/1/31

  • Orders now have a cancelledAmount attribute, which represents the total charge amount cancelled.

2020/1/28

We made it easier to refund items by not requiring you to specify a refund quantity unless you want it to differ from the ordered quantity.

2020/1/15

  • You can now create an Order without creating a Checkout by passing a Checkout request rather than a reference to an existing Checkout at order creation.

  • We have now added a sellingEntity attribute to checkouts and orders that you can use to display Digital River's Terms & Conditions and policies to your customers.

  • Digital River now validates the following addresses:

    • Checkout and Customer shipTo and shipping addresses

    • Source owner addresses

    This ensures the customer provides all address parameters required to successfully ship physical goods anywhere in the world, create a payment charge, comply with local invoicing regulations, and accurately calculate local taxes.

  • Improved availability returns.

  • When you create an order, We will return standardized card decline codes, and the card networks will decline the charges.

  • We have now added price and aggregatePrice attributes to checkouts and orders.

2020/01/07

Breaking change

We added more for in .

We added support for to the payment method.

When you , we now associated with that SKU.

We added information on where you can find for DigitalRiver.js.

As part of the initiative, payment processors require extra information when processing credit card transactions. To ensure that you adhere to the new mandate, you can now use .

The now supports packaging and battery . Additionally, the attributes that were previously represented as metadata have been deprecated. These data points are now first-class attributes.

We added information on the to .

When , we now use the you specify in the SKU.

We added support for Union Pay to .

For 2020-09-30, we added the . You can use it to when billing a customer, charging a customer for a recurring event, or providing information in response to a fulfillment.

We added support for to .

We added information on to .

We added the following parameters to the subscriptonInfo block in and .

Added new features to the that allow you to:

of Digital River API

for your user account

We added support for the payment method.

We added support for the payment method.

We updated the documentation.

You can now update the ship from and subscription information at the item-level in requests.

Updated the documentation.

We added Spark from Tryzens for the Salesforce Commerce Cloud to our .

You can now without upgrading the key.

We added the resource to help you determine whether address and tax identifier information is required and also whether it is properly formatted.

You can now use the in the Address object to support ZIP+4 codes.

You can now create multiple Customer objects with the .

We added the linkExpiresTime parameter to the resource.

You can now access the .

You can now use to retrieve an array of .

You can now use to trigger a when a customer presses the Return key while the input field has focus.

Creating multiple tax identifiers of the same type for or is no longer possible.

We made it easier to see the amounts available to refund for an order by adding availableToRefundAmount attributes to .

You can now receive an order.charge.complete when an order charge has been captured.

You can now receive an order.charge.pending when an order charge has been created but not yet processed.

You can now receive an order.charge.processing when an order charge is processed.

You can now receive an order.charge.cancelled when Digital River cancels an order charge.

You can now receive order.charge.capture.complete when an order charge capture is complete for all payment methods (including PayPal and SEPA Direct Debit).

You can now search for using the following filters: submitted timestamp, accepted timestamp, complete timestamp, browserIp, chargeType, subscriptionId, and refundedAmount.

You can now create and with a phoneticName parameter. The phoneticName parameter allows customer service representatives and couriers who need this information to pronounce a customer's name correctly in Japan. See for more information.

You can now with description, image, and url parameters to power a first-class user experience.

You can now create Refunds for (such as Wire Transfer and bPay) that require the handling of additional customer information.

You can now receive an order.accepted when an order successfully passes Digital River's fraud checks and has a capturable charge.

You can now create with .

We made it easier to see the amounts available to refund for an order by adding the availableToRefund amount attribute to .

You can now receive a sales_transaction.created as soon as we create a (costed) sales transaction.

We extended the endpoint so you can determine if an order item was for a subscription renewal.

You now have the option for Digital River to calculate the of your cross-border orders for you in the dutiesTotal attribute.

We now create event for all events supported in production in test mode.

With the new , , , and API resources, you can now view detailed information about your costed sales and Digital River's payouts.

We extended and to return a tax.amount for shipping choices.

You can now sync your SKU records with Digital River more easily by using the resource.

We extended the supported list of to include territories such as Guam (GU).

You can now receive an order.charge.refund.failed when a charge refund attempt fails for your customer's order.

You can now create Checkouts with an aggregatePrice parameter that represents the for a quantity of SKUs rather than their unit price.

now have a capturedAmount attribute, which represents the total charge amount captured.

You can now provide an applicationId parameter when you . You can use this attribute to segment your orders by application source.

You can now specify the ship from country or address in the with the new shipFrom parameter.

2020-01-07 is the base version of the Digital River API.

tax identifier element
DigitalRiver.js
Credit Cards
PSD2 and SCA
Payment integrations
payment sessions
Payment integrations
Digital River Dashboard
Update to or rollback from the latest version
Enabling two-factor authentication
Korea – PayCo
Klarna
Drop-in
Connectors
Country-Specs
Digital River Dashboard documentation
webhook
webhook
webhook
webhook
webhook
delayed repayment methods
webhook
webhook
landed costs
webhooks
Checkouts
Orders
webhook
Checkout
PHP SDK
standards and certifications
certification process
compliance requirements
integration checklists
apply store credit
Klarna
Landed cost
landed cost
Digital River Dashboard
restricted keys
update the version on all keys
rotate a webhook's secret
Order management
Orders
Order details page
Checkouts
Order management
DigitalRiver.js
delete a SKU
PSD2 Strong Customer Authentication (SCA)
DigitalRiver.js
DigitalRiver.js
delete any Fee objects
fees are now visible
supported geographies
fee types
standard
error codes
fee details at the item level
custom styles
styling an element container
return event
Pay in 4
PayPal
merchant-initiated
totalImporterTax
order
item levels
Digital River App for Salesforce B2B Commerce
Create a test account
billing agreements
classifying a product as digital or physical
tax code
create SKUs
refund importer taxes
upserting SKUs
postalCode parameter
same email address
valid US states
Japanese phonetics and divisions
available payment methods
test a single API request
Version
version
API keys
versioning
versioning and API keys
robustness
fraud detection
API version
version
create
update a fee
Fees API
invoices resource
create an invoice
Checkouts
Orders
update checkout
files
Customers
Checkouts
Orders
Orders
Checkouts
Orders
Orders
Orders
Payouts
Payout transactions
Sales summaries
Sales transactions
SKUs
Orders
aggregate price
Checkouts
create a checkout
tax-inclusive shipping choice amounts