Riferimento cliente

Questo riferimento descrive i metodi del client JavaScript da utilizzare per implementare l'API Google Pay nelle applicazioni web.

Costruttore

Inizializza l'oggetto PaymentsClient. Devi chiamare questo costruttore prima di chiamare i metodi dei membri.

new PaymentsClient(paymentOptions)

Argomenti

Proprietà Descrizione
paymentOptions

Un oggetto contenente coppie chiave-valore di dati di configurazione dell'API Google Pay. Consulta PaymentOptions per le diverse proprietà configurabili.

Esempio: {environment:'PRODUCTION'}

Resi

Tipo Descrizione
google.payments.api.PaymentsClient L'oggetto PaymentsClient.

Genera

Tipo Descrizione
Error

Il valore della proprietà dell'ambiente passato non è supportato.

Metodi degli oggetti

createButton(options)

Il metodo di convenienza viene utilizzato per generare un pulsante di pagamento Google Pay con lo stile del branding Google Pay più recente da inserire in una pagina web.

Il HTMLElement generato include CSS inseriti dinamicamente e un'immagine SVG ospitata sul CDN di Google.

Per ulteriori informazioni su come selezionare il colore e il tipo di pulsante appropriati per il design del tuo sito, consulta le nostre linee guida per il brand. Potresti dover modificare le dimensioni del pulsante in modo che corrispondano a pulsanti o elementi di pagamento simili nella pagina. Utilizza il nostro Personalizza il pulsante strumento per configurare un pulsante per il tuo caso d'uso.

Argomenti

Nome Descrizione
options

Un oggetto che contiene coppie chiave-valore per una configurazione del pulsante. Consulta ButtonOptions per le proprietà configurabili.

Esempio: {onClick:onGooglePaymentButtonClicked}

Resi

Tipo Descrizione
HTMLElement Un elemento HTML <button> all'interno di un contenitore di contenuti di flusso generico come un <div>.

Genera

Tipo Descrizione
Error

Non è impostata una proprietà obbligatoria.

isReadyToPay(isReadyToPayRequest)

Utilizza il metodo isReadyToPay(isReadyToPayRequest) per determinare la capacità di un utente di restituire una forma di pagamento dall'API Google Pay.

Se il browser supporta Google Pay, isReadyToPay restituisce true. Per determinare se l'utente ha eseguito l'accesso a un Account Google o ha già salvato un metodo di pagamento in Google Pay, imposta IsReadyToPayRequest.existingPaymentMethodRequired su true e verifica che paymentMethodPresent restituisca true nella promessa risolta. Per ulteriori dettagli, consulta IsReadyToPayResponse.

Se PaymentsClient è inizializzato con una proprietà dell'ambiente TEST, paymentMethodPresent restituisce sempre true.

Argomenti

Nome Descrizione
isReadyToPayRequest Un oggetto che contiene i metodi di pagamento supportati dal commerciante. Per i dettagli sulle diverse proprietà configurabili, consulta IsReadyToPayRequest.

Resi

Tipo Descrizione
Promise

Risolta: un oggetto che contiene informazioni sulla capacità di pagamento dell'utente. Per ulteriori informazioni, consulta IsReadyToPayResponse.

Rifiutata: un oggetto di errore che contiene ulteriori informazioni sul motivo del rifiuto. Per ulteriori informazioni, consulta PaymentsError.

Errori

statusCode Descrizione
DEVELOPER_ERROR
  • L'oggetto passato IsReadyToPayRequest non è stato formattato correttamente, non sono stati inclusi i parametri minimi richiesti per determinare la disponibilità di un utente a pagare oppure contiene un parametro e/o un valore non valido.
  • La richiesta è stata avviata da un contesto di sicurezza che l'agente di pagamento o il browser ha scelto di non soddisfare. Nella maggior parte dei casi, si tratta di un contesto del browser non sicuro errore.

loadPaymentData(paymentDataRequest)

Questo metodo presenta un foglio di pagamento Google Pay che consente la selezione di un metodo di pagamento e di parametri configurati facoltativamente.

Questo metodo deve essere chiamato mentre il browser elabora un comportamento di attivazione a seguito di un evento di clic. All'utente potrebbe essere presentata una finestra popup per selezionare un metodo di pagamento o altri dati obbligatori specificati nel parametro della richiesta passata.

Argomenti

Nome Descrizione
paymentDataRequest Un oggetto che contiene coppie chiave-valore della configurazione completa dell'API Google Pay Consulta PaymentDataRequest per le proprietà configurabili.

Resi

Tipo Descrizione
Promise

Risolta: un oggetto che contiene i dati dell'acquirente richiesti. Per ulteriori informazioni, consulta PaymentData.

Rifiutata: un oggetto contenente un codice di errore e ulteriori informazioni sul motivo del rifiuto. Per ulteriori informazioni, consulta PaymentsError.

Errori

statusCode Descrizione
CANCELED
  • Il browser attuale o l'utente Google che ha eseguito l'accesso non è supportato.
  • L'acquirente ha chiuso il foglio di pagamento Google Pay senza autorizzare il pagamento.
  • La richiesta è stata avviata da un contesto di sicurezza che l'agente di pagamento o il browser ha scelto di non soddisfare. Nella maggior parte dei casi, si tratta di un contesto del browser non sicuro.
  • Il metodo è stato chiamato mentre il foglio di pagamento Google Pay era già visualizzato.
  • L'oggetto PaymentDataRequest passato è stato rifiutato dal foglio di pagamento Google Pay. Una causa comune è la mancanza o l'incompletezza dei PaymentMethodTokenizationSpecification parametri per il tuo gateway o i valori dei parametri non validi.
DEVELOPER_ERROR L'oggetto PaymentDataRequest passato non è stato formattato correttamente, non sono stati inclusi i parametri minimi richiesti oppure contiene un parametro e/o un valore non valido.

prefetchPaymentData(paymentDataRequest)

Utilizza questo metodo per precaricare una configurazione PaymentDataRequest per migliorare loadPaymentData il tempo di esecuzione durante le interazioni successive dell'utente. Non viene restituito alcun valore.

Le ottimizzazioni di precaricamento sono disponibili su Chrome per Android.

Argomenti

Nome Descrizione
paymentDataRequest Un oggetto che contiene coppie chiave-valore della configurazione completa dell'API Google Pay Consulta PaymentDataRequest per le proprietà configurabili. Una modifica della proprietà transactionInfo non influisce sul valore di precaricamento memorizzato nella cache.

Callback dei dati di pagamento

I seguenti gestori di callback possono essere passati a PaymentOptions.paymentDataCallbacks per supportare l'autorizzazione dei pagamenti e gli aggiornamenti dinamici dei prezzi.

onPaymentAuthorized(paymentData)

Questo metodo viene chiamato quando un pagamento viene autorizzato nel foglio di pagamento.

Argomenti

Nome Descrizione
paymentData Un oggetto che contiene i dati dell'acquirente richiesti. Per i dettagli, consulta PaymentData.

Resi

Tipo Descrizione
Promise

Risolta: un oggetto che contiene informazioni sui risultati della transazione di pagamento. Per i dettagli, consulta PaymentAuthorizationResult.

Rifiutata: un oggetto di errore con un intento e un messaggio di errore da visualizzare nel foglio di pagamento. Per i dettagli, consulta PaymentDataError.

onPaymentDataChanged(intermediatePaymentData)

Questo metodo gestisce le modifiche dei dati di pagamento nel foglio di pagamento, ad esempio l'indirizzo di spedizione e opzioni di spedizione.

Argomenti

Nome Descrizione
intermediatePaymentData Un oggetto che contiene l'indirizzo e l'opzione di spedizione selezionati nel foglio di pagamento. Per i dettagli, vedi IntermediatePaymentData.

Resi

Tipo Descrizione
Promise

Risolta: un oggetto che contiene informazioni sulle nuove informazioni sulla transazione, opzioni di spedizione e errori dei dati di pagamento. Per i dettagli, vedi PaymentDataRequestUpdate.

Rifiutata: un oggetto di errore con un intento e un messaggio di errore da visualizzare nel foglio di pagamento. Per i dettagli, consulta PaymentDataError.