PaymentResponse.complete()

The PaymentRequest.complete() method of the PaymentRequest API notifies the user agent that the user interaction is over, and causes any remaining user interface to be closed. This method must be called after the user accepts the payment request and the Promise returned by the PaymentRequest.show() method is resolved.

Syntax

PaymentRequest.complete([result])
   .then(function() { ... } )
   .catch( error => { ... } )

Returns

A Promise.

Parameters

result

A string with one of the following values:

• "success": Indicates the payment was successfully processed. The user agent may or may not indicate success to the user.
• "fail": Indicates the payment was not successfully processed. The user agent may or may not indicate failure to the user.
• "unknown": The web page did not indicate success or failure and the user agent should not display a UI indicating success or failure.  This is the default.
• "" (empty string): The web page did not indicate success or failure and the user agent should not display a UI indicating success or failure. This value has been replaced by "unknown". See browser compatibility for details.

Note: The value passed to this method must include the quotation marks.

Examples

The following example sends payment information to a secure server using the Fetch API. It calls complete() with an answer appropriate to the status in the response.

// Initialization of PaymentRequest arguments are excerpted for the 
//   sake of brevity.
var payment = new PaymentRequest(supportedInstruments, details, options);
payment.show().then(function(paymentResponse) {
  var fetchOptions = {
    method: 'POST',
    credentials: include,
    body: JSON.stringify(paymentResponse)
  };
  var serverPaymentRequest = new Request('secure/payment/endpoint');
  fetch(serverPaymentRequest, fetchOptions).then( response => {
    if (response.status < 400) {
      paymentResponse.complete("success");
    } else {
      paymentResponse.complete("fail");
    };
  }).catch( reason => {
    paymentResponse.complete("fail");
  });
}).catch(function(err) {
  console.error("Uh oh, something bad happened", err.message);
});

Specifications

Browser Compatibility

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