Referencia de 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 miembro.

new PaymentsClient(paymentOptions)

Argumentos

Propiedad Descripción
paymentOptions

Objeto que contiene pares clave-valor de datos de configuración de la API Google Pay. Consulta las diferentes propiedades configurables en PaymentOptions.

Ejemplo: {environment:'PRODUCTION'}

Devoluciones

Tipo Descripción
google.payments.api.PaymentsClient Objeto PaymentsClient.

Mantas

Tipo Descripción
Error

El valor de la propiedad de entorno proporcionado no se admite.

Métodos de objeto

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 más reciente de Google Pay para insertarlo en una página web.

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

Consulta nuestras directrices de 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 tengas que modificar las dimensiones del botón para que coincidan con las de otros botones o elementos de la página de tramitación de la compra. Usa nuestra herramienta Personalizar botón para configurar un botón para tu caso práctico.

Argumentos

Nombre Descripción
options

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

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 ha definido una propiedad obligatoria.

isReadyToPay(isReadyToPayRequest)

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

Si el navegador es compatible con Google Pay, isReadyToPay devuelve true. Para determinar si el usuario ha iniciado sesión en una cuenta de Google o ya ha guardado un método de pago en Google Pay, asigna el valor true a IsReadyToPayRequest.existingPaymentMethodRequired y comprueba que paymentMethodPresent devuelve true en la promesa resuelta. Para obtener más información, consulta IsReadyToPayResponse.

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

Argumentos

Nombre Descripción
isReadyToPayRequest Objeto que contiene los métodos de pago admitidos por el comercio. Para obtener información sobre las diferentes propiedades que se pueden configurar, consulta IsReadyToPayRequest.

Devoluciones

Tipo Descripción
Promise

Resolved: 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 la sección PaymentsError.

Errores

statusCode Descripción
DEVELOPER_ERROR
  • El objeto IsReadyToPayRequest que se ha enviado no tiene el formato adecuado, no incluye los parámetros mínimos necesarios para determinar si un usuario está preparado para pagar o contiene un parámetro o un valor no válidos.
  • La solicitud se ha iniciado desde un contexto de seguridad que el agente de pago o el navegador han decidido no completar. Lo más habitual es que se trate 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 un método de pago y parámetros configurados opcionalmente.

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 un método de pago u otros datos necesarios especificados en el parámetro de solicitud enviado.

Argumentos

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

Devoluciones

Tipo Descripción
Promise

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

Rechazado: 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
  • El navegador actual o el usuario de Google que ha iniciado sesión no es compatible.
  • El comprador ha cerrado la hoja de pago de Google Pay sin autorizar el pago.
  • La solicitud se ha iniciado desde un contexto de seguridad que el agente de pago o el navegador han decidido no completar. Lo más habitual es que se trate de un contexto de navegador no seguro.
  • Se ha llamado al método mientras ya se mostraba la hoja de pago de Google Pay.
  • La hoja de pago de Google Pay ha rechazado el objeto PaymentDataRequest que se ha enviado. Faltan parámetros de PaymentMethodTokenizationSpecification o no se han especificado por completo en tu pasarela, o bien los valores de los parámetros no son válidos.
DEVELOPER_ERROR El objeto PaymentDataRequest que se ha enviado no tiene el formato adecuado, faltan los parámetros mínimos obligatorios o contiene un parámetro o un valor no válidos.

prefetchPaymentData(paymentDataRequest)

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

Las optimizaciones de la precarga 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 las propiedades configurables en PaymentDataRequest. Si cambia la propiedad transactionInfo , no se verá afectado el valor de la prefetch almacenado en caché.

onPaymentAuthorized(paymentData)

Este método se llama cuando se autoriza un pago en la hoja de pago.

Argumentos

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

Devoluciones

Tipo Descripción
Promise

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

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

onPaymentDataChanged(intermediatePaymentData)

Este método gestiona los cambios en los datos para pagos de 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: un objeto que contiene información sobre la nueva información de la transacción, las opciones de envío y los errores en los datos de pago. Para obtener más información, consulta PaymentDataRequestUpdate.

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