Payment Request API

The Payment Request API provides a consistent user experience for both merchants and users. It is not a new way for paying for things; rather,  it's a way for user's to select their preferred way of paying for things, and make that information available to a merchant.

Payment Request concepts and usage

Many problems related to online shopping-cart abandonment can be traced to checkout forms, which can be difficult and time consuming to fill out and often require multiple steps to complete. The Payment Request API is meant to reduce the number of steps needed to complete a payment online, potentially doing away with checkout forms. It aims to make the checkout process easier, by remembering a user's details, which are then passed along to a merchant hopefully without requiring a HTML form. 

Advantages of using the Payment Request API with "basic-card" (card-based payments):

  • Fast purchase experience: Users enter their details once into the browser and are then ready to pay for goods and services on the web.  They no longer have to fill out the same details repeatedly across different sites. 
  • Consistent experience on every site (that supports the API):  As the payment sheet is controlled by the browser, it can tailor the experience to the user. This can include localizing the UI into the user's preferred language.
  • Accessibility:  As the browser controls the input elements of the payment sheet, it can assure consistent keyboard and screen reader accessibility on every website without developers needing to do anything.  A browser could also adjust the font size or color contrast of the payment sheet, making it more comfortable for the user to make a payment. 
  • Credentials management: Users can manage their credit cards and shipping addresses directly in the browser. A browser can also sync these  "credentials" across devices, making it easy for users to jump from desktop to mobile and back again when buying things.
  • Consistent error handling: The browser can check the validity of card numbers, and can tell the user if a card has expired (or is about to expire). The browser can automatically suggest which card to use based on past usage patterns or restrictions from the merchant (e.g, "we only accept Visa or Mastercard"), or allow the user to say which is their default/favorite card. 

To request a payment, a web page creates a PaymentRequest object in response to a user action that initiates a payment, such as clicking a "Purchase" button. The PaymentRequest allows the web page to exchange information with the user agent while the user provides input to complete the transaction.

Note: The API is available inside cross-origin <iframe> elements only if they have had the allowpaymentrequest attribute set on them.

Interfaces

PaymentAddress
An object that contains address information; used for billing and shipping addresses, for example.
PaymentDetailsUpdate
An object describing changes that need to be made to the payment details in the event that the server needs to update information following the instantiation of the payment interface but before the user begins to interact with it.
PaymentRequest
An object that provides the API for creating and managing the user agent's payment interface.
PaymentRequestEvent
An event delivered to a payment handler when a PaymentRequest is made.
PaymentRequestUpdateEvent
Enables the web page to update the details of the payment request in response to a user action.
PaymentMethodChangeEvent
Represents the user changing payment instrument (e.g., switching  from a credit card to debit card).
PaymentResponse
An object returned after the user selects a payment method and approves a payment request.
MerchantValidationEvent
Represents the browser requiring the merchant (website) to validate themselves as allowed to use a particular payment handler (e.g., registered as allowed to use Apple Pay).
BasicCardRequest
Defines an object structure for containing payment request details such as card type.
BasicCardResponse
Defines an object structure for payment response details such as the number/expiry date of the card used to make the payment, and the billing address.

Dictionaries

AddressErrors
A dictionary containing strings providing descriptive explanations of any errors in any PaymentAddress entries which have errors.
PayerErrors
A dictionary containing strings providing descriptive explanations of any errors in related to PaymentResponse's email, phone, and name attributes.

Payment method identifiers

Payment handlers are uniquely identified by payment method identifiers, which are strings uniquely identifying the payment handler. These may be either one of the standardized payment handler identifiers, or a URL used by the payment processing service to both identify itself and to handle payments.

Standardized payment method identifiers

There is currently only one regiested standardized payment method identifier (more may be added in the future):

"basic-card"
Payments are handled by the Basic Card Payment specification. See BasicCardRequest for details. Should have an article about this specification and how to use it.

URL-based payment method identifiers

These may vary substantially depending on the specifics of the service, and a given processing service may have multiple URLs used, depending on the version of their API, their communication technology, and so forth.

Specifications

Specification Status Comment
Payment Request API Candidate Recommendation Initial definition.
Basic Card Payment Working Draft Defines BasicCardRequest and BasicCardResponse.
Unknown Unknown Defines payment method identifiers and how they are validated, and, where applicable, minted and formally registered with the W3C.

Browser compatibility

We're converting our compatibility data into a machine-readable JSON format. This compatibility table still uses the old format, because we haven't yet converted the data it contains. Find out how you can help!

  
Feature Chrome Edge Firefox (Gecko) Internet Explorer Opera Safari (WebKit)
Basic support

61

(Yes) No support[1] ? No support ?
  
Feature Android Webview Chrome for Android Edge Firefox Mobile (Gecko) IE Mobile Opera Mobile Safari Mobile
Basic support No support 51 (Yes) No support[1] ? No support ?

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

See also