Liking cljdoc? Tell your friends :D

web.payments.PaymentRequest

The Payment Request API's PaymentRequest interface the primary point into the API, and lets web content and apps accept payments the end user on behalf of the operator of the site or the publisher the app.

The Payment Request API's PaymentRequest interface the primary
point into the API, and lets web content and apps accept payments
the end user on behalf of the operator of the site or the publisher
the app.
raw docstring

abortcljs

(abort this)

Method.

[Experimental]

The PaymentRequest.abort() method of the web.payments.PaymentRequest causes the user agent to end the payment request and to remove user interface that might be shown.

PaymentRequest.abort();

See also: https://developer.mozilla.org/en-US/docs/Web/API/PaymentRequest/abort

Method.

[Experimental]

The PaymentRequest.abort() method of the `web.payments.PaymentRequest`
causes the user agent to end the payment request and to remove
user interface that might be shown.

`PaymentRequest.abort();`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/PaymentRequest/abort`
sourceraw docstring

can-make-paymentcljs

(can-make-payment this & args)

Method.

The web.payments.PaymentRequest method canMakePayment() determines or not the request is configured in a way that is compatible at least one payment method supported by the user agent.

`paymentRequest.canMakePayment() .then( canPay => { ... }) .catch( error => { ... })

canPay = await paymentRequest.canMakePayment();`

See also: https://developer.mozilla.org/en-US/docs/Web/API/PaymentRequest/canMakePayment

Method.

The `web.payments.PaymentRequest` method canMakePayment() determines
or not the request is configured in a way that is compatible
at least one payment method supported by the user agent.

`paymentRequest.canMakePayment()
.then( canPay => { ... })
.catch( error => { ... })

canPay = await paymentRequest.canMakePayment();`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/PaymentRequest/canMakePayment`
sourceraw docstring

constructorcljs

(constructor & args)

Constructor.

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

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

supportedMethods For early implementations of the spec, this was a sequence of identifiers for payment methods that the merchant website accepts. Starting with more recent browsers, this parameter is more generic than credit cards, it is a single web.DOMString, and the meaning of the data parameter changes with the supportedMethods. For example, the basic card payment method is selected by specifying the string basic-card here. 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. For basic credit card services, this structure should match the web.payments.BasicCardRequest dictionary.

details Provides information about the requested transaction. This parameter contains the following fields:

total The total amount of the payment request. id Optional 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. This has to conform to the structure defined in the web.payments.BasicCardRequest dictionary. 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 surchase to the request.

options Optional 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".

See also: https://developer.mozilla.org/en-US/docs/Web/API/PaymentRequest/PaymentRequest

Constructor.

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

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

supportedMethods
For early implementations of the spec, this was a sequence of identifiers for payment methods that the merchant website accepts. Starting with more recent browsers, this parameter is more generic than credit cards, it is a single `web.DOMString`, and the meaning of the data parameter changes with the supportedMethods. For example, the basic card payment method is selected by specifying the string basic-card here.
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. For basic credit card services, this structure should match the `web.payments.BasicCardRequest` dictionary.


details
Provides information about the requested transaction. This parameter contains the following fields:

total
The total amount of the payment request.
id Optional
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. This has to conform to the structure defined in the `web.payments.BasicCardRequest` dictionary.
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 surchase to the request.




options Optional
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\".

See also: `https://developer.mozilla.org/en-US/docs/Web/API/PaymentRequest/PaymentRequest`
sourceraw docstring

idcljs

(id this)

Property.

[Read Only] [Experimental]

The id read-only attribute of the web.payments.PaymentRequest returns a unique identifier for a particular web.payments.PaymentRequest

var id = paymentRequest.id

See also: https://developer.mozilla.org/en-US/docs/Web/API/PaymentRequest/id

Property.

[Read Only]
[Experimental]

The id read-only attribute of the `web.payments.PaymentRequest`
returns a unique identifier for a particular `web.payments.PaymentRequest`

