大网数据广告活动
Web 标准与前端开发

PaymentRequest: PaymentRequest() constructor

· 52CE 我爱测

The **`PaymentRequest()`** constructor creates a new PaymentRequest object which will be used to handle the process of generating, validating, and submitting a payment request.

Payment Request API

The PaymentRequest() constructor creates a new PaymentRequest object which will be used to handle the process of generating, validating, and submitting a payment request.

Syntax

new PaymentRequest(methodData, details)
new PaymentRequest(methodData, details, options)

Parameters

  • methodData

    • : Contains an array of identifiers for the payment methods the merchant website accepts and any associated payment method specific data. Each item in the array contains the following fields:
      • supportedMethods

      • data

        • : A JSON-serializable object that provides optional information that might be needed by the supported payment methods. This has to conform to the type expected by the payment handler indicated by supportedMethods. Developers need to consult whomever controls the payment methods for the expected shape of the data object. If supportedMethods is secure-payment-confirmation, then data needs to conform to the SecurePaymentConfirmationRequest dictionary.
  • details

    • : Provides information about the requested transaction. This parameter contains the following fields:
      • total
        • : The total amount of the payment request.
      • id
        • : A free-form identifier for this payment request. If a value is not supplied, the browser will construct one.
      • displayItems
        • : An array of optional line items for the payment request that the user agent may display, such as product details, tax, and shipping.
      • shippingOptions
        • : The shipping options the user may choose from. If this sequence is blank, it indicates the merchant cannot ship to the current shipping address. The default shipping option may be indicated in this sequence.
      • modifiers
        • : Modifiers for specific payment methods; for example, adjusting the total amount based on the payment method. This parameter contains the following fields:
          • additionalDisplayItems
            • : An array of items to be appended to the details.displayItems property. This property is commonly used to add a discount or surcharge line item indicating the different amount in details.modifiers.total.
          • data
            • : A JSON-serializable object that provides optional information that might be needed by the supported payment methods.
          • total
            • : A total amount for the payment request that overrides value in details.total. This is typically used when details.modifiers.additionalItems adds a discount or a purchase to the request.
  • options

    • : Lets you set options that control the behavior of the user agent. This parameter contains the following fields:
      • requestPayerName
        • : A Boolean indicating whether the user agent should collect the payer's name and submit it with the payment request. The default is false.
      • requestPayerEmail
        • : A Boolean indicating whether the user agent should collect the payer's email address and submit it with the payment request. The default is false.
      • requestPayerPhone
        • : A Boolean indicating whether the user agent should collect the payer's phone number and submit it with the payment request. The default is false.
      • requestShipping
        • : A Boolean indicating whether the user agent should collect the payer's shipping address and submit it with the payment request. If you set this type to true, you should select an appropriate shippingType. The default is false.
      • shippingType
        • : Lets you specify how the user interface refers to shipping when the word 'shipping' isn't appropriate for your use case. For example, in English speaking countries you would say "pizza delivery" not "pizza shipping". Valid values are "shipping", "delivery", and "pickup". Quotation marks must be included. The default value is "shipping".

Return value

A new PaymentRequest object, configured for use as configured by the input parameters.

Exceptions

Examples

The following example shows minimal functionality and focuses instead on showing the complete context of instantiating a PaymentRequest object.

const supportedInstruments = [
  {
    supportedMethods: "https://example.com/pay",
  },
];

const details = {
  total: { label: "Donation", amount: { currency: "USD", value: "65.00" } },
  displayItems: [
    {
      label: "Original donation amount",
      amount: { currency: "USD", value: "65.00" },
    },
  ],
  shippingOptions: [
    {
      id: "standard",
      label: "Standard shipping",
      amount: { currency: "USD", value: "0.00" },
      selected: true,
    },
  ],
};

const options = { requestShipping: true };

try {
  const request = new PaymentRequest(supportedInstruments, details, options);
  // Add event listeners here.
  // Call show() to trigger the browser's payment flow.
  request
    .show()
    .then((instrumentResponse) => {
      // Do something with the response from the UI.
    })
    .catch((err) => {
      // Do something with the error from request.show().
    });
} catch (e) {
  // Catch any other errors.
}

Specifications

Browser compatibility

来源:MDN Web Docs / Mozilla 贡献者 · 作者与贡献记录 · CC BY-SA 2.5。离线整理了版式、链接和媒体显示。

资料来源与适用范围

资料来源
MDN Web Docs / Mozilla 贡献者
适用范围
请按文中版本与环境说明核对
内容语言
中文;命令、路径和错误标识保留技术原文
本地收录日期
2026-11-15
授权说明
CC BY-SA 2.5

正文与所需资源由本站本地存储。查看来源及更新记录 ↗

请按适用版本和实际日志确认原因;本站没有对每一种系统或设备逐项执行文中的操作。