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.
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:
Button color
Choose one of the following button colors:
Apple Pay element functions
applepay.canMakePayment();
Call this function to determine whether or not the Customer's browser supports Apple Pay.
applepay.mount();
Call this function to place the created Apple Pay element on your page.
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.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.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.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.
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.
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.
Ready
The Ready event emits when the Apple Pay Element has loaded and is available to take an update()
call.
Click
The Click event emits when the customer clicks an Apple Pay Element.
Cancel
The Cancel event emits when the customer closes the Apple Pay Element Payment Request interface.
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.
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.
Last updated