PaymentRequest.canMakePayment()

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.canMakePayment() method of the PaymentRequest interface indicates whether the PaymentRequest object can make a payment before calling show(). It returns a Promise resolves to true if the user agent supports any of the payment methods supplied to the constructor, and false otherwise. if this method is called too often, the spec allows the user agents to return a promise rejected with a DOMException.

Syntax

PaymentRequest.canMakePayment()
    .then( boolean => { ... })
    .catch( error => { ... })

Returns

A Promise to a Boolean that resolves to true if the user agent supports any of the payment methods supplied in the PaymentRequest constructor.

Parameters

None

Examples

In the following example, is excerpted from a demo that asynchronously builds a PaymentRequest object for both Android Pay and credit cards. It wraps the call to canMakePayment() in feature detection, and calls an appropriate callback depending on the resolution of the Promise.

function initPaymentRequest(onSuccess, onFailure) {

  //Code excerpted.
  
  //supportedInstrucments includes Android Pay and credit cards.
  let request = new PaymentRequest(supportedInstruments, details);

  if (request.canMakePayment) {
    request.canMakePayment().then(function(result) {
      if (result) {
        onSuccess(request);
      } else {
        onFailure('Cannot make payment');
      }
    }).catch(function(err) {
      onSuccess(request, err);
    });
  } else {
    onSuccess(
      request, 'This browser does not support "can make payment" query');
  }
}

Specifications

Specification Status Comment
Payment Request API
The definition of 'canMakePayment()' in that specification.
Candidate Recommendation Initial definition.

Browser Compatibility

Feature Chrome Firefox (Gecko) Internet Explorer Opera Safari (WebKit)
Basic support 61 No support[1] ? No support ?
Feature Android Webview Chrome for Android Firefox Mobile (Gecko) IE Mobile Opera Mobile Safari Mobile
Basic support No support 56 No support[1] ? No support ?

[1] Supported since 55 but disabled on all versions. Hidden behind the dom.payments.request.enabled pref.

See Also

Document Tags and Contributors

 Contributors to this page: jpmedley, ithinkihaveacat, chrisdavidmills, bunnybooboo
 Last updated by: jpmedley,