Apple Pay elements

Learn how to use Apple Pay elements.

‌With DigitalRiver.js, you can create an Apple Pay element and interact with Apple Pay.‌

Creating an Apple Pay element

To create an Apple Pay element, you should use the createElement function exposed through the DigitalRiver object.

var paymentRequestData = digitalriver.paymentRequest({
        country: "US",
        currency: "USD",
        total: {
            label: "Order Total",
            amount: 100
        },
        displayItems: lineItems,
        shippingOptions: shippingOptions,
        style: {
            buttonType: "plain",
            buttonColor: "dark",
            buttonLanguage: "en"
        }
    });


var applepay = digitalriver.createElement('applepay', paymentRequestData);

Apple Pay element styles and customization

Use the following styles and types to create an Apple Pay button that you can more closely integrate into your experience.‌

Button type‌

Choose one of the following button types:

plain:
buy:

Button color‌

Choose one of the following button colors:

light:
light-outline:
dark: ‌

Apple Pay element functions

applepay.canMakePayment();

Call this function to determine whether or not the Customer's browser supports Apple Pay.

if(applepay.canMakePayment()) {
    //can make payment with this element
}

applepay.mount();

Call this function to place the created Apple Pay element on your page.

<div id="apple-pay"></div>

if(applepay.canMakePayment()) {
    //can make payment with this element
    applepay.mount('apple-pay');
}

applepay.show();

Call this function to show the Apple Pay Payment Request interface. This will automatically happen when using the element. If you'd like to trigger via another mechanism, you must call it as part of the user interaction (click handler).

applepay.show();

applepay.unmount();

Call this function to remove the Apple Pay element from your page. The element may be re-added to your page by calling mount().

applepay.unmount();

applepay.destroy();

Call this function to remove the Apple Pay element from your page and remove its functionality. You cannot re-add the element to your page via mount().

applepay.destroy();

applepay.update();

Call this function to update the Apple Pay element's data. Calling this will merge your changes into the already existing Payment Request object.

var paymentRequest = digitalriver.paymentRequest({
        country: "US",
        currency: "USD",
        total: {
            label: "Order Total",
            amount: 100
        },
        displayItems: lineItems,
        shippingOptions: shippingOptions,
        style: {
            buttonType: "plain",
            buttonColor: "dark",
            buttonLanguage: "en"
        }
    });


applepay.update(paymentRequest);

Apple Pay element events — applepay.on('event', handler);

The Apple Pay element can receive the following events by creating an event listener. Use this function to listen to events that can be used to build and enhance your purchase flow.

Event

Triggered When

ready

The created element is loaded and ready to accept an update request.

click

A shopper clicked the element's button.

cancel

The customer has canceled the experience.

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).

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).

source

The customer has authorized the payment and a source, and DigitalRiver.js returned associated data.

Source

The Source event emits 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.

applepay.on('source', function(event) {
    var source = result.source;


    //pass the source to your back end for further processing.  
});

Ready

The Ready event emits when the Apple Pay Element has loaded and is available to take an update() call.

applepay.on('ready', function(event) {
    //apple pay element is ready and can accept an update call
});

{
    elementType: "applepay"
}

Click

The Click event emits when the customer clicks an Apple Pay Element.

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

{
    elementType: "applepay"
}

Cancel

The Cancel event emits when the customer closes the Apple Pay Element Payment Request interface.

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

Response object

{
    elementType: "applepay"
}

Shipping option change

The Shipping Option Change event emits when the Customer selects 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 contains the details of the customer's chosen Shipping Option.

applepay.on('shippingoptionchange', function(event) {
    var shippingOption = event.shippingOption;


    //create a Payment Request Details Update Object
    var newDetails = createPaymentRequestDetailsUpdateObject();
    event.updateWith(newDetails);
});

Response object

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

Shipping address change

The Shipping Address Change emits when the Customer selects a different Shipping Address within the Payment Request interface. The event will emit the following object structure.

Key