Skip to Content
Platform.Ontology

Payment Handler API

Lets a payment app run inside the browser as a payment option.

Works without askingPayments and shoppingCheckoutWeb browsersWhile you use itAfter you leave the site

In one line

Can offer its own pay option in the browser's payment sheet, once you install it

Lets a payment app run inside the browser as a payment option.

Lets a wallet website register as a payment method; the site sees only the payment response.

What it can and can't do

What the user does: You pick that payment app in the browser's payment sheet, after it was added.

It can

  • Show up as a payment choice in the browser pay sheet
  • Open its own window to take payment details
  • Send the store an approval after you pay

It cannot

  • Appear without being installed first
  • Take money without you picking it
  • Work in Firefox or Safari, including on iPhone
  • See other payment apps you use

How it differs between platforms: Chrome and Edge support it. Firefox and Safari do not.

Browser support

BrowserStatusFirst versionReleasedNote
ChromeSupported702018-10-16None
EdgeSupported792020-01-15None
FirefoxNot supportedNot availableNot listedNone
SafariNot supportedNot availableNot listedNone
Safari on iPhoneNot supportedNot availableNot listedNone
Chrome on AndroidSupported702018-10-17None
Samsung InternetSupported10.02019-08-22None

How a site asks for it

APIServiceWorkerRegistration.paymentManager, 'paymentrequest' event, enableDelegations()
Browser compat keysapi.PaymentManager
How access is grantedinstall
What the user seesPayment sheet lists the registered handler after install
Needs a secure context (HTTPS)Yes
Needs a user gestureNo
How long it lastsPer origin
How to take it backSite settings
Inside an iframeSame as top level; cross-origin iframes need a permissions policy where listed

Typical flow

  1. Call the API
  2. Browser applies its access rules
  3. Page receives the result

Data you get

What comes back: Lets a payment app run inside the browser as a payment option.
Shape: object
How often: on demand

FieldTypeUnitRangePrecision
methodNamestringNoneURL based identifierNot listed
detailsobjectNonehandler definedNot listed

Technical limits

  • Chrome and Edge only
  • Handler must be a service worker with HTTPS

The story

What it is

A payment app can run inside the browser as a way to pay.

For you

At checkout the browser pay sheet may list a payment app you installed from a website, like a bank or wallet app.

For makers

Banks and wallets can offer their payment method without a native app. Merchants just ask for the payment method and the browser connects them.

Where you see it

TypeExampleApps
bankingA bank registers its own payment app so customers pay with it at any merchant.None named
paymentsA digital wallet offers its balance as a payment choice.Samsung Pay, PayPal
shoppingA shop accepts any installed payment app without special integrations.None named
gamesA web game sells in game currency using a wallet balance.None named
travelA booking site lets you pay with a loyalty points wallet.None named
securityA bank checks you in its own app before approving, so card theft is harder.None named

Risks

  • Fake payment apps
  • Few browsers support it

What the platform says

Good uses and abuse

Legitimate uses

  • Wallet and bank handlers

Known abuse

  • Fake handlers for phishing

Scores

ScoreValueMeaning
Sensitivity3 of 5How revealing the data is
Utility2 of 5How useful it is to honest apps
Friction1 of 5How much the user has to do
Fingerprint bitsNot ratedRough identifying entropy, when known

History

  • 2018, Chrome 70: Payment Handler ships
  • 2020, Chrome 80: enableDelegations

Sources

How well checked: Checked against real behavior.

On this page