Navigator.mozPay()

Non-standard
This feature is not on a current W3C standards track, but it is supported on the Firefox OS platform. Although implementations may change in the future and it is not supported widely across browsers, it is suitable for use in code dedicated to Firefox OS apps.

This API is available on Firefox or Firefox OS for installed or higher privileged applications.

Summary

The mozPay function is used to perform payments. It enables an app to use in-app payments.

Syntax

var request = navigator.mozPay(jwts);
jwts
An array of JSON Web Tokens.

Warning: Because signatures are derived from the application secret, it's mandatory to sign the JSON Web token on the server side. Ensure that no unauthorized party can access your application secret.

Return

A DOMRequest object.

Example

// Begin a purchase. Typically you would attach this to the click handler on a Buy button.
purchaseSomething("A nice unicorn");

function purchaseSomething(productID) {
  var xhr = new XMLHttpRequest();
  xhr.responseType = 'json';

  // Prepare to send a productID to your server and
  // receive an array of JWTs.
  xhr.open('POST', '/create_jwts');

  xhr.addEventListener('load', function () {
    // Retrieve the JWTs and a transactionID from a JSON response, such as:
    // {"jwts": ["jwt1...", "jwt2..."], "transactionID": "1234"}
    var jwts = xhr.response.jwts;
    var transactionID = xhr.response.transactionID;

    // Pass the JSON Web Tokens to the payment provider
    var request = navigator.mozPay(jwts);

    // Set up the success/error handler for the payment window.
    request.onsuccess = function () {
      console.log('The user payment flow completed successfully');
      // Although the payment flow completed, you need to poll your server and wait 
      // for a verified payment result to be sure the payment went through.
      waitForPaymentResult(transactionID);
    };
    request.onerror = function () {
      console.log('Sorry, the payment flow had an error:', this.error.name);
    };
  })

  // Initiate the payment request by sending information to
  // get the signed JSON Web Tokens. In our example, productID 
  // is the ID of the product the user wants to puchase.
  xhr.send(productID);
}

function waitForPaymentResult(transactionID) {
  var xhr = new XMLHttpRequest();
  xhr.responseType = 'json';

  // Prepare to check if a postback/chargeback has been received for transactionID.
  xhr.open('GET', '/payment_result/' + transactionID);

  xhr.addEventListener('load', function () {
    // Retrieve the result, such as:
    // {"result": "postback received"} or {"result": "still waiting"}
    if (xhr.response.result == 'postback received') {
      // A postback notice was received and you verified the incoming JWT signature.
      console.log('Success! The product has been purchased');
    } else {
      // No postback/chargeback has been sent to your server yet. Try again in 3 seconds.
      window.setTimeout(function() { waitForPaymentResult(transactionID); }, 3000);
    }
  });

  // Send the request to check the transactionID status.
  xhr.send();
}

Specification

Not part of any specification. However this topic is heavily discussed at W3C in the Web Payment Community Group.

See also

Document Tags and Contributors

Last updated by: teoli,