Elements

Learn how to customize and stylize elements to seamlessly integrate them into your user experience or purchase flow.‌

An Element is a UI component that DigitalRiver.js creates to collect sensitive customer information without having the data touch your servers. You can customize and stylize these components to seamlessly integrate into your user experience or purchase flow. The library collects and tokenizes the data contained in these elements without exposing you to PCI-compliance liability.‌

element.mount();

Use this function to place the created elements on your page. The function accepts an identifier of a container div. The library will load the created element within the specified container.

Example

<form id="payment-form">
    <div id="card-number"></div>
    <div id="card-expiration"></div>
    <div id="card-cvv"></div>
    <button type="submit">Submit</button>
</form>
 
 
cardNumber.mount('card-number');
cardExpiration.mount('card-expiration');
cardCVV.mount('card-cvv');

element.on();

Use this function to listen to events that you can use to build and enhance your purchase flow.

Event	Trigger When	Applies To
​blur​	The element has lost focus.	cardnumber, cardexpiration, cardcvv, onlinebanking
​cancel​	The customer has canceled the experience.	applepay, googlepay
​change​	The element's state has changed.	cardnumber, cardexpiration, cardcvv, onlinebanking
click​	A shopper clicked the element's button.	applepay, googlepay
focus​	The element has gained focus.	cardnumber, cardexpiration, cardcvv, onlinebanking
​ready​	The created element is loaded and ready to accept an update request.	cardnumber, cardexpiration, cardcvv, applepay, googlepay, onlinebanking
return	The shopper has pressed the Return key while focused in the input field.	cardnumber, cardexpiration, cardcvv
​shippingaddresschange​	The customer has chosen a different address than was previously selected. You should use this data to re-price your order totals (if applicable).	applepay, googlepay
​shippingoptionchange​	The customer has chosen a different shipping option than was previously selected. You should use this data to re-price your order totals (if applicable).	applepay, googlepay
​source​	The customer has authorized the payment and a source, and DigitalRiver.js returned associated data.	applepay, googlepay

Blur

A Blur event triggers when an element loses focus.

Example

cardNumber.on('blur', function(event) {
    console.log('card number blur', event);
});

Response object

{
    elementType: "cardnumber"
}
{
    elementType: "cardnumber"
}

Cancel

A Cancel event occurs when the customer closes the Apple Pay Element Payment Request interface.

Example