`var id = paymentRequest.id`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/PaymentRequest/id`
sourceraw docstring

onmerchantvalidationcljs

(onmerchantvalidation this)

Property.

The web.payments.PaymentRequest event handler onmerchantvalidation invoked when the merchantvalidation

paymentRequest.onmerchantvalidation = eventHandlerFunction;

See also: https://developer.mozilla.org/en-US/docs/Web/API/PaymentRequest/onmerchantvalidation

Property.

The `web.payments.PaymentRequest` event handler onmerchantvalidation
invoked when the merchantvalidation

`paymentRequest.onmerchantvalidation = eventHandlerFunction;`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/PaymentRequest/onmerchantvalidation`
sourceraw docstring

onpaymentmethodchangecljs

(onpaymentmethodchange this)

Property.

The web.payments.PaymentRequest event handler onpaymentmethodchange invoked when the paymentmethodchange

`PaymentRequest.addEventListener('paymentmethodchange', paymentMethodChangeEvent => { ... });

PaymentRequest.onpaymentmethodchange = function(paymentMethodChangeEvent) { ... };`

See also: https://developer.mozilla.org/en-US/docs/Web/API/PaymentRequest/onpaymentmethodchange

Property.

The `web.payments.PaymentRequest` event handler onpaymentmethodchange
invoked when the paymentmethodchange

`PaymentRequest.addEventListener('paymentmethodchange', paymentMethodChangeEvent => { ... });

PaymentRequest.onpaymentmethodchange = function(paymentMethodChangeEvent) { ... };`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/PaymentRequest/onpaymentmethodchange`
sourceraw docstring

onshippingaddresschangecljs

(onshippingaddresschange this)

Property.

The onshippingaddresschange event of the web.payments.PaymentRequest is fired whenever the user changes their shipping address, including an address is added by the user for the first time.

`PaymentRequest.addEventListener('shippingaddresschange', shippingAddressChangeEvent => { ... });

PaymentRequest.onshippingaddresschange = function(shippingAddressChangeEvent) { ... };`

See also: https://developer.mozilla.org/en-US/docs/Web/API/PaymentRequest/onshippingaddresschange

Property.

The onshippingaddresschange event of the `web.payments.PaymentRequest`
is fired whenever the user changes their shipping address, including
an address is added by the user for the first time.

`PaymentRequest.addEventListener('shippingaddresschange', shippingAddressChangeEvent => { ... });

PaymentRequest.onshippingaddresschange = function(shippingAddressChangeEvent) { ... };`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/PaymentRequest/onshippingaddresschange`
sourceraw docstring

set-onmerchantvalidation!cljs

(set-onmerchantvalidation! this val)

Property.

The web.payments.PaymentRequest event handler onmerchantvalidation invoked when the merchantvalidation

paymentRequest.onmerchantvalidation = eventHandlerFunction;

See also: https://developer.mozilla.org/en-US/docs/Web/API/PaymentRequest/onmerchantvalidation

Property.

The `web.payments.PaymentRequest` event handler onmerchantvalidation
invoked when the merchantvalidation

`paymentRequest.onmerchantvalidation = eventHandlerFunction;`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/PaymentRequest/onmerchantvalidation`
sourceraw docstring

set-onpaymentmethodchange!cljs

(set-onpaymentmethodchange! this val)

Property.

The web.payments.PaymentRequest event handler onpaymentmethodchange invoked when the paymentmethodchange

`PaymentRequest.addEventListener('paymentmethodchange', paymentMethodChangeEvent => { ... });

PaymentRequest.onpaymentmethodchange = function(paymentMethodChangeEvent) { ... };`

See also: https://developer.mozilla.org/en-US/docs/Web/API/PaymentRequest/onpaymentmethodchange

Property.

The `web.payments.PaymentRequest` event handler onpaymentmethodchange
invoked when the paymentmethodchange

`PaymentRequest.addEventListener('paymentmethodchange', paymentMethodChangeEvent => { ... });

