kotlin-browser/web.payment/PaymentRequest

PaymentRequest

open class PaymentRequest( methodData: ReadonlyArray<PaymentMethodData>, details: PaymentDetailsInit, options: PaymentOptions = definedExternally) : EventTarget(source)

The Payment Request API's PaymentRequest interface is the primary access point into the API, and lets web content and apps accept payments from the end user on behalf of the operator of the site or the publisher of the app. Available only in secure contexts.

MDN Reference

Constructors

PaymentRequest

constructor(methodData: ReadonlyArray<PaymentMethodData>, details: PaymentDetailsInit, options: PaymentOptions = definedExternally)

Properties

val id: String

The id read-only attribute of the When constructing an instance of the PaymentRequest, you are able to supply an custom id.

onpaymentmethodchange

var onpaymentmethodchange: EventHandler<PaymentMethodChangeEvent, PaymentRequest, PaymentRequest>?

MDN Reference

paymentMethodChangeEvent

val paymentMethodChangeEvent: EventInstance<PaymentMethodChangeEvent, PaymentRequest, PaymentRequest>

MDN Reference

shippingAddressChangeEvent

val shippingAddressChangeEvent: EventInstance<PaymentRequestUpdateEvent, PaymentRequest, PaymentRequest>

MDN Reference

shippingOptionChangeEvent

val shippingOptionChangeEvent: EventInstance<PaymentRequestUpdateEvent, PaymentRequest, PaymentRequest>

MDN Reference

Functions

abort

suspend fun abort()

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

abortAsync

fun abortAsync(): Promise<Void>

canMakePayment

suspend fun canMakePayment(): Boolean

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

canMakePaymentAsync

fun canMakePaymentAsync(): Promise<JsBoolean>

dispatchEvent

fun dispatchEvent(event: Event): Boolean

show

suspend fun show(detailsPromise: PromiseLike<PaymentDetailsUpdate>): PaymentResponse

suspend fun show(detailsPromise: PaymentDetailsUpdate = definedExternally): PaymentResponse

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

showAsync

fun showAsync(detailsPromise: PromiseLike<PaymentDetailsUpdate>): Promise<PaymentResponse>

fun showAsync(detailsPromise: PaymentDetailsUpdate = definedExternally): Promise<PaymentResponse>

when

fun <T : Event> when(type: EventType<T>, options: ObservableEventListenerOptions?): Observable<T>