applepay.on('cancel', function(event) {
    //do stuff
}

Response object

{
    elementType: "applepay"
}

Change

A Change event triggers when an element changes state.‌

If an error is detected, Digital River will return a Change Event Error object with the event payload.

Example

cardNumber.on('change', function(event) {
    console.log('card number change', event);
});

Response object

{
    brand: "unknown",
    complete: false,
    empty: true,
    elementType: "cardnumber",
    error: null
}

Invalid element change event example

Change Response Object Error - Invalid

{
    brand: "unknown",
    complete: true,
    empty: false,
    elementType: "cardnumber",
    "error": {
        "type": "validation_error",
        "code": "invalid_card_number",
        "message": "Your card number is invalid."
    }
}

Incomplete element change event example

Change Response Object Error - Incomplete

{
    brand: "unknown",
    complete: false,
    empty: false,
    elementType: "cardnumber",
    error: {
        "type": "validation_error",
        "code": "incomplete_card_number",
        "message": "Your card number is incomplete."
    }
}

Error types, codes, messages

Error Scenario	Error Type	Error Code	Error Message
Credit Card Number field is incomplete.	validation-error	invalid_card_number	Your card number is invalid.
Credit Card Number field is complete but invalid.	validation-error	incomplete_card_number	Your card number is incomplete.
Card Security Code is incomplete	validation-error	invalid_expiration_month	Your card's expiration month is invalid.
Card Security Code is complete but invalid.	validation-error	invalid_expiration_year	Your card's expiration year is in the past.
Card Expiration field is incomplete.	validation-error	invalid_expiration_date	Your card's expiration date is invalid.
Card Expiration Date is complete but the date is invalid.	validation-error	incomplete_expiration_date	Your card's expiration date is incomplete.
Card Expiration Date is complete but has an invalid year.	validation-error	invalid_security_code	Your card's security code is invalid.
Card Expiration Date is complete but has an invalid month.	validation-error	incomplete_security_code	Your card's security code is incomplete.

Card brands‌

The following table lists the supported credit card brands.

Brand	Key
Visa	visa
MasterCard	mastercard
American Express	amex
Diners Club	dinersclub
Discover	discover
UnionPay	unionpay
JCB	jcb
Maestro	maestro
Forbrugsforeningen	forbrugsforeningen
Dankort	dankort

Click

A Click event occurs when the customer clicks an Apple Pay Element.

Example

applepay.on('click', function(event) {
    //do stuff
}

Response object

{
    elementType: "applepay"
}

Focus

A Focus event triggers when an element gains focus.

Example

cardNumber.on('ready', function(event) {
    console.log('card number ready', event);
});

Response object

{    
    elementType: "cardnumber"
}

Ready

A Ready event triggers when an element is ready and able to receive blur(), focus(), or update() calls.

Example

cardNumber.on('focus', function(event) {
    console.log('card number focus', event);
});

Response object

{
    elementType: "cardnumber"
}

Return

A Return event triggers when a customer presses the Return key while the input field has focus.

Example

cardNumber.on('return', function(event) {
    console.log('card number return', event);
});

Response object

{
    elementType: "cardnumber"
}

Shipping address change

A Shipping Address Change event occurs when the Customer has selected a different Shipping Address within the Payment Request interface. The event will create the following object structure.

Key	Type	Description
updateWith	Function	Calling this function with a Payment Request Details Update object merges your updates into the current Payment Request object.
shippingAddress	A Payment Request Details Update object​	​ A Shipping Address object that contains the customer's Shipping Address.

Example

applepay.on('shippingaddresschange', function(event) {
    var shippingAddress = event.shippingAddress;
  
  
    //create a Payment Request Details Update Object
    var newDetails = createPaymentRequestDetailsUpdateObject();
      
    event.updateWith(newDetails);
});

Apple Pay shipping address change object

JavaScript

{
    shippingAddress: {
        "name": "John Smith",
        "firstName": "John",
        "lastName": "Smith",
        "phone": "952-111-1111",
        "email": "[email protected]",
        "address": {
            "line1": "10380 Bren Rd W",
            "line2": "string",
            "city": "Minnetonka",
            "postalCode": "55129",
            "state": "MN",
            "country": "US"
        }
    },
    "updateWith": function(data) {
        callback(data);
    }
}

Shipping option change

A Shipping Option Change event occurs when the Customer has selected a different Shipping Option within the Payment Request interface. The event will emit the following object structure.

Key	Type	Description
updateWith	Function	Calling this function with a Payment Request Details Update object merges your updates into the current Payment Request object.
shippingOption	A Payment Request Details Update object​	​ ​ A Payment Request Shipping Option object that contains the customer's chosen Shipping Option.

Example

applepay.on('shippingaddresschange', function(event) {
    var shippingAddress = event.shippingAddress;
  
  
    //create a Payment Request Details Update Object
    var newDetails = createPaymentRequestDetailsUpdateObject();
      
    event.updateWith(newDetails);
});

Apple Pay shipping option change object

Example

{
    "shippingOption": {
        "id": "overnight-shipping",
        "label": "Overnight Shipping",
        "amount": 100,
        "detail": "Get this in 1 business day."
    },
    "updateWith": function(data) {
        callback(data);
    }
}

Source

A Source event occurs when the Customer completes their interaction with the Payment Request interface and creates a Payment Source. The emitted object will be a Payment Request Response object.

Example

googlepay.on('source', function(result) {
    var source = result.source;
     
    //pass the source to your back end for further processing
}

Element functions

Use these functions to trigger functionality within the specified Element to further enhance your purchase flow experience.‌

element.blur();

This function triggers the blur() event. This will remove the focus from the element.

Example

cardNumber.blur();

element.clear();

This function clears the contents of the element.

Example

cardNumber.clear();

element.focus();

This function triggers the focus() event and places the focus on the element.

Example

cardNumber.destroy();

element.destroy();

This function destroys the element. Removes the element and all of its associated data so you cannot use it again. You must create a new element if you want to restore the associated data.

Example

cardNumber.destroy();

element.unmount();

This function removes the element from the Document Object Module (DOM). The element and its associated data still exists. You can place it on the page again by calling its mount() function.

Example

cardNumber.unmount();

element.update(options);

This function updates the element with any included options. This can include custom styles and classes.

Example

var options = {
    classes: {
        base: "DRElement",
        complete: "complete",
        empty: "empty",
        focus: "focus",
        invalid: "invalid",
        webkitAutofill: "autofill"
    },
    style: {
        base: {
            color: "#fff",
            fontFamily: "Arial, Helvetica, sans-serif",
            fontSize: "20px",
            fontSmoothing: "auto",
            fontStyle: "italic",
            fontVariant: "normal",
            letterSpacing: "3px"
        },
        empty: {
            color: "#fff"
        },
        complete: {
            color: "green"
        },
        invalid: {
            color: "red"
        }
    }
};
 
cardNumber.update(options);

Styling an element container

Custom classes

You can specify custom classes as part of a Class object included within the Options object when you create or update an element. If you do not provide custom classes, the system uses the default options.

Example

var options = {
    classes: {
        base: "DRElement",
        complete: "complete",
        empty: "empty",
        focus: "focus",
        invalid: "invalid",
        webkitAutofill: "autofill"
    }
}
 
var cardNumber = elements.create("cardnumber", options);

Available custom classes

Class Type	ID	Applies When	Default Class Name
Base	base	The Element is in its base state. The user either has not entered anything into the input field or is currently typing.	DRElement
Complete	complete	The Element is in its complete state. The user has input value, and it meets the basic validation requirements of that field.	DRElement--complete
Empty	empty	The Element is empty. The Element once had value but is now empty.	DRElement--empty
Focus	focus	The Element has focus.	DRElement--focus
Invalid	invalid	The Element has value, but it does not meet the basic validation requirements of the field.	DRElement--invalid
WebKit Autofill	webkitAutofill	A saved card stored in a browser automatically fills this element.	DRElement-webkit-autofill

Custom styles

You can specify custom styles as part of a Style object included within the Options object when creating or updating an Element. If you don't provide custom styles, the system uses the browser defaults.

Example

var options = {
    style: {
        base: {
            color: "#fff",
            fontFamily: "Arial, Helvetica, sans-serif",
            fontSize: "20px",
            fontSmoothing: "auto",
            fontStyle: "italic",
            fontVariant: "normal",
            letterSpacing: "3px"
        },
        empty: {
            color: "#fff"
        },
        complete: {
            color: "green"
        },
        invalid: {
            color: "red",
        }
    }
}
 
 
var cardNumber = elements.create('cardnumber', options);

Available custom style classes

ID	Class Name	Description
base	Base	All other variants inherit from this style.
complete	Complete	Applied when the Element has valid input.
empty	Empty	Applied when the Element has no customer input.
focus	Focus	Applied when the Element has focus.
invalid	Invalid	Applied when the Element has invalid input.
webKitAutofill	Webkit Autofill	Applied when the Element has been filled automatically by a browser.

Available custom styles

Style	ID	Type	Example
Box Shadow	boxShadow	string	inset 0 0 0px 1000px #fff
Text Color	color	string	"#fff"
Font Family	fontFamily	string	"Arial, Helvetica, sans-serif",
Font Size	fontSize	string	"20px"
Font Smoothing	fontSmoothing	string	"antialiased"
Font Style	fontStyle	string	"bold"
Font Variant	fontVariant	string	"normal"
Letter Spacing	letterSpacing	string	"2px"
Text Align	textAlign	string	"center"
Text Decoration	textDecoration	string	"underline"
Text Shadow	textShadow	string	"2px 2px #ff0000"
Font Weight	fontWeight	string	"400"
Padding	padding	string	"2px"
Padding Top	paddingTop	string	"2px"
Padding Right	paddingRight	string	"2px"
Padding Bottom	paddingBottom	string	"2px"
Padding Left	paddingLeft	string	"2px"

Pseudo-classes

Class	ID	Type
:hover	:hover	string
:focus	:focus	string
::placeholder	::placeholder	string
::selection	::selection	string
:-webkit-autofill	:-webkit-autofill	string
:disabled	:disabled	string

Other customizable attributes

Attribute	ID	Type	Example	Description	Example
Placeholder Text	placeholderText	string	"Card Number"	You may override the placeholder text that appears in cardnumber, cardexpiration, cardcvv, and onlinebanking element types. If you specify a placeholderText attribute, localization will not be applied.
Mask	mask	boolean	true/false	You may choose to mask the contents of the DigitalRiver.js Element after a proper number and card security code has been implemented. If enabled, only the last 4 digits of the card number will be exposed in the view.