System Status

DigitalRiver object

Learn how to use the DigitalRiver object

Creating a DigitalRiver object

For details, refer to the Initializing DigitalRiver.js page.

let digitalRiver = new DigitalRiver("pk_test_fh9861t8b7384b7dke9e8dn4fb79808192", {
     "locale": "nl"
});

Creating an instance of Drop-in

createDropin(config)

Use createDropin(config) to create an instance of Drop-in payments. For details, refer to the Drop-in payments integration guide.

Creating elements

createElement(element, config)

Use this method to create an instance of an Element that you can use to capture payment details. You can use the following Elements with createSource() to create a payment source.

Element Type
Description

amazonPay

AmazonPay element

applepay

Apple Pay element

cardCVV

A card security code field

cardExpiration

A credit card expiration field

cardNumber

A credit card number field

googlepay

Google Pay element

iban

IBAN element

ideal

iDEAL element

konbini

A Konbini element

onlineBanking

An online banking element

offlineRefund

An offline refund data collection element

paypal

A PayPal element

Options

Heading
State
Default Class

classes

base

DRElement

classes

complete

DRElement--complete

classes

empty

DRElement--empty

classes

focus

DRElement--focus

classes

invalid

DRElement--invalid

classes

autofilled

DRElement--autofilled

Creating a payment request

For details, refer to the Payment request object in the Digital River payment objects article.

Creating sources

When creating sources, you can select a method that accepts an element or use a method that doesn't require an element. Both methods, however, require that you provide source data to tokenize. When configuring this data, you can specify a future source use.

For both versions, the createSource() method returns a promise that contains a Result object. The Result object, in turn, contains one of two possible objects:‌

  • source — A Source object created by Digital River.

  • error — An error object that indicates a problem with the tokenization request. It provides the data you must correct before creating a source again.

createSource(sourceData)

Use the createSource(sourceData) method to create a payment source that contains information you can safely use with other Digital River APIs. This includes immediate sources (if PCI compliant), redirect sources, or delayed sources. See Configuring payment methods for more information on the structure of these requests.‌

In the following example, the method takes a single argument. The sourceData contains the data that you want Digital River to tokenize.

A successful response returns a source with a unique id.

An unsuccessful response returns an error with information on what must be corrected.

createSource(element, sourceData)

Use the createSource(element, sourceData) method to create a tokenized source to safely transmit to the backend for use in downstream API calls. This method requests two parameters:‌

  • element — A Element object created using the Elements portion of this library.

  • sourceData — The source data that you want Digital River to tokenize. See Common payment sources for more information on the required source data.

The method uses source data and an element argument in the following example.

A successful response returns a source with a unique id.

An unsuccessful response returns an error with information on what must be corrected.

Specifying a source's future use

When creating a source using DigitalRiver.js, you should identify the types of transactions it will likely use in the future. This increases the probability that these future transactions will be approved. The usage value you select should be the one that most closely corresponds to our business model. The available options are subscription, convenience, and unscheduled.

Subscription

Set usage to subscription when you create sources primarily for recurring transactions made at regular intervals for a product or a service.

Convenience

The convenience setting applies mainly to saved payment sources used for one-off transactions. These are sources where customers are typically present during the checkout flow and want to access their payment information quickly. Select this option if you don't offer subscriptions or don't have unscheduled merchant-initiated transactions.

Unscheduled

Set usage to unscheduled when you create sources for unscheduled merchant-initiated transactions. These are contracts that occur on a non-fixed schedule using stored card information. Automatic top-ups are an example of one such transaction. They occur whenever a customer's balance drops below a pre-defined amount.

Retrieving sources

retrieveSource(sourceId, sourceClientSecret)

Use this method to retrieve a source with the front-end DigitalRiver.js library. This method takes two parameters:‌

  • sourceId—The unique ID of the source you want to retrieve.

  • sourceClientSecret—The clientSecret value of the source you are trying to retrieve. This is specific to the source.

The digitalriver.createSource() returns a Promise with a Result object. (See the following source response example.) The Result object will have either:‌

  • result.source—If this object is not null, it will contain the Source object you requested.

  • result.error— If this object is not null, it will contain an Error object with details on the specific error.

Authenticating sources

The authenticate source method determines whether a saved payment source, selected by a customer during checkout, requires Strong Customer Authentication (SCA).

The first version of the method accepts a required configuration object that contains the data we need to authenticate the source. The second version requires this same data plus a CVV Element.

Parameter
Required/Optional
Description

sessionId

Required

The payment session identifier of this transaction.

sourceId

Required

The identifier of the payment source selected by the customer.

sourceClientSecret

Required

The source's client secret.

returnUrl

Required

The return URL where the customer is directed when 3D Secure 1 is required. If the value is not provided, we use the current page location.

Do not log, embed in URLs, or expose the sourceClientSecret to anyone other than the customer. On any page that includes the secret, ensure that TLS is enabled.

After you call either version, Digital River automatically handles any SCA requirements. Once the customer completes the necessary authentication or we determine that authentication isn't required, the method resolves, and the checkout flow can continue.

The method returns a source authentication result object with a promise. The following are its possible status values and the recommended actions:

status
Description

complete

The customer successfully completed the steps necessary to authenticate the source. You can now submit the order.

