PaymentRequest.abort()

Secure context
This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.

This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

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

PaymentRequest.abort();

Returns

Void.

Parameters

None

Examples

The following example sets up a timeout to clear the payment request that might have been abandoned or neglected.

var request = new PaymentRequest(supportedInstruments, details, options);

var paymentTimeout = window.setTimeout(() => {
  window.clearTimeout(paymentTimeout);
  payment.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 Status Comment
Payment Request API
The definition of 'abort()' in that specification.
Candidate Recommendation Initial definition.

Browser Compatibility

FeatureChromeEdgeFirefoxInternet ExplorerOperaSafari
Basic support6115551 No No ?
FeatureAndroid webviewChrome for AndroidEdge mobileFirefox for AndroidOpera AndroidiOS SafariSamsung Internet
Basic support No53 Yes551 No ?6.0

1. From version 55: this feature is behind the dom.payments.request.enabled preference (needs to be set to true). To change preferences in Firefox, visit about:config.

See Also

Document Tags and Contributors

 Contributors to this page: fscholz, jpmedley, chrisdavidmills, dgashmdn
 Last updated by: fscholz,