W3cubDocs

/Web APIs

PaymentResponse

Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.

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

EventTarget PaymentResponse

Instance properties

PaymentResponse.details Read only Secure context

Returns a JSON-serializable object that provides a payment method specific message used by the merchant to process the transaction and determine successful fund transfer. The contents of the object depend on the payment method being used. Developers need to consult whomever controls the URL for the expected shape of the details object.

PaymentResponse.methodName Read only Secure context

Returns the payment method identifier for the payment method that the user selected, for example, Visa, Mastercard, Paypal, etc.

PaymentResponse.payerEmail Read only Secure context Deprecated Non-standard

Returns the email address supplied by the user. This option is only present when the requestPayerEmail option is set to true in the options parameter of the PaymentRequest() constructor.

PaymentResponse.payerName Read only Secure context Deprecated Non-standard

Returns the name supplied by the user. This option is only present when the requestPayerName option is set to true in the options parameter of the PaymentRequest() constructor.

PaymentResponse.payerPhone Read only Secure context Deprecated Non-standard

Returns the phone number supplied by the user. This option is only present when the requestPayerPhone option is set to true in the options parameter of the PaymentRequest() constructor.

PaymentResponse.requestId Read only Secure context

Returns the identifier of the PaymentRequest that produced the current response. This is the same value supplied in the PaymentRequest() constructor by details.id.

PaymentResponse.shippingAddress Read only Secure context Deprecated Non-standard

Returns the shipping Address supplied by the user. This option is only present when the requestShipping option is set to true in the options parameter of the PaymentRequest() constructor.

PaymentResponse.shippingOption Read only Secure context Deprecated Non-standard

Returns the ID attribute of the shipping option selected by the user. This option is only present when the requestShipping option is set to true in the options parameter of the PaymentRequest() constructor.

Instance methods

PaymentResponse.retry() Secure context

If something is wrong with the payment response's data (and there is a recoverable error), this method allows a merchant to request that the user retry the payment. The method takes an object as argument, which is used to signal to the user exactly what is wrong with the payment response so they can try to correct any issues.

PaymentResponse.complete() Secure context

Notifies the user agent that the user interaction is over. This causes any remaining user interface to be closed. This method should only be called after the Promise returned by the PaymentRequest.show() method.

PaymentResponse.toJSON() Secure context

Returns a JSON object representing this PaymentResponse object.

Events

Listen to this event using addEventListener() or by assigning an event listener to the oneventname property of this interface.

payerdetailchange Secure context Deprecated Non-standard

Fired during a retry when the user makes changes to their personal information while filling out a payment request form. Allows the developer to revalidate any requested user data (e.g., the phone number or the email address) if it changes.

Specifications

Browser compatibility

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
PaymentResponse 60 15 55 No 47 11.1 No 53 No 41 11.3 6.0
complete 60 15 55 No 47 11.1 No 53 No 41 11.3 6.0
details 60 15 55 No 47 11.1 No 53 No 41 11.3 6.0
methodName 60 15 55 No 47 11.1 No 53 No 41 11.3 6.0
payerEmail 60 15 55 No 47 11.1 No 53 No 41 11.3 6.0
payerName 60 15 55 No 47 11.1 No 56 No 43 11.3 6.0
payerPhone 60 15 55 No 47 11.1 No 53 No 41 11.3 6.0
payerdetailchange_event 78 79 55 No 47 12.1 No 78 No 43 12.2 12.0
requestId 60 16 55 No 47 11.1 No 60 No 43 11.3 8.0
retry 78 79 55 No 47 12.1 No 78 No 43 11.3 10.0
shippingAddress 60 15 55 No 47 11.1 No 53 No 41 11.3 6.0
shippingOption 60 15 55 No 47 11.1 No 53 No 41 11.3 6.0
toJSON 60 15 55 No 47 11.1 No 55 No 42 11.3 6.0

© 2005–2023 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/PaymentResponse