Setting up a payment method  |  Articles  |  web.dev (2024)

A payment transaction using Web Payments starts with the discovery of yourpayment app. Learn how to set up a payment method and get your payment appready for merchants and customers to make payments.

To be used with the Payment Request API, a payment app must be associated with apayment method identifier. Merchants that want to integrate with a payment appwill use the payment method identifier to indicate that to the browser. Thisarticle discusses how payment app discovery works, and how to configure yourpayment app to be properly discovered and invoked by a browser.

If you are new to the concept of Web Payments or how a payment transaction worksthrough payment apps, read the following articles first:

• Empowering payment apps with Web Payments
• Life of a payment transaction

Browser support

Web Payments consists of a few different pieces of technologies and the supportstatus depends on the browser.

How a browser discovers a payment app

Every payment app needs to provide the following:

• URL-based payment method identifier
• Payment method manifest (except when the payment method identifier isprovided by a third party)
• Web app manifest

The discovery process starts when a merchant initiates a transaction:

1. The browser sends a request to the payment methodidentifier URL and fetchesthe payment methodmanifest.
2. The browser determines the web appmanifest URL from thepayment method manifest and fetches the web app manifest.
3. The browser determines whether to launch the OS payment app or theweb-based payment app from the web app manifest.

The next sections explain in detail how to set up your own payment method sothat browsers can discover it.

Step 1: Provide the payment method identifier

A payment methodidentifieris a URL-based string. For example, Google Pay's identifier ishttps://google.com/pay. Payment app developers can pick any URL as a paymentmethod identifier as long as they have control over it and can serve arbitrarycontent. In this article, we'll usehttps://bobbucks.dev/pay as the payment methodidentifier.

How merchants use the payment method identifier

A PaymentRequest object is constructed with a list of payment methodidentifiers that identifies paymentapps a merchant decides to accept. Payment method identifiers are set as a valuefor the supportedMethods property. For example:

[merchant] requests payment:

const request = new PaymentRequest([{ supportedMethods: 'https://bobbucks.dev/pay'}], { total: { label: 'total', amount: { value: '10', currency: 'USD' } }});

Step 2: Serve the payment method manifest

A payment method manifest is aJSON file that defines which payment app can use this payment method.

Provide the payment method manifest

When a merchant initiates a payment transaction, the browser sends an HTTPGET request to the payment method identifier URL.The server responds with the payment methodmanifest body.

A payment method manifest has two fields, default_applications andsupported_origins.

A payment method manifest file should look like this:

[payment handler] /payment-manifest.json:

{ "default_applications": ["https://bobbucks.dev/manifest.json"], "supported_origins": [ "https://alicepay.friendsofalice.example" ]}

When the browser reads the default_applications field, it finds a list oflinks to web app manifests of supportedpayment apps.

Optionally route the browser to find the payment method manifest in another location

The payment method identifier URL can optionally respond with a Link headerthat points to another URL where the browser can fetch the payment methodmanifest. This is useful when a payment method manifest is hosted at a differentserver or when the payment app is served by a third party.

Configure the payment method server to respond with a HTTP Link header withthe rel="payment-method-manifest" attribute and the payment methodmanifest URL.

For example, if the manifest is at https://bobbucks.dev/payment-manifest.json,the response header would include:

Link: <https://bobbucks.dev/payment-manifest.json>; rel="payment-method-manifest"

The URL can be a fully-qualified domain name or a relative path. Inspecthttps://bobbucks.dev/pay/ for network traffic to see an example. You may use acurl command as well:

curl --include https://bobbucks.dev/pay

Step 3: Serve a web app manifest

A web app manifest isused to define a web app as the name suggests. It's a widely used manifest fileto define a Progressive Web App (PWA).

Typical web app manifest would look like this:

[payment handler] /manifest.json:

{ "name": "Pay with Bobpay", "short_name": "Bobpay", "description": "This is an example of the Payment Handler API.", "icons": [ { "src": "images/manifest/icon-192x192.png", "sizes": "192x192", "type": "image/png" }, { "src": "images/manifest/icon-512x512.png", "sizes": "512x512", "type": "image/png" } ], "serviceworker": { "src": "service-worker.js", "scope": "/", "use_cache": false }, "start_url": "/", "display": "standalone", "theme_color": "#3f51b5", "background_color": "#3f51b5", "related_applications": [ { "platform": "play", "id": "com.example.android.samplepay", "min_version": "1", "fingerprints": [ { "type": "sha256_cert", "value": "4C:FC:14:C6:97:DE:66:4E:66:97:50:C0:24:CE:5F:27:00:92:EE:F3:7F:18:B3:DA:77:66:84:CD:9D:E9:D2:CB" } ] } ]}

The information described in a web app manifest is also used to define how apayment app appears in the Payment Request UI.

The web app manifest's name property is used as the payment app name, iconsproperty is used as the payment app icon.

How Chrome determines which payment app to launch

Launching the platform-specific payment app

To launch the platform-specific payment app, the following conditions must be met:

• The related_applications field is specified in the web app manifest and:
  • The installed app's package ID and signature match, while the minimumversion (min_version) in the web app manifest is less than or equal tothe version of the installed application.
• The prefer_related_applications field is true.
• The platform-specific payment app is installed and has:
  • An intent filter of org.chromium.action.PAY.
  • A payment method identifier specified as the value for the org.chromium.default_payment_method_name property.

Check out the Android payment apps: developer's guidefor more details about how to set these up.

[payment handler] /manifest.json

"prefer_related_applications": true,"related_applications": [{ "platform": "play", "id": "xyz.bobpay.app", "min_version": "1", "fingerprints": [{ "type": "sha256_cert", "value": "92:5A:39:05:C5:B9:EA:BC:71:48:5F:F2:05:0A:1E:57:5F:23:40:E9:E3:87:14:EC:6D:A2:04:21:E0:FD:3B:D1" }]}]

If the browser has determined that the platform-specific payment app is available, thediscovery flow is terminated here. Otherwise it continues to the next step --launching the web-based payment app.

Launching the web-based payment app

The web-based payment app should be specified in the web app manifest's serviceworker field.

[payment handler] /manifest.json:

"serviceworker": { "src": "payment-handler.js"}

The browser launches the web-based payment app by sending a paymentrequestevent to the service worker. The service worker doesn't have to be registered inadvance. It can be registered just-in-time.

Understanding the special optimizations

How browsers can skip the Payment Request UI and launch a payment app directly

In Chrome, when show() method of PaymentRequest is called, the PaymentRequest API displays a browser-provided UI called the "Payment Request UI". ThisUI allows users to choose a payment app. After pressing the Continue buttonin the Payment Request UI, the selected payment app is launched.

Showing the Payment Request UI before launching a payment app increases thenumber of steps needed for a user to fulfill a payment. To optimize the process,the browser can delegate fulfillment of that information to payment apps andlaunch a payment app directly without showing the Payment Request UI whenshow() is called.

To launch a payment app directly, the following conditions must be met:

• show() is triggered with a user gesture (for example, a mouse click).
• There is only a single payment app that:
  • Supports the requested payment method identifier.

When is a web-based payment app registered just-in-time (JIT)?

Web-based payment apps can be launched without the user's explicit prior visitto the payment app website and registering the service worker. The serviceworker can be registered just-in-time when the user chooses to pay with theweb-based payment app. There are two variations for the registration timing:

• If the Payment Request UI is shown to the user, the app is registeredjust-in-time and launched when the user clicks Continue.
• If the Payment Request UI is skipped, the payment app is registeredjust-in-time and launched directly. Skipping the Payment Request UI to launcha just-in-time registered app requires a user gesture, which preventsunexpected registration of cross-origin service workers.

Next Steps

Now that you have your payment app discoverable, learn how to develop a platform-specificpayment app and a web-based payment app.

• Android payment apps: developer's guide
• Web based payment apps developer guide