使用 Web Payments 进行的付款交易从发现您的支付应用开始。了解如何设置付款方式,以及如何让您的支付应用做好准备,以便商家和客户进行付款。
发布时间:2017 年 9 月 27 日,上次更新时间:2025 年 7 月 1 日
如需与 Payment Request API 搭配使用,付款应用必须与付款方式标识符相关联。希望与支付应用集成的商家将使用支付方式标识符向浏览器表明这一点。本文讨论了支付应用发现机制,以及如何配置支付应用以供浏览器正确发现和调用。
如果您刚接触 Web Payments 的概念,或者不了解支付交易如何通过支付应用进行,请先阅读以下文章:
浏览器支持
Web Payments 由多种不同的技术组成,支持状态取决于浏览器。
浏览器如何发现支付应用
每个支付应用都需要提供以下内容:
- 基于网址的支付方式标识符
- 支付方式清单(支付方式标识符由第三方提供的情况除外)
- Web 应用清单
当商家发起交易时,发现流程便会开始:
- 浏览器向付款方式标识符网址发送请求,并提取付款方式清单。
- 浏览器会从付款方式清单中确定 Web 应用清单网址,并提取 Web 应用清单。
- 浏览器会根据 Web 应用清单确定是启动操作系统付款应用还是基于 Web 的付款应用。
以下部分将详细介绍如何设置您自己的支付方式,以便浏览器可以发现它。
第 1 步:提供付款方式标识符
支付方式标识符是一个基于网址的字符串。例如,Google Pay 的标识符为 https://google.com/pay。支付应用开发者可以选择任何网址作为支付方式标识符,前提是他们可以控制该网址并提供任意内容和 HTTP 标头。在本文中,我们将使用 https://bobbucks.dev/pay 作为支付方式标识符。
商家如何使用支付方式标识符
PaymentRequest 对象是使用付款方式标识符列表构建的,用于标识商家决定接受的付款应用。付款方式标识符设置为 supportedMethods 属性的值。例如:
[商家] 请求付款:
const request = new PaymentRequest([{
supportedMethods: 'https://bobbucks.dev/pay'
}], {
total: {
label: 'total',
amount: { value: '10', currency: 'USD' }
}
});
第 2 步:提供支付方式清单
支付方式清单是一个 JSON 文件,用于定义哪些支付应用可以使用此支付方式。
提供支付方式清单
当商家发起付款交易时,浏览器会向付款方式标识符网址发送 HTTP HEAD 请求。付款方式标识符网址会返回一个 Link HTTP 标头,该标头指向浏览器可以从中提取付款方式清单的网址。
将付款方式服务器配置为使用包含 rel="payment-method-manifest" 属性和付款方式清单网址的 HTTP Link 标头进行响应。例如,如果清单位于 https://bobbucks.dev/pay/payment-manifest.json,则响应标头将包含:
Link: <https://bobbucks.dev/pay/payment-manifest.json>; rel="payment-method-manifest"
该网址可以是完全限定域名,也可以是相对路径。检查 https://bobbucks.dev/pay 中的网络流量,查看示例。您也可以使用 curl 命令:
curl --include https://bobbucks.dev/pay
接下来,浏览器会向付款方式清单网址发送 HTTP GET 请求。服务器会返回付款方式清单正文。
支付方式清单包含两个字段:default_applications 和 supported_origins。
| 属性名称 | 说明 |
|---|---|
default_applications(必需) |
指向托管支付应用的 Web 应用清单的网址数组。(网址可以是相对网址)。此数组应引用开发清单、生产清单等。 |
supported_origins |
一个网址数组,指向可能托管实现相同付款方式的第三方付款应用的来源。请注意,一种支付方式可以由多个支付应用实现。 |
支付方式清单文件应如下所示:
[付款处理程序] /payment-manifest.json:
{
"default_applications": ["https://bobbucks.dev/manifest.json"],
"supported_origins": [
"https://alicepay.friendsofalice.example"
]
}
当浏览器读取 default_applications 字段时,会找到指向受支持的支付应用的Web 应用清单的链接列表。
第 3 步:提供 Web 应用清单
Web 应用清单用于定义 Web 应用,顾名思义。它是一种广泛使用的清单文件,用于定义渐进式 Web 应用 (PWA)。
典型的 Web 应用清单如下所示:
[付款处理程序] /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"
}
]
}
]
}
Web 应用清单中描述的信息还用于定义支付应用在 Payment Request 界面中的显示方式。
| 属性名称 | 说明 |
|---|---|
name(必需)
|
用作支付应用名称。 |
icons(必需)
|
用作支付应用图标。只有 Chrome 会使用这些图标;如果您未将这些图标指定为支付工具的一部分,其他浏览器可能会将它们用作后备图标。 |
serviceworker
|
用于检测作为基于 Web 的支付应用运行的服务工作线程。 |
serviceworker.src |
用于下载服务工作线程脚本的网址。 |
serviceworker.scope |
一个字符串,表示定义了服务工作线程注册范围的网址。 |
serviceworker.use_cache |
用于下载服务工作线程脚本的网址。 |
related_applications
|
用于检测充当操作系统提供的支付应用的应用。如需了解详情,请参阅 Android 支付应用开发者指南。 |
prefer_related_applications
|
用于确定在同时提供操作系统提供的支付应用和基于 Web 的支付应用时,要启动哪个支付应用。 |
Web 应用清单的 name 属性用作支付应用名称,icons 属性用作支付应用图标。
Chrome 如何确定要启动哪个支付应用
启动特定于平台的支付应用
如需启动特定于平台的付款应用,必须满足以下条件:
related_applications字段在 Web 应用清单中指定,并且:- 已安装应用的软件包 ID 和签名匹配,而 Web 应用清单中的最低版本 (
min_version) 小于或等于已安装应用的相应版本。
- 已安装应用的软件包 ID 和签名匹配,而 Web 应用清单中的最低版本 (
prefer_related_applications字段为true。- 已安装特定于平台的支付应用,并且该应用具有以下特征:
- 值为
org.chromium.action.PAY的 intent 过滤器。 - 指定为
org.chromium.default_payment_method_name属性值的付款方式标识符。
- 值为
如需详细了解如何设置这些应用,请参阅 Android 付款应用:开发者指南。
[付款处理程序] /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"
}]
}]
如果浏览器已确定特定于平台的付款应用可用,则在此处终止发现流程。否则,它会继续执行下一步操作,即启动基于 Web 的付款应用。
启动基于网络的支付应用
基于 Web 的支付应用应在 Web 应用清单的 serviceworker 字段中指定。
[付款处理程序] /manifest.json:
"serviceworker": {
"src": "payment-handler.js"
}
浏览器通过向服务工作器发送 paymentrequest 事件来启动基于 Web 的付款应用。不必提前注册 Service Worker。可以及时注册。
了解特殊优化
浏览器如何跳过付款请求界面并直接启动付款应用
在 Chrome 中,当调用 PaymentRequest 的 show() 方法时,Payment Request API 会显示浏览器提供的界面,称为“Payment Request 界面”。此界面允许用户选择付款应用。在付款请求界面中按 Continue(继续)按钮后,系统会启动所选的付款应用。
在启动付款应用之前显示付款请求界面会增加用户完成付款所需的步骤数。为了优化流程,浏览器可以将该信息的填充委托给支付应用,并在调用 show() 时直接启动支付应用,而无需显示 Payment Request 界面。
如需直接启动支付应用,必须满足以下条件:
show()通过用户手势(例如鼠标点击)触发。- 只有一个支付应用满足以下条件:
- 支持所请求的支付方式标识符。
基于 Web 的支付应用何时进行即时 (JIT) 注册?
无需用户事先明确访问基于 Web 的付款应用的网站并注册服务工作线程,即可启动此类应用。当用户选择使用基于 Web 的支付应用付款时,可以及时注册服务工作线程。注册时间有两种变体:
- 如果向用户显示付款请求界面,则应用会及时注册,并在用户点击继续时启动。
- 如果跳过 Payment Request 界面,则会及时注册支付应用并直接启动。跳过付款请求界面以启动即时注册的应用需要用户手势,这可防止意外注册跨源服务工作线程。
后续步骤
现在,您的支付应用已可被发现,接下来了解如何开发特定于平台的支付应用和基于 Web 的支付应用。