authentication_not_required

Digital River determined that the payment source didn't require authentication for this payment session. You can now submit the order.

failed

Source authentication failed. The source can still be used in the transaction but may be declined. You should attempt to authenticate the source again.

authenticateSource(data)

Call this method to authenticate a payment source before applying it to a transaction.

The following is an example response when it's determined that authentication isn't required:

authenticateSource([cvvElement], data)

In this alternative authenticate source method, you can provide an optional CVV Element (assuming it is correctly created and mounted). By setting this parameter, the value contained in the field of the CVV Element is included in the authentication request.

The following is an example response when a source is successfully authenticated:

Updating sources

updateSource([element,] sourceData)

Use this method to update details on a source.

When updating a source, you can only update the owner and the expiration details for Credit Cards. If you need to update a non-Credit Card (creditCard) payment type, use createSource.

This method takes two parameters:‌

  • element—An optional card expiration element for using the Elements portion of this library.

  • sourceData—A required data object containing additional data required to update the payment source.

Field
Required
Type
Description

clientSecret

Required

String

The Client Secret of the source you are updating.

id

Required

String

The ID of the source you are updating.

owner

Optional

An Owner Object

An object containing the Owner details. Note: You can only update the owner information for Credit Cards.

digitalriver.updateSource() returns a Promise that returns a result object. The result object will have either:‌

  • result.source—A source object that was updated in the Payments Service

  • result.error—An error occurred that must be corrected to update the source.

Updating expiration and address information

Updating only address information

Updating only card expiration information

Update error‌

If there is a problem with the update request, an error object will be returned in the response.

Retrieving available payment methods

retrieveAvailablePaymentMethods([filters])

Use this method to retrieve an array of available payment methods. You can use this to filter and determine applicable payment methods while building your checkout flows. The filters object is optional.

Attribute
Required/Optional
Description

currency

Optional

The currency of the transaction.

country

Optional

The country of the billing addresses associated with this transaction.

supportsStorage

Optional

Whether the payment supports storage.

supportsRecurring

Optional

Whether the payment method supports recurring payments.

supportsFreeTrial

Optional

Whether the payment method supports free trials.

sessionId

Optional

The Payment Session ID. If used, the response will return the payment methods which apply to your transaction.

Retrieve available payment methods response without using session ID

The following example shows a request with no filters applied.

The following response includes all payment methods that you configured for your account.

Retrieve available payment methods response using filters

The following example shows a request using filters.

The following response only returns payment methods available in the US, using the USD currency and supporting recurring payments.

Retrieve available payment methods response with a Session ID

If you specify a Payment Session ID, you will only receive the payment methods that apply to your transaction.

Credit card logos

If you want to display the credit card payment logo on your website, you can use the following URLs to add the appropriate brand logo image to your website:

Best Practices: To ensure you always use the latest logo, link to the URL instead of downloading the image to your website.

Retrieving available banks for Online Banking

retrieveOnlineBankingBanks(countryCode, currency)

Use this method to retrieve an array of available banks for a combination of ISO 3166-1 alpha-2 country code and ISO 4217 currency code.‌

This method returns an array that will either be empty if no banks are available or contain objects with Issuer IDs and Bank Names. DigitalRiver.js uses this data when creating an Online Banking source. This method is useful if you want to build a bank selector instead of using the Online Banking element.

Getting compliance details

The DigitalRiver object exposes Compliance.getDetails(), which returns various disclosures, such as terms of sale, privacy policies, save payment agreements, and cancellation rights, that you can use to ensure sales adhere to compliance requirements.

Compliance.getDetails()

Compliance.getDetails() accepts a configuration object, which consists of a language, country, and businessEntityCode, all of which are required. This increases the probability that Digital River can return appropriately translated disclosures that apply to the customer’s shopping country and the transaction’s selling entity.

language

A required string that determines the language each disclosure is translated into. The value you assign this property doesn't affect which specific disclosures are returned, only how their text is rendered.

For a list of accepted values, refer to Supported languages.

country

A required string, formatted as an ISO 3166-1 alpha-2 code, represents the customer's shopping country. Since legal requirements vary slightly from country to country, the value you assign to this property determines which specific disclosures Digital River returns. For example, some country values return a customer's cancellation rights, while others do not.

If the transaction involves physical products, country should ideally be the same as the customer’s ship to country. If customers only purchase digital products, you can use their billing country.

businessEntityCode

A required string that represents the transaction's designated selling entity. Similar to country, this affects which disclosures Digital River returns.

In checkouts, you can find this value in sellingEntity.id.

For a list of accepted values, refer to Supported selling entities.

Compliance.getDetails() response

Compliance.getDetails() returns a disclosure which contains individual disclosures, such as termsOfSale and privacyPolicy, that you can display to customers. However, Digital River returns an error if the function's parameters are missing or unsupported.

disclosure

In most cases, the nested objects in disclosure contain localizedText and the url of a Digital River-hosted document.

In the following disclosure, the text is rendered in English, and the content applies to customers purchasing in Germany facilitated by the Digital River Ireland Ltd. selling entity.

Error

If language, country, or businessEntityCode are not defined or are assigned an unsupported value, then Compliance.getDetails() returns a console error.

PreviousInitializing DigitalRiver.jsNextElements

Last updated