PaymentRequest.onpaymentmethodchange = function(paymentMethodChangeEvent) { ... };`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/PaymentRequest/onpaymentmethodchange`
sourceraw docstring

set-onshippingaddresschange!cljs

(set-onshippingaddresschange! this val)

Property.

The onshippingaddresschange event of the web.payments.PaymentRequest is fired whenever the user changes their shipping address, including an address is added by the user for the first time.

`PaymentRequest.addEventListener('shippingaddresschange', shippingAddressChangeEvent => { ... });

PaymentRequest.onshippingaddresschange = function(shippingAddressChangeEvent) { ... };`

See also: https://developer.mozilla.org/en-US/docs/Web/API/PaymentRequest/onshippingaddresschange

Property.

The onshippingaddresschange event of the `web.payments.PaymentRequest`
is fired whenever the user changes their shipping address, including
an address is added by the user for the first time.

`PaymentRequest.addEventListener('shippingaddresschange', shippingAddressChangeEvent => { ... });

PaymentRequest.onshippingaddresschange = function(shippingAddressChangeEvent) { ... };`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/PaymentRequest/onshippingaddresschange`
sourceraw docstring

shipping-addresscljs

(shipping-address this)

Property.

[Read Only] [Experimental]

The shippingAddress read-only property of the web.payments.PaymentRequest returns the shipping address provided by the user. It is null default.

var paymentAddress = PaymentRequest.shippingAddress;

See also: https://developer.mozilla.org/en-US/docs/Web/API/PaymentRequest/shippingAddress

Property.

[Read Only]
[Experimental]

The shippingAddress read-only property of the `web.payments.PaymentRequest`
returns the shipping address provided by the user. It is null
default.

`var paymentAddress = PaymentRequest.shippingAddress;`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/PaymentRequest/shippingAddress`
sourceraw docstring

shipping-optioncljs

(shipping-option this)

Property.

[Read Only] [Experimental]

The shippingOption read-only attribute of the web.payments.PaymentRequest returns either the id of a selected shipping option, null (if shipping option was set to be selected) or a shipping option by the user. It is initially null by when no "selected" shipping are provided.

// Returns the id of the selected PaymentShippingOption var shippingOption = request.shippingOption;

See also: https://developer.mozilla.org/en-US/docs/Web/API/PaymentRequest/shippingOption

Property.

[Read Only]
[Experimental]

The shippingOption read-only attribute of the `web.payments.PaymentRequest`
returns either the id of a selected shipping option, null (if
shipping option was set to be selected) or a shipping option
by the user. It is initially null by when no \"selected\" shipping
are provided.

`// Returns the id of the selected PaymentShippingOption
var shippingOption = request.shippingOption;`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/PaymentRequest/shippingOption`
sourceraw docstring

shipping-typecljs

(shipping-type this)

Property.

[Read Only] [Experimental]

The shippingType read-only property of the web.payments.PaymentRequest returns one of "shipping", "delivery", "pickup", or null one was not provided by the constructor.

var shippingType = paymentRequest.shippingType

See also: https://developer.mozilla.org/en-US/docs/Web/API/PaymentRequest/shippingType

Property.

[Read Only]
[Experimental]

The shippingType read-only property of the `web.payments.PaymentRequest`
returns one of \"shipping\", \"delivery\", \"pickup\", or null
one was not provided by the constructor.

`var shippingType = paymentRequest.shippingType`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/PaymentRequest/shippingType`
sourceraw docstring

showcljs

(show this details-promise)

Method.

The web.payments.PaymentRequest interface's show() method instructs user agent to begin the process of showing and handling the user for the payment request to the user.

paymentPromise = paymentRequest.show(detailsPromise);

See also: https://developer.mozilla.org/en-US/docs/Web/API/PaymentRequest/show

Method.

The `web.payments.PaymentRequest` interface's show() method instructs
user agent to begin the process of showing and handling the user
for the payment request to the user.

`paymentPromise = paymentRequest.show(detailsPromise);`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/PaymentRequest/show`
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close