Class PaymentRequestEvent

Namespace

CSharpToJavaScript.APIs.JS

Assembly

CSharpToJavaScript.dll

NOTE

Experimental

The PaymentRequestEvent interface of the {{domxref("Payment Handler API", "", "", "nocode")}} is the object passed to a payment handler when a PaymentRequest is made.

[Value("PaymentRequestEvent")]
public class PaymentRequestEvent : ExtendableEvent

Inheritance

object

Event

ExtendableEvent

PaymentRequestEvent

Inherited Members

ExtendableEvent.WaitUntil(Task<dynamic>)

Event.NONE

Event.CAPTURING_PHASE

Event.AT_TARGET

Event.BUBBLING_PHASE

Event.ComposedPath()

Event.StopPropagation()

Event.StopImmediatePropagation()

Event.PreventDefault()

Event.InitEvent(string, bool, bool)

Event.Type

Event.Target

Event.SrcElement

Event.CurrentTarget

Event.EventPhase

Event.CancelBubble

Event.Bubbles

Event.Cancelable

Event.ReturnValue

Event.DefaultPrevented

Event.Composed

Event.IsTrusted

Event.TimeStamp

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Remarks

-Web-based payment apps overview
-Setting up a payment method
-Life of a payment transaction
-Using the Payment Request API
-Payment processing concepts

See also on MDN

Constructors

PaymentRequestEvent()

public PaymentRequestEvent()

PaymentRequestEvent(string, PaymentRequestEventInit)

NOTE

Experimental

The PaymentRequestEvent constructor creates a new PaymentRequestEvent object instance.

public PaymentRequestEvent(string type, PaymentRequestEventInit eventInitDict = null)

Parameters

type string

eventInitDict PaymentRequestEventInit

Remarks

-Web-based payment apps overview
-Setting up a payment method
-Life of a payment transaction
-Using the Payment Request API
-Payment processing concepts

See also on MDN

Properties

MethodData

NOTE

Experimental

The methodData read-only property of the
PaymentRequestEvent interface returns an array of
PaymentMethodData objects containing payment method identifiers for the
payment methods that the website accepts and any associated payment method-specific
data.

[Value("methodData")]
public PaymentMethodData[] MethodData { get; }

Property Value

PaymentMethodData[]

An array of PaymentMethodData objects. Each object contains the following properties:

Remarks

-Web-based payment apps overview
-Setting up a payment method
-Life of a payment transaction
-Using the Payment Request API
-Payment processing concepts

See also on MDN

Modifiers

NOTE

Experimental

The modifiers read-only property of the
PaymentRequestEvent interface returns an {{jsxref("Array")}} of PaymentDetailsModifier objects containing modifiers for payment details.

[Value("modifiers")]
public PaymentDetailsModifier[] Modifiers { get; }

Property Value

PaymentDetailsModifier[]

An array of objects containing modifiers for payment details. These objects contain the following properties:

Remarks

-Web-based payment apps overview
-Setting up a payment method
-Life of a payment transaction
-Using the Payment Request API
-Payment processing concepts

See also on MDN

PaymentOptions

[Value("paymentOptions")]
public Object? PaymentOptions { get; }

Property Value

Object

PaymentRequestId

NOTE

Experimental

The paymentRequestId read-only property of the
PaymentRequestEvent interface returns the ID of the
PaymentRequest object.

[Value("paymentRequestId")]
public string PaymentRequestId { get; }

Property Value

string

A string containing the ID.

Remarks

-Web-based payment apps overview
-Setting up a payment method
-Life of a payment transaction
-Using the Payment Request API
-Payment processing concepts

See also on MDN

PaymentRequestOrigin

NOTE

Experimental

The paymentRequestOrigin read-only property of the
PaymentRequestEvent interface returns the origin where the
PaymentRequest object was initialized.

[Value("paymentRequestOrigin")]
public string PaymentRequestOrigin { get; }

Property Value

string

