Referencia del cliente

En esta referencia, se describen los métodos del 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 miembros.

new PaymentsClient(paymentOptions)

Argumentos

Propiedad Descripción
paymentOptions

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'}

Devoluciones

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

Mantas

Tipo Descripción
Error

No se admite el valor de la propiedad del entorno que se pasó.

Métodos del 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 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 los botones o elementos de confirmación de compra similares de tu página. Usa nuestra herramienta Personaliza tu botón para configurar un botón para tu caso de uso.

Argumentos

Nombre Descripción
options

Objeto que contiene pares clave-valor para la configuración de un botón. Consulta ButtonOptions para conocer las propiedades configurables.

Ejemplo: {onClick:onGooglePaymentButtonClicked}

Devoluciones

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

Mantas

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 del entorno de TEST, paymentMethodPresent siempre devuelve true.

Argumentos

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

Devoluciones

Tipo Descripción
Promise

Resolved: Es un objeto que contiene información sobre la capacidad de pago del usuario. Para obtener más información, consulta IsReadyToPayResponse.

Rechazado: Es 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ó tenía un formato incorrecto, no incluía los parámetros mínimos obligatorios para determinar la disposición de un usuario a pagar o contenía 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 satisfacer. 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 especificado en el parámetro de la solicitud que se pasó.

Argumentos

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

Devoluciones

Tipo Descripción
Promise

Resuelto: Es un objeto que contiene los datos del comprador solicitados. Consulta PaymentData para obtener más información.

Rechazado: 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

statusCode Descripción
CANCELED
  • No se admite el navegador actual ni el usuario de Google que accedió.
  • El comprador descartó la hoja de pagos de Google Pay sin autorizar el pago.
  • La solicitud se inició desde un contexto de seguridad que el agente de pagos o el navegador decidieron no satisfacer. 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 pagos de Google Pay rechazó el objeto PaymentDataRequest que se pasó. Una causa común son los parámetros PaymentMethodTokenizationSpecification faltantes o incompletos de tu puerta de enlace, o bien 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 obligatorios o contenía un parámetro o valor no válido.

prefetchPaymentData(paymentDataRequest)

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

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

Argumentos

Nombre Descripción
paymentDataRequest 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 la recuperación previa almacenado en caché.

onPaymentAuthorized(paymentData)

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

Argumentos

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

Devoluciones

Tipo Descripción
Promise

Resolved: Es un objeto que contiene información sobre los resultados de la transacción de pago. Para obtener más información, consulta PaymentAuthorizationResult.

Rechazado: Es un objeto de error con un mensaje y una intención de error que se renderizarán en la hoja de pagos. 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.

Argumentos

Nombre Descripción
intermediatePaymentData 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.

Devoluciones

Tipo Descripción
Promise

Resolved: Es un objeto que contiene información sobre los datos de pago, las opciones de envío y la información de transacción nuevos. Para obtener más información, consulta PaymentDataRequestUpdate.

Rechazado: Es un objeto de error con un mensaje y una intención de error que se renderizarán en la hoja de pagos. Para obtener más información, consulta PaymentDataError.