Referencia del cliente

En esta referencia, se describen los métodos del cliente de JavaScript que se usan para implementar la API de Google Pay en tus aplicaciones web.

Constructor

Inicializa el objeto PaymentsClient. Debes llamar a este constructor antes de llamar a los métodos miembros.

new PaymentsClient(paymentOptions)

Argumentos

Propiedad	Descripción
paymentOptions	Es un objeto que contiene pares clave-valor de datos de configuración de la API de Google Pay. Consulta PaymentOptions para ver las diferentes propiedades configurables. Ejemplo: {environment:'PRODUCTION'}

Muestra

Tipo	Descripción
google.payments.api.PaymentsClient	El objeto PaymentsClient.

Arroja

Tipo	Descripción
Error	No se admite el valor de la propiedad de entorno que se pasó.

Métodos de objeto

createButton(options)

El método de conveniencia se usa para generar un botón de pago de Google Pay con la marca más reciente de Google Pay para insertarlo en una página web.

El HTMLElement generado incluye CSS insertado de forma dinámica y una imagen SVG alojada en la CDN de Google.

Consulta nuestras directrices de la marca para obtener más información sobre cómo seleccionar el color y el tipo de botón adecuados para el diseño de tu sitio. Es posible que debas modificar las dimensiones del botón para que coincidan con botones o elementos de confirmación de la compra similares en tu página. Usa nuestra Personaliza tu botón herramienta para configurar un botón para tu caso de uso.

Nota: Si quitas los objetos de escucha de eventos onLoad y onClick cuando implementas la API de createButton, es posible que el botón de pago de Google Pay no funcione como se espera.

Argumentos

Nombre	Descripción
options	Es un objeto que contiene pares clave-valor para una configuración de botón. Consulta ButtonOptions para ver las propiedades configurables. Ejemplo: {onClick:onGooglePaymentButtonClicked}

Muestra

Tipo	Descripción
HTMLElement	Un elemento HTML <button> dentro de un contenedor de contenido de flujo genérico como un elemento <div>.

Arroja

Tipo	Descripción
Error	No se estableció una propiedad obligatoria.

isReadyToPay(isReadyToPayRequest)

Usa el método isReadyToPay(isReadyToPayRequest) para determinar la capacidad de un usuario de mostrar una forma de pago desde la API de Google Pay.

Si el navegador admite Google Pay, isReadyToPay muestra true. Para determinar si el usuario accedió a una Cuenta de Google o si ya guardó una forma de pago en Google Pay, establece IsReadyToPayRequest.existingPaymentMethodRequired en true y verifica que paymentMethodPresent muestre true en la promesa resuelta. Para obtener más detalles, consulta IsReadyToPayResponse.

Si PaymentsClient se inicializa con una propiedad de entorno de TEST, paymentMethodPresent siempre muestra true.

Advertencia: existingPaymentMethodRequired no se debe confiar en cuando se determina si se debe mostrar el botón de Google Pay. La propiedad existingPaymentMethodRequired depende de las cookies y el seguimiento entre sitios. Si estos no están disponibles, no se mostrará la propiedad paymentMethodPresent, incluso si isReadyToPayRequest.existingPaymentMethodRequired está establecida en true.

Argumentos

Nombre	Descripción
isReadyToPayRequest	Es un objeto que contiene formas de pago admitidas por el comercio. Para obtener detalles sobre las diferentes propiedades que se pueden configurar, consulta IsReadyToPayRequest.

Muestra

Tipo	Descripción
Promise	Resuelto: Un objeto que contiene información sobre la capacidad de pago del usuario. Para obtener más información, consulta IsReadyToPayResponse. Rechazado: Un objeto de error que contiene más información sobre el motivo del rechazo. Para obtener más información, consulta PaymentsError.

Errores

statusCode

Descripción

DEVELOPER_ERROR

El objeto IsReadyToPayRequest que se pasó no tenía el formato correcto, no incluía los parámetros mínimos requeridos para determinar si un usuario está listo para pagar o contiene un parámetro o valor no válido. La solicitud se inició desde un contexto de seguridad que el agente de pagos o el navegador decidieron no completar. Por lo general, se trata de un error de contexto de navegador no seguro.

loadPaymentData(paymentDataRequest)

Este método presenta una hoja de pago de Google Pay que permite seleccionar una forma de pago y parámetros configurados de forma opcional.

Se debe llamar a este método mientras el navegador procesa un comportamiento de activación como resultado de un evento de clic. Es posible que se muestre una ventana emergente al usuario para que seleccione una forma de pago o cualquier otro dato requerido que se especifique en el parámetro de solicitud que se pasó.

Argumentos

Nombre	Descripción
paymentDataRequest	Es un objeto que contiene pares clave-valor de la configuración completa de la API de Google Pay configuración. Consulta PaymentDataRequest para ver las propiedades configurables.

Muestra

Tipo	Descripción
Promise	Resuelto: Un objeto que contiene los datos del comprador solicitados. Consulta PaymentData para obtener más información. Rechazado: Un objeto que contiene un código de error y más información sobre el motivo del rechazo. Consulta PaymentsError para obtener más información.

Errores

statusCode	Descripción
CANCELED	No se admite el navegador actual ni el usuario de Google que accedió. El comprador descartó la hoja de pago de Google Pay sin autorización de pago. La solicitud se inició desde un contexto de seguridad que el agente de pagos o el navegador decidieron no completar. Por lo general, se trata de un contexto de navegador no seguro. Se llamó al método mientras ya se mostraba la hoja de pago de Google Pay. La hoja de pago de Google Pay rechazó el objeto PaymentDataRequest que se pasó. Una causa común son los parámetros PaymentMethodTokenizationSpecification faltantes o incompletos para tu puerta de enlace o los valores de parámetros no válidos.
DEVELOPER_ERROR	El objeto PaymentDataRequest que se pasó no tenía el formato correcto, no incluía los parámetros mínimos requeridos o contenía un parámetro o valor no válido.

prefetchPaymentData(paymentDataRequest)

Usa este método para obtener previamente una configuración de PaymentDataRequest y mejorar el tiempo de ejecución de loadPaymentData en la interacción del usuario posterior. No se muestra ningún valor.

Las optimizaciones de obtención previa están disponibles en Chrome para Android.

Argumentos

Nombre	Descripción
paymentDataRequest	Es un objeto que contiene pares clave-valor de la configuración completa de la API de Google Pay configuración. Consulta PaymentDataRequest para ver las propiedades configurables. Un cambio en la propiedad transactionInfo no afecta el valor de obtención previa almacenado en caché.

Devoluciones de llamada de datos de pago

Los siguientes controladores de devolución de llamada se pueden pasar a PaymentOptions.paymentDataCallbacks para admitir la autorización de pagos y las actualizaciones de precios dinámicas.

onPaymentAuthorized(paymentData)

Se llama a este método cuando se autoriza un pago en la hoja de pago.

Nota: Debes para resolver la promesa que muestra la devolución de llamada onPaymentAuthorized en un plazo de 30 segundos. Si y no se resuelve la promesa dentro de este período, la solicitud se agota y la hoja de Google Pay muestra un error CALLBACK_TIMED_OUT al usuario.

Argumentos

Nombre	Descripción
paymentData	Es un objeto que contiene los datos del comprador solicitados. Para obtener más información, consulta PaymentData.

Muestra

Tipo	Descripción
Promise	Resuelto: Un objeto que contiene información sobre los resultados de la transacción de pago. Para obtener más información, consulta PaymentAuthorizationResult. Rechazado: Un objeto de error con un intent y un mensaje de error que se renderizarán en la hoja de pago. Para obtener más información, consulta PaymentDataError.

onPaymentDataChanged(intermediatePaymentData)

Este método controla los cambios en los datos de pago en la hoja de pago, como la dirección de envío y las opciones de envío.

Nota: También se debe establecer la devolución de llamada onPaymentAuthorized para usar la devolución de llamada onPaymentDataChanged. Debes para resolver la promesa que muestra la devolución de llamada onPaymentDataChanged en un plazo de 30 segundos. Si y no se resuelve la promesa dentro de este período, la solicitud se agota y la hoja de Google Pay muestra un error CALLBACK_TIMED_OUT al usuario.

Argumentos

Nombre	Descripción
intermediatePaymentData	Es un objeto que contiene la dirección y la opción de envío seleccionadas en la hoja de pago. Para obtener más información, consulta IntermediatePaymentData.

Muestra

Tipo

Descripción

Promise

Resuelto: Un objeto que contiene información sobre la nueva información de la transacción, las opciones de envío y los errores de datos de pago. Para obtener más información, consulta PaymentDataRequestUpdate. Rechazado: Un objeto de error con un intent y un mensaje de error que se renderizarán en la hoja de pago. Para obtener más información, consulta PaymentDataError. Nota: El rechazo no actualiza el contenido de la hoja de pago; solo muestra un mensaje de error al usuario.