A string.

Remarks

-Web-based payment apps overview
-Setting up a payment method
-Life of a payment transaction
-Using the Payment Request API
-Payment processing concepts

See also on MDN

ShippingOptions

[Value("shippingOptions")]
public PaymentShippingOption[]? ShippingOptions { get; }

Property Value

PaymentShippingOption[]

TopOrigin

NOTE

Experimental

The topOrigin read-only property of the
PaymentRequestEvent interface returns the top-level payee origin where
the PaymentRequest object was initialized.

[Value("topOrigin")]
public string TopOrigin { get; }

Property Value

string

A string.

Remarks

-Web-based payment apps overview
-Setting up a payment method
-Life of a payment transaction
-Using the Payment Request API
-Payment processing concepts

See also on MDN

Total

NOTE

Experimental

The total read-only property of the PaymentRequestEvent interface returns a
PaymentCurrencyAmount object containing the total amount being requested for payment.

[Value("total")]
public Object Total { get; }

Property Value

Object

A PaymentCurrencyAmount object. This object contains the following properties:

Remarks

-Web-based payment apps overview
-Setting up a payment method
-Life of a payment transaction
-Using the Payment Request API
-Payment processing concepts

See also on MDN

Methods

ChangePaymentMethod(string, Object?)

NOTE

Experimental

The changePaymentMethod() method of the PaymentRequestEvent interface is used by the payment handler to get an updated total, given such payment method details as the billing address.

[Value("changePaymentMethod")]
public Task<PaymentRequestDetailsUpdate?> ChangePaymentMethod(string methodName, Object? methodDetails = null)

Parameters

methodName string

methodDetails Object

Returns

Task<PaymentRequestDetailsUpdate>

A Promise that resolves with a PaymentRequestDetailsUpdate object. This object contains the following properties:

Remarks

When this method is invoked, a PaymentMethodChangeEvent is fired.

-Web-based payment apps overview
-Setting up a payment method
-Life of a payment transaction
-Using the Payment Request API
-Payment processing concepts

See also on MDN

ChangeShippingAddress(AddressInit)

[Value("changeShippingAddress")]
public Task<PaymentRequestDetailsUpdate?> ChangeShippingAddress(AddressInit shippingAddress = null)

Parameters

shippingAddress AddressInit

Returns

Task<PaymentRequestDetailsUpdate>

ChangeShippingOption(string)

[Value("changeShippingOption")]
public Task<PaymentRequestDetailsUpdate?> ChangeShippingOption(string shippingOption)

Parameters

shippingOption string

Returns

Task<PaymentRequestDetailsUpdate>

OpenWindow(string)

NOTE

Experimental

The openWindow() method of the PaymentRequestEvent interface opens the specified URL in a new window, only if the given URL is on the same origin as the calling page. It returns a {{jsxref("Promise")}} that resolves with a reference to a WindowClient.

[Value("openWindow")]
public Task<WindowClient?> OpenWindow(string url)

Parameters

url string

Returns

Task<WindowClient>

A Promise that resolves with a reference to a
WindowClient.

Remarks

-Web-based payment apps overview
-Setting up a payment method
-Life of a payment transaction
-Using the Payment Request API
-Payment processing concepts

See also on MDN

RespondWith(Task<PaymentHandlerResponse>)

NOTE

Experimental

The respondWith() method of the PaymentRequestEvent interface prevents the default event handling and allows you to provide a {{jsxref("Promise")}} for a payment handler response object yourself.

[Value("respondWith")]
public GlobalObject.Undefined RespondWith(Task<PaymentHandlerResponse> handlerResponsePromise)

Parameters

handlerResponsePromise Task<PaymentHandlerResponse>

Returns

GlobalObject.Undefined

None (GlobalObject.Undefined).

Remarks

-Web-based payment apps overview
-Setting up a payment method
-Life of a payment transaction
-Using the Payment Request API
-Payment processing concepts

See also on MDN