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.
<divid="card-number"class="DRElement"> <!-- The embedded Element iframe --> <iframesrc="cardnumber.html"></iframe></div><divid="card-number"class="DRElement--complete"> <!-- The embedded Element iframe --> <iframesrc="cardnumber.html"></iframe></div><divid="card-number"class="DRElement--empty"> <!-- The embedded Element iframe --> <iframesrc="cardnumber.html"></iframe></div><divid="card-number"class="DRElement--focus"> <!-- The embedded Element iframe --> <iframesrc="cardnumber.html"></iframe></div><divid="card-number"class="DRElement--invalid"> <!-- The embedded Element iframe --> <iframesrc="cardnumber.html"></iframe></div><divid="card-number"class="DRElement--autofilled"> <!-- The embedded Element iframe --> <iframesrc="cardnumber.html"></iframe></div>
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.
var sourceData = {"type":"creditCard","owner": {"firstName":"firstName","lastName":"lastName","email":"email@email.org","address": {"line1":"1234 First St.","city":"Minnetonka","state":"MN","country":"US","postalCode":55410 } },"creditCard": {"number":"4444333322221111","expirationMonth":12,"expirationYear":2025,"cvv":"123" } }digitalriver.createSource(sourceData).then(function(result) {if(result.error) {//handle error messagevar errorMessage =result.error.errors[0].message; } else {//send source to back end for processingvar source =result.source; }});
A successful response returns a source with a unique id.
An unsuccessful response returns an error with information on what must be corrected.
{"error": {"type":"bad_request","errors": [{"code":"invalid_parameter","parameter":"owner.firstName","message":"'' is not a valid owner.firstname." }, {"code":"currency_unsupported","parameter":"currency","message":"currency 'xyz' is not supported." }] }, source:undefined}
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.
var sourceData = {"type":"creditCard","owner": {"firstName":"firstName","lastName":"lastName","email":"email@email.org","address": {"line1":"1234 First St.","city":"Minnetonka","state":"MN","country":"US","postalCode":55410 } } }digitalriver.createSource(cardNumber, sourceData).then(function(result) {if(result.error) {//handle error messagesvar errorMessage =result.error.errors[0].message; } else {//send source to back end for processingvar source =result.source; }});
A successful response returns a source with a unique id.
An unsuccessful response returns an error with information on what must be corrected.
{"error": {"type":"validation_error","errors": [{"code":"incomplete_card_number","message":"Your card number is incomplete." }] }, source:undefined}
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.
digitalriver.retrieveSource("ee90c07c-5549-4a6b-aa5f-aabe29b1e97a","ee90c07c-5549-4a6b-aa5f-aabe29b1e97a_51afe818-0e7f-46d7-8257-b209b20f4d8").then(function(result) {if(result.error) {//handle error messagesvar errorMessage =result.error.errors[0].message; } else {//do something with the sourcevar source =result.source; }});
The authenticate source method determines whether a saved payment source, selected by a customer during a 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.
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.
The following is an example response when its determined that authentication isn't required:
{"status": "authentication_not_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:
{"status": "complete"}
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
//Create the element using DigitalRiver.js and place it on the page.var options = { style: { base: { color:"#fff", fontFamily:"Arial, Helvetica, sans-serif", fontSize:"20px", fontSmoothing:"auto", fontStyle:"italic", fontVariant:"normal", letterSpacing:"3px" }...}var cardExpiration =digitalriver.createElement('cardexpiration', options);cardExpiration.mount('card-expiration');var sourceData = {"id":"14381d1c-8bff-4350-aeea-82b36f3a196c","clientSecret":"14381d1c-8bff-4350-aeea-82b36f3a196c_14381d1c-8bff-4350-aeea-82b36f3a196c","owner": {"firstName":"firstName","lastName":"lastName","email":"email@email.org","address": {"line1":"1234 First St.","city":"Minnetonka","state":"MN","country":"US","postalCode":55410 } } }digitalriver.updateSource(cardExpiration, sourceData).then(function(result) {if(result.error) {//handle error messagesvar errorMessage =result.error.errors[0].message; } else {//the source has been updated with new detailsvar source =result.source; }});
var sourceData = {"id":"14381d1c-8bff-4350-aeea-82b36f3a196c","clientSecret":"14381d1c-8bff-4350-aeea-82b36f3a196c_14381d1c-8bff-4350-aeea-82b36f3a196c","owner": {"firstName":"firstName","lastName":"lastName","email":"email@email.org","address": {"line1":"1234 First St.","city":"Minnetonka","state":"MN","country":"US","postalCode":55410 } } }digitalriver.updateSource(sourceData).then(function(result) {if(result.error) {//handle error messagesvar errorMessage =result.error.errors[0].message; } else {//the source has been updated with new detailsvar source =result.source; }});
//Create the element using DigitalRiver.js and place it on the page.var options = { style: { base: { color:"#fff", fontFamily:"Arial, Helvetica, sans-serif", fontSize:"20px", fontSmoothing:"auto", fontStyle:"italic", fontVariant:"normal", letterSpacing:"3px" }...}var cardExpiration =digitalriver.createElement('cardexpiration', options);cardExpiration.mount('card-expiration');var sourceData = {"id":"14381d1c-8bff-4350-aeea-82b36f3a196c","clientSecret":"14381d1c-8bff-4350-aeea-82b36f3a196c_14381d1c-8bff-4350-aeea-82b36f3a196c" }digitalriver.updateSource(cardExpiration, sourceData).then(function(result) {if(result.error) {//handle error messagesvar errorMessage =result.error.errors[0].message; } else {//the source has been updated with new detailsvar source =result.source; }});
If there is a problem with the update request, an error object will be returned in the response.
{"error": {"type":"validation_error","errors": [{"code":"incomplete_card_number","message":"Your card number is incomplete." }] },
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.
digitalriver.retrieveAvailablePaymentMethods().then(function(result) {//do something with the result, this could include showing or hiding specific payment methods that are applicable to the display});
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.
digitalriver.retrieveAvailablePaymentMethods({"currency":"USD","country":"US","supportsRecurring":true}).then(function(result) {//do something with the result, this could include showing or hiding specific payment methods that are applicable to the display});
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 which apply to your transaction.
digitalriver.retrieveAvailablePaymentMethods({"sessionId":"d3941a36-6821-4d93-be23-6190226ae5f7"}).then(function(result) {//do something with the result, this could include showing or hiding specific payment methods that are applicable to the display});
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 will 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.
digitalriver.retrieveOnlineBankingBanks("DE","EUR").then(function(result) {//do something with the banks, this could include building a selector or something else});
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.
let config = {'language':'en','country':'DE','businessEntityCode':'DR_IRELAND-ENTITY' };var complianceDetails =digitalRiver.Compliance.getDetails(config);
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.
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 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, then 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.
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 making a purchase in Germany that is facilitated by the Digital River Ireland Ltd. selling entity.
{"businessEntity": {"name":"Digital River Ireland Ltd.","id":"DR_IRELAND-ENTITY" },"autorenewalPlanTerms": { "localizedText": "By checking the box below and completing your purchase, you expressly authorize and permit Digital River to automatically renew your purchased license or subscription for successive renewal terms each equal in length to the initial term specified above, at the purchase price for your initial term (plus taxes and fees, less any applicable discounts) using the payment information you provided for your initial purchase, until you cancel. At least one email will be sent to you to remind you of each upcoming renewal. We may change the renewal price as of the next renewal date if we provide you with prior notice of the change by email (you can elect to cancel automatic renewal as described below if you do not agree to the change). The Digital River <a href=\"https://store.digitalriver.com/store/defaults/de_DE/DisplayDRTermsAndConditionsPage/eCommerceProvider.Digital%20River%20Ireland%20Ltd.\" target=\"_blank\" class=\"dr_termsAndConditions\">Terms of Sale</a> and <a href=\"https://store.digitalriver.com/store/defaults/de_DE/DisplayDRPrivacyPolicyPage/eCommerceProvider.Digital%20River%20Ireland%20Ltd.\" target=\"_blank\" class=\"dr_privacyPolicy\">Privacy Policy</a> will apply to each renewal transaction. You may cancel your auto-renewal plan at any time by logging into the account interface (access information will be included in your order confirmation email or on the Customer Service Help page), selecting your product, and selecting the option to disable automatic renewal.<br/><br/>I agree that Digital River may store my payment information for future purchases including the processing of any subsequent subscription renewals which may occur following the date of this order."
},"saveCardMandate": {"localizedText":"Yes, please save this account and payment information for future purchases." },"idealRecurringAgreement": { "localizedText": "By clicking the box, you authorize Digital River to collect your first payment via iDEAL and use your IBAN to collect the subsequent subscription payments by SEPA direct debit. You can review your SEPA Direct Debit information after order submission. <br/><br/>As part of your rights, you are entitled to a refund from your bank under the terms and conditions of your agreement with your bank. A refund must be claimed within 8 weeks starting from the date on which your account was debited. "
},"confirmDisclosure": { "localizedText": "By submitting my order, I agree to the <a href=\"https://store.digitalriver.com/store/defaults/en_IE/DisplayDRTermsAndConditionsPage/eCommerceProvider.Digital%20River%20Ireland%20Ltd.\" target=\"_blank\" class=\"dr_termsAndConditions\">Terms of Sale</a> and the <a href=\"https://store.digitalriver.com/store/defaults/en_IE/DisplayDRPrivacyPolicyPage/eCommerceProvider.Digital%20River%20Ireland%20Ltd.\" target=\"_blank\" class=\"dr_privacyPolicy\">Privacy Policy</a> of Digital River Ireland Ltd."
},"privacyPolicy": {"localizedText":"Privacy Policy","url":"https://store.digitalriver.com/store/defaults/en_IE/DisplayDRPrivacyPolicyPage/eCommerceProvider.Digital%20River%20Ireland%20Ltd." },"termsOfSale": {"localizedText":"Terms of Sale","url":"https://store.digitalriver.com/store/defaults/en_IE/DisplayDRTermsAndConditionsPage/eCommerceProvider.Digital%20River%20Ireland%20Ltd." },"cookiePolicy": {"localizedText":"Cookies","url":"https://store.digitalriver.com/store/defaults/en_IE/DisplayDRCookiesPolicyPage/eCommerceProvider.Digital%20River%20Ireland%20Ltd." },"legalNotice": {"localizedText":"Legal Notice","url":"https://store.digitalriver.com/store/defaults/en_IE/DisplayDRContactInformationPage/eCommerceProvider.Digital%20River%20Ireland%20Ltd." },"cancellationRights": {"localizedText":"Cancellation Right","url":"https://store.digitalriver.com/store/defaults/en_IE/DisplayDRTermsAndConditionsPage/eCommerceProvider.Digital%20River%20Ireland%20Ltd.#cancellationRight" },"resellerDisclosure": {"localizedText":"<a href=\"https://store.digitalriver.com/store/defaults/en_IE/DisplayDRAboutDigitalRiverPage/eCommerceProvider.Digital%20River%20Ireland%20Ltd.\" target=\"_blank\" class=\"dr_resellerDisclosure\">Digital River Ireland Ltd.</a> is the authorised retailer and merchant providing e-commerce services for this shop.","url":"https://store.digitalriver.com/store/defaults/en_IE/DisplayDRAboutDigitalRiverPage/eCommerceProvider.Digital%20River%20Ireland%20Ltd." }}
