The PaymentMethodChangeEvent interface of the Payment Request API describes the PaymentRequest/paymentmethodchange_event event which is fired by some payment handlers when the user switches payment instruments (e.g., a user selects a 'store' card to make a purchase while using Apple Pay). Available only in secure contexts.

PaymentMethodChangeEventInit

interface PaymentMethodChangeEventInit : PaymentRequestUpdateEventInit

MDN Reference

PaymentMethodData

interface PaymentMethodData

PaymentOptions

interface PaymentOptions

PaymentRequest

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

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.

PaymentRequestUpdateEvent

open class PaymentRequestUpdateEvent(val type: EventType<PaymentRequestUpdateEvent>, init: PaymentRequestUpdateEventInit = definedExternally) : Event

The PaymentRequestUpdateEvent interface is used for events sent to a PaymentRequest instance when changes are made to shipping-related information for a pending PaymentRequest. Available only in secure contexts.

PaymentRequestUpdateEventInit

interface PaymentRequestUpdateEventInit : EventInit

MDN Reference

PaymentResponse

open class PaymentResponse : EventTarget

The PaymentResponse interface of the Payment Request API is returned after a user selects a payment method and approves a payment request. Available only in secure contexts.

PaymentShippingOption

interface PaymentShippingOption

PaymentShippingType

sealed interface PaymentShippingType

PaymentValidationErrors

interface PaymentValidationErrors

Properties

delivery

val PaymentShippingType.Companion.delivery: PaymentShippingType

fail

val PaymentComplete.Companion.fail: PaymentComplete

PAYER_DETAIL_CHANGE

val PaymentRequestUpdateEvent.Companion.PAYER_DETAIL_CHANGE: EventType<PaymentRequestUpdateEvent>

payerDetailChangeEvent

val <C : PaymentResponse> C.payerDetailChangeEvent: EventInstance<PaymentRequestUpdateEvent, C, C>

MDN Reference

PAYMENT_METHOD_CHANGE

val PaymentMethodChangeEvent.Companion.PAYMENT_METHOD_CHANGE: EventType<PaymentMethodChangeEvent>

paymentMethodChangeEvent

val <C : PaymentRequest> C.paymentMethodChangeEvent: EventInstance<PaymentMethodChangeEvent, C, C>

MDN Reference

pickup

val PaymentShippingType.Companion.pickup: PaymentShippingType

shipping

val PaymentShippingType.Companion.shipping: PaymentShippingType

SHIPPING_ADDRESS_CHANGE

val PaymentRequestUpdateEvent.Companion.SHIPPING_ADDRESS_CHANGE: EventType<PaymentRequestUpdateEvent>

SHIPPING_OPTION_CHANGE

val PaymentRequestUpdateEvent.Companion.SHIPPING_OPTION_CHANGE: EventType<PaymentRequestUpdateEvent>

shippingAddressChangeEvent

val <C : PaymentRequest> C.shippingAddressChangeEvent: EventInstance<PaymentRequestUpdateEvent, C, C>

MDN Reference

shippingOptionChangeEvent

val <C : PaymentRequest> C.shippingOptionChangeEvent: EventInstance<PaymentRequestUpdateEvent, C, C>

MDN Reference

success

val PaymentComplete.Companion.success: PaymentComplete

unknown

val PaymentComplete.Companion.unknown: PaymentComplete

Functions

abort

inline suspend fun PaymentRequest.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.

asInit

inline fun PaymentMethodChangeEvent.asInit(): PaymentMethodChangeEventInit

inline fun PaymentRequestUpdateEvent.asInit(): PaymentRequestUpdateEventInit

canMakePayment

inline suspend fun PaymentRequest.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.

complete

inline suspend fun PaymentResponse.complete()

inline suspend fun PaymentResponse.complete(result: PaymentComplete)

The PaymentRequest method complete() of the Payment Request API notifies the user agent that the user interaction is over, and causes any remaining user interface to be closed.

retry

inline suspend fun PaymentResponse.retry()

inline suspend fun PaymentResponse.retry(errorFields: PaymentValidationErrors)

The PaymentResponse interface's retry() method makes it possible to ask the user to retry a payment after an error occurs during processing.

show

inline suspend fun PaymentRequest.show(): PaymentResponse

inline suspend fun PaymentRequest.show(detailsPromise: PaymentDetailsUpdate): 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.

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