PaymentResponse

可用性有限

此特性不是基线特性,因为它在一些最广泛使用的浏览器中不起作用。

安全上下文: 此功能仅在安全上下文(HTTPS)中可用,且支持此功能的浏览器数量有限。

PaymentResponse 接口是 Payment Request API 的一部分,在用户选择支付方式并批准支付请求后返回。

EventTarget PaymentResponse

实例属性

PaymentResponse.details 只读

返回一个可 JSON 序列化的对象,该对象包含特定支付方式的消息,商户使用此消息来处理交易并确定资金是否成功转移。对象的内容取决于所使用的支付方式。开发者需要查阅控制该 URL 的人员以了解 details 对象的预期结构。

PaymentResponse.methodName 只读

返回用户所选支付方式的标识符,例如 Visa、Mastercard、PayPal 等。

PaymentResponse.payerEmail 只读

返回用户提供的电子邮件地址。此选项仅在 PaymentRequest() 构造函数的 options 参数中将 requestPayerEmail 选项设置为 true 时才存在。

PaymentResponse.payerName 只读

返回用户提供的姓名。此选项仅在 PaymentRequest() 构造函数的 options 参数中将 requestPayerName 选项设置为 true 时才存在。

PaymentResponse.payerPhone 只读

返回用户提供的电话号码。此选项仅在 PaymentRequest() 构造函数的 options 参数中将 requestPayerPhone 选项设置为 true 时才存在。

PaymentResponse.requestId 只读

返回产生当前响应的 PaymentRequest 的标识符。这与在 PaymentRequest() 构造函数中通过 details.id 提供的相同值。

PaymentResponse.shippingAddress 只读

返回用户提供的配送地址。此选项仅在 PaymentRequest() 构造函数的 options 参数中将 requestShipping 选项设置为 true 时才存在。

PaymentResponse.shippingOption 只读

返回用户选择的配送选项的 ID 属性。此选项仅在 PaymentRequest() 构造函数的 options 参数中将 requestShipping 选项设置为 true 时才存在。

实例方法

PaymentResponse.retry()

如果支付响应数据存在(且是可恢复的错误),此方法允许商户请求用户重试支付。该方法接受一个对象作为参数,用于向用户精确地指示支付响应存在什么问题,以便用户尝试纠正任何问题。

PaymentResponse.complete()

通知用户代理用户交互已结束。这将导致任何剩余的用户界面关闭。此方法仅应在 PaymentRequest.show() 方法返回的 Promise 之后调用。

PaymentResponse.toJSON()

返回一个表示此 PaymentResponse 对象的 JSON 对象

事件

使用 addEventListener() 监听此事件,或将事件监听器分配给此接口的 oneventname 属性。

payerdetailchange

在重试期间,当用户在填写支付请求表单时更改其个人信息时触发。允许开发者重新验证任何请求的用户数据(例如,电话号码或电子邮件地址),如果它们发生更改。

规范

规范
Payment Request API
# paymentresponse-interface

浏览器兼容性