PaymentRequest: abort() method
Limited availability
This feature is not Baseline because it does not work in some of the most widely-used browsers.
Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.
The PaymentRequest.abort()
method of the PaymentRequest
interface causes the user agent to end the payment request and to remove any user
interface that might be shown.
Syntax
js
abort()
Parameters
None.
Return value
None (undefined
).
Examples
The following example sets up a timeout to clear the payment request that might have been abandoned or neglected.
js
const request = new PaymentRequest(supportedInstruments, details, options);
const paymentTimeout = setTimeout(
() => {
clearTimeout(paymentTimeout);
request
.abort()
.then(() => {
print("Payment timed out after 20 minutes.");
})
.catch(() => {
print(
"Unable to abort, because the user is currently in the process " +
"of paying.",
);
});
},
20 * 60 * 1000,
); /* 20 minutes */
Specifications
Specification |
---|
Payment Request API # dom-paymentrequest-abort |
Browser compatibility
Report problems with this compatibility data on GitHubdesktop | mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
abort() |
Legend
Tip: you can click/tap on a cell for more information.
- Full support
- Full support
- No support
- No support
- User must explicitly enable this feature.
The compatibility table on this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.