Web-Based Payment Handler APIservice
The PaymentRequestEvent interface of the Web-based Payment Handler API is the object passed to a payment handler when a PaymentRequest is made.
Constructor
- PaymentRequestEvent.PaymentRequestEvent
- : Creates a new
PaymentRequestEventobject instance.
- : Creates a new
Instance properties
- PaymentRequestEvent.methodData
- : Returns an array of objects containing payment method identifiers for the payment methods that the website accepts and any associated payment method specific data.
- PaymentRequestEvent.modifiers
- : Returns an array of objects containing changes to payment details.
- PaymentRequestEvent.paymentRequestId
- : Returns the ID of the PaymentRequest object.
- PaymentRequestEvent.paymentRequestOrigin
- : Returns the origin where the PaymentRequest object was initialized.
- PaymentRequestEvent.topOrigin
- : Returns the top-level origin where the PaymentRequest object was initialized.
- PaymentRequestEvent.total
- : Returns the total amount being requested for payment.
Instance methods
- PaymentRequestEvent.changePaymentMethod
- : Gets an updated total, given payment method details.
- PaymentRequestEvent.openWindow
- : Opens the specified URL in a new window, if and only if the given URL is on the same origin as the calling page. It returns a Promise that resolves with a reference to a WindowClient.
- PaymentRequestEvent.respondWith
- : Prevents the default event handling and allows you to provide a Promise for a PaymentResponse object yourself.
Examples
When the PaymentRequest.show() method is invoked, a ServiceWorkerGlobalScope.paymentrequest_event event is fired on the service worker of the payment app. This event is listened for inside the payment app's service worker to begin the next stage of the payment process.
let paymentRequestEvent;
const resolver = Promise.withResolvers();
let client;
// `self` is the global object in service worker
self.addEventListener("paymentrequest", async (e) => {
if (paymentRequestEvent) {
// If there's an ongoing payment transaction, reject it.
resolver.reject();
}
// Preserve the event for future use
paymentRequestEvent = e;
// …
});
When a paymentrequest event is received, the payment app can open a payment handler window by calling PaymentRequestEvent.openWindow(). The payment handler window will present the customers with a payment app interface where they can authenticate, choose shipping address and options, and authorize the payment.
When the payment has been handled, PaymentRequestEvent.respondWith() is used to pass the payment result back to the merchant website.
See Receive a payment request event from the merchant for more details of this stage.
Specifications
Browser compatibility
See also
- Web-based payment apps overview
- Setting up a payment method
- Life of a payment transaction
- Using the Payment Request API
- Payment processing concepts
来源:MDN Web Docs / Mozilla 贡献者 · 作者与贡献记录 · CC BY-SA 2.5。离线整理了版式、链接和媒体显示。
