Referência do cliente

Esta referência descreve os métodos de cliente JavaScript para implementar a API Google Pay nos seus aplicativos da Web.

Construtor

Inicializa o objeto PaymentsClient. Chame esse construtor antes de chamar métodos de membro.

new PaymentsClient(paymentOptions)

Argumentos

Propriedade Descrição
paymentOptions

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

Exemplo: {environment:'PRODUCTION'}

Retorna

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

Gera

Tipo Descrição
Error

O valor da propriedade de ambiente transmitido não é compatível.

Métodos de objeto

createButton(options)

O método de conveniência é usado para gerar um botão de pagamento do Google Pay estilizado com a marca mais recente do Google Pay para inserção em uma página da Web.

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

Consulte nossas diretrizes de marca para mais informações sobre como selecionar a cor e o tipo de botão adequados para o design do seu site. Talvez seja necessário alterar as dimensões do botão para que ele corresponda a botões ou elementos de finalização de compra semelhantes na sua página. Use nossa ferramenta Personalizar o botão para configurar um botão para seu caso de uso.

Argumentos

Nome Descrição
options

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

Exemplo: {onClick:onGooglePaymentButtonClicked}

Retorna

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

Gera

Tipo Descrição
Error

Uma propriedade obrigatória não está definida.

isReadyToPay(isReadyToPayRequest)

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

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

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

Argumentos

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

Retorna

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.

Rejected: 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 IsReadyToPayRequest transmitido foi formatado incorretamente, não tinha os parâmetros mínimos necessários para determinar se o usuário estava pronto para pagar ou continha um parâmetro e/ou valor inválido.
  • A solicitação foi iniciada em um contexto de segurança que o agente de pagamento ou o navegador optou por não atender. Na maioria das vezes, é um erro de contexto de navegador não seguro.

loadPaymentData(paymentDataRequest)

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

Esse método precisa ser chamado enquanto o navegador processa um comportamento de ativação 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 ver as propriedades configuráveis.

Retorna

Tipo Descrição
Promise

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

Rejected: um objeto que contém um código do 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 dispensou a página de pagamento do Google Pay sem autorização de pagamento.
  • A solicitação foi iniciada em um contexto de segurança que o agente de pagamento ou o navegador optou por não atender. Na maioria das vezes, um contexto de navegador não seguro.
  • O método foi chamado enquanto a planilha de pagamento do Google Pay já estava sendo mostrada.
  • O objeto PaymentDataRequest transmitido foi rejeitado pela página de pagamento do Google Pay. Uma causa comum são os parâmetros PaymentMethodTokenizationSpecification ausentes ou incompletos para o gateway ou valores de parâmetro inválidos.
DEVELOPER_ERROR O objeto PaymentDataRequest transmitido foi formatado incorretamente, não tem os parâmetros mínimos necessários ou contém um parâmetro e/ou valor inválido.

prefetchPaymentData(paymentDataRequest)

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

As otimizações de pré-busca estão disponíveis no Google Chrome para Android.

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 ver as propriedades configuráveis. Uma mudança na propriedade transactionInfo não afeta o valor de pré-busca em cache.

Callbacks de dados de pagamento

Os gerenciadores de callback a seguir podem ser transmitidos para PaymentOptions.paymentDataCallbacks para oferecer suporte à autorização de pagamentos e à determinação dinâmica de preços.

onPaymentAuthorized(paymentData)

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

Argumentos

Nome Descrição
paymentData Um objeto que contém os dados solicitados do comprador. Para mais detalhes, consulte PaymentData.

Retorna

Tipo Descrição
Promise

Resolved: um objeto que contém informações sobre os resultados da transação de pagamento. Para mais detalhes, consulte PaymentAuthorizationResult.

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

onPaymentDataChanged(intermediatePaymentData)

Esse método processa mudanças nos dados de pagamento na página de pagamento, como endereço de entrega e opções de envio.

Argumentos

olá
Nome Descrição
intermediatePaymentData Um objeto que contém o endereço e a opção de envio selecionados na página de pagamento. Para mais detalhes, consulte IntermediatePaymentData.

Retorna

Tipo Descrição
Promise

Resolvido: um objeto que contém informações sobre novas transações, opções de envio e erros de dados de pagamento. Para mais detalhes, consulte PaymentDataRequestUpdate.

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