Referencia del cliente

En esta referencia, se describen los métodos de cliente de JavaScript que se deben usar 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 de miembros.

new PaymentsClient(paymentOptions)

Argumentos

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

Muestra

Tipo	Descripción
google.payments.api.PaymentsClient	Es el objeto PaymentsClient.

Arroja

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

Métodos de objetos

createButton(options)

El método de conveniencia se usa para generar un botón de pago de Google Pay con el estilo de la marca de Google Pay más reciente 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 nuestros lineamientos de desarrollo 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 herramienta Personaliza tu botón para configurar un botón para tu caso de uso.

Nota: Quitar los objetos de escucha de eventos onLoad y onClick cuando se implementa la API de createButton puede hacer 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 la configuración de un botón. Consulta ButtonOptions para conocer las propiedades configurables. Ejemplo: {onClick:onGooglePaymentButtonClicked}

Muestra

Tipo	Descripción
HTMLElement	Un elemento <button> de HTML dentro de un contenedor de contenido de flujo genérico, como un <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 devolver una forma de pago desde la API de Google Pay.

Si el navegador admite Google Pay, isReadyToPay devuelve 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 devuelva 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 devuelve true.

Advertencia: No se debe confiar en existingPaymentMethodRequired para determinar si se debe mostrar el botón de Google Pay. La propiedad existingPaymentMethodRequired se basa en las cookies y el seguimiento entre sitios. Si no están disponibles, no se devolverá la propiedad paymentMethodPresent, incluso si isReadyToPayRequest.existingPaymentMethodRequired se establece en true.

Argumentos

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

Muestra

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

Errores

Código de error

Descripción

DEVELOPER_ERROR

El objeto IsReadyToPayRequest que se pasó tenía un formato incorrecto, no incluía los parámetros mínimos requeridos para determinar si el usuario estaba listo para pagar o contenía un parámetro o un valor no válidos. 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 manera 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 proporcione otros datos obligatorios especificados en el parámetro de solicitud pasado.

Argumentos

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

Muestra

Tipo	Descripción
Promise	Resuelto: Es un objeto que contiene los datos del comprador solicitados. Consulta PaymentData para obtener más información. Rechazada: Es 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

Código de error	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 cumplir. Por lo general, es 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 pasado. 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 pasado tenía un formato incorrecto, le faltaban los parámetros mínimos requeridos o contenía un parámetro o un valor no válidos.

prefetchPaymentData(paymentDataRequest)

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

Las optimizaciones de carga 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. Consulta PaymentDataRequest para conocer las propiedades configurables. Un cambio en la propiedad transactionInfo no afecta el valor de carga 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 dinámicas de precios.

onPaymentAuthorized(paymentData)

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

Nota: Debes resolver la promesa que devuelve la devolución de llamada de onPaymentAuthorized en un plazo de 30 segundos. Si la promesa no se resuelve dentro de este período, se agota el tiempo de espera de la solicitud 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	Resolved: Es un objeto que contiene información sobre los resultados de las transacciones de pago. Para obtener más información, consulta PaymentAuthorizationResult. Rechazada: Un objeto de error con un intent de error y un mensaje que se renderizará 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 pagos, como la dirección de envío y las opciones de envío.

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

Argumentos

hola

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

Resolved: Es 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. Rechazada: Un objeto de error con un intent de error y un mensaje que se renderizará 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.