kotlin-browser/web.payment/PaymentResponse

PaymentResponse

class PaymentResponse : EventTarget(source)

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.

MDN Reference

Properties

details

val details: JsAny?

The details read-only property of the provides a payment method specific message used by the merchant to process the transaction and determine a successful funds transfer.

methodName

val methodName: String

The methodName read-only property of the PaymentResponse interface returns a string uniquely identifying the payment handler selected by the user.

onpayerdetailchange

var onpayerdetailchange: EventHandler<PaymentRequestUpdateEvent, PaymentResponse, PaymentResponse>?

MDN Reference

payerDetailChangeEvent

val payerDetailChangeEvent: EventInstance<PaymentRequestUpdateEvent, PaymentResponse, PaymentResponse>

MDN Reference

payerEmail

val payerEmail: String?

The payerEmail read-only property of the PaymentResponse interface returns the email address supplied by the user.

payerName

val payerName: String?

The payerName read-only property of the option is only present when the requestPayerName option is set to true in the options parameter of the A string containing the payer name.

payerPhone

val payerPhone: String?

The payerPhone read-only property of the PaymentResponse interface returns the phone number supplied by the user.

requestId

val requestId: String

The requestId read-only property of the the PaymentResponse() constructor by details.id.

shippingAddress

val shippingAddress: PaymentAddress?

The shippingAddress read-only property of the PaymentRequest interface returns a PaymentAddress object containing the shipping address provided by the user.

shippingOption

val shippingOption: String?

The shippingOption read-only property of the PaymentRequest interface returns the ID attribute of the shipping option selected by the user.

Functions

complete

suspend fun complete(result: PaymentComplete = definedExternally)

The PaymentRequest method complete() of the Payment Request API notifies the user interface to be closed.

completeAsync

fun completeAsync(result: PaymentComplete = definedExternally): Promise<Void>

dispatchEvent

fun dispatchEvent(event: Event): Boolean

retry

suspend fun retry(errorFields: PaymentValidationErrors = definedExternally)

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

retryAsync

fun retryAsync(errorFields: PaymentValidationErrors = definedExternally): Promise<Void>

toJSON

fun toJSON(): JsAny

The toJSON() method of the PaymentResponse interface is a Serialization; it returns a JSON representation of the PaymentResponse object.

when

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