Referência do cliente

Nesta referência, descrevemos os métodos do cliente JavaScript a serem usados para implementar a API Google Pay nos seus aplicativos da Web.

Construtor

Inicializa o objeto PaymentsClient. Você precisa chamar este construtor antes de chamar métodos de membro.

Novo PaymentsClient (paymentOptions)

Argumentos

Propriedade Descrição
paymentOptions

Um objeto que contém pares de chave-valor dos dados de configuração da API Google Pay. Consulte PaymentOptions para as diferentes propriedades configuráveis.

Exemplo: {environment:'PRODUCTION'}

Retornos

Tipo Descrição
google.payments.api.PaymentsClient O objeto PaymentsClient.

Gerações

Tipo Descrição
Error

O valor da propriedade do ambiente transmitido não é aceito.

Métodos de objeto

createButton(options)

Um método prático é usado para gerar um botão de pagamento do Google Pay com a marca mais recente do serviço para inserção em uma página da Web.

O HTMLElement gerado inclui CSS inserido dinamicamente e uma imagem SVG hospedada no CDN do Google.

Consulte nossas diretrizes da promoção de marca para mais informações sobre como selecionar a cor e o tipo de botão apropriados para o design do seu site. Pode ser necessário alterar as dimensões de um botão de pagamento retornado do Google Pay para corresponder a botões ou elementos de finalização de compra semelhantes na página.

Argumentos

Nome Descrição
options

Um objeto que contém pares de chave-valor para uma configuração de botão. Consulte ButtonOptions para propriedades configuráveis.

Exemplo: {onClick:onGooglePaymentButtonClicked}

Retornos

Tipo Descrição
HTMLElement Um HTML <button> dentro de um contêiner de conteúdo de fluxo genérico, como um <div>.

Gerações

Tipo Descrição
Error

Uma propriedade necessária não foi definida.

isReadyToPay(isReadyToPayRequest)

Use o método isReadyToPay(isReadyToPayRequest) para determinar a capacidade de um usuário de retornar uma forma de pagamento da API Google Pay.

Se o navegador for compatível com o Google Pay e o usuário já tiver salvo uma forma de pagamento, ou puder adicionar uma, isReadyToPay retornará true. Para determinar se o usuário já salvou uma forma de pagamento no Google Pay, defina IsReadyToPayRequest.existingPaymentMethodRequired como true e verifique se paymentMethodPresent retorna true na promessa resolvida. Veja mais detalhes em IsReadyToPayResponse.

Se PaymentsClient for inicializado com uma propriedade de ambiente TEST, paymentMethodPresent sempre retornará true.

Argumentos

Nome Descrição
isReadyToPayRequest Um objeto que contém formas de pagamento aceitas pelo comerciante. Para detalhes sobre as diferentes propriedades configuráveis, consulte IsReadyToPayRequest.

Retornos

Tipo Descrição
Promise

Resolvido: um objeto que contém informações sobre a capacidade de pagamento do usuário. Para mais informações, consulte IsReadyToPayResponse.

Rejeitado: um objeto de erro que contém mais informações sobre o motivo da rejeição. Para mais informações, consulte PaymentsError.

Erros

statusCode Descrição
DEVELOPER_ERROR
  • O objeto transmitido IsReadyToPayRequest não foi formatado corretamente, perdeu os parâmetros mínimos necessários para determinar a disponibilidade de pagamento do usuário ou contém um parâmetro e/ou um valor inválido.
  • A solicitação foi iniciada de um contexto de segurança que o agente de pagamento ou o navegador optou por não cumprir. Geralmente, isso é um erro de contexto de navegador não seguro (em inglês).

loadPaymentData(paymentDataRequest)

Esse método apresenta uma página de pagamento do Google Pay que permite a seleção de uma forma de pagamento e de parâmetros configurados opcionalmente.

Este método precisa ser chamado enquanto o navegador processa um comportamento de ativação (em inglês) como resultado de um evento de clique. Uma janela pop-up pode ser apresentada ao usuário para selecionar uma forma de pagamento ou outros dados necessários especificados no parâmetro de solicitação transmitido.

Argumentos

Nome Descrição
paymentDataRequest Um objeto que contém pares de chave-valor da configuração completa da API Google Pay. Consulte PaymentDataRequest para propriedades configuráveis.

Retornos

Tipo Descrição
Promise

Resolvido: um objeto que contém os dados do comprador solicitado. Consulte PaymentData para mais informações.

Rejeitado: um objeto que contém um código de erro e mais informações sobre o motivo da rejeição. Consulte PaymentsError para mais informações.

Erros

statusCode Descrição
CANCELED
  • O navegador atual ou o usuário do Google conectado não é compatível.
  • O comprador fechou a página de pagamento do Google Pay sem autorização de pagamento.
  • A solicitação foi iniciada de um contexto de segurança que o agente de pagamento ou o navegador optou por não cumprir. Geralmente um contexto de navegador inseguro (em inglês).
  • O método foi chamado enquanto a página de pagamento do Google Pay já era exibida.
  • O objeto transmitido PaymentDataRequest foi rejeitado pela página de pagamento do Google Pay. Parâmetros PaymentMethodTokenizationSpecification ausentes ou incompletos para o gateway ou valores de parâmetro inválidos são uma causa comum.
DEVELOPER_ERROR O objeto transmitido PaymentDataRequest não foi formatado corretamente, não tem os parâmetros mínimos obrigatórios ou contém um parâmetro e/ou um valor inválido.

prefetchPaymentData(paymentDataRequest)

Use este método para fazer a pré-busca de uma configuração PaymentDataRequest para melhorar o tempo de execução de loadPaymentData na interação posterior do usuário. Nenhum valor é retornado.

No momento, as otimizações de pré-busca estão disponíveis no Chrome para Android. Outros navegadores e plataformas serão incluídos.

Argumentos

Nome Descrição
paymentDataRequest Um objeto que contém pares de chave-valor da configuração completa da API Google Pay. Consulte PaymentDataRequest para propriedades configuráveis. Uma alteração na propriedade transactionInfo não afeta o valor de pré-busca em cache.

onPaymentAuthorized(paymentData)

Este método é chamado quando um pagamento é autorizado na página de pagamento.

Argumentos

Nome Descrição
paymentData Um objeto que contém os dados do comprador solicitado. Veja mais detalhes em PaymentData.

Retornos

Tipo Descrição
Promise

Resolvido: um objeto que contém informações sobre os resultados da transação de pagamento. Veja mais detalhes em PaymentAuthorizationResult.

Rejeitado: um objeto de erro com uma intent de erro e a mensagem a ser renderizada na página de pagamento. Veja mais detalhes em PaymentDataError.

onPaymentDataChanged(intermediatePaymentData)

Este método lida com alterações dos dados de pagamento na página de pagamento, como endereço de entrega e opções de envio.

Argumentos

Nome Descrição
intermediatePaymentData Um objeto que contém o endereço selecionado e a opção de envio na página de pagamento. Veja mais detalhes em IntermediatePaymentData.

Retornos

Tipo Descrição
Promise

Resolvido: um objeto que contém informações sobre novas informações da transação, opções de envio e erros de dados de pagamento. Veja mais detalhes em PaymentDataRequestUpdate.

Rejeitado: um objeto de erro com uma intent de erro e a mensagem a ser renderizada na página de pagamento. Veja mais detalhes em PaymentDataError.