PaymentRequestEvent: respondWith() method
Limited availability
This feature is not Baseline because it does not work in some of the most widely-used browsers.
Want more browser support for this feature? Tell us why.
Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
Note: This feature is only available in Service Workers.
The respondWith() method of the PaymentRequestEvent interface prevents the default event handling and allows you to provide a Promise for a payment handler response object yourself.
Syntax
respondWith(promise)
Parameters
promise-
A payment handler response object or a
Promisethat resolves to one. This object should contain the following properties:methodName-
The payment method identifier for the payment method that the user selected to fulfill the transaction.
details-
A JSON-serializable object that provides a payment method-specific message used by the merchant to process the transaction and determine a successful fund transfer. See 8.1.2
detailsattribute for more details.
The
promisecan be rejected with the following values to indicate a failure of the payment app:AbortErrorDOMException-
Indicates that the user canceled the payment request.
OperationErrorDOMException-
Indicates an internal error in the underlying app that is handling the payment.
If the
promiseis rejected with any other value, it is mapped toAbortError.
Return value
None (undefined).
Examples
The example below is taken from Open the payment handler window to display the web-based payment app frontend. Read the article to understand the context of the code.
self.addEventListener("paymentrequest", async (e) => {
// Retain a promise for future resolution
resolver = new PromiseResolver();
// Pass a promise that resolves when payment is done.
e.respondWith(resolver.promise);
// Open the checkout page.
try {
// Open the window and preserve the client
client = await e.openWindow(checkoutURL);
if (!client) {
// Reject if the window fails to open
throw new Error("Failed to open window");
}
} catch (err) {
// Reject the promise on failure
resolver.reject(err);
}
});
Specifications
| Specification |
|---|
| Web-based Payment Handler API # dom-paymentrequestevent-respondwith |