Referință client

Această referință descrie metodele client JavaScript pe care le puteți utiliza pentru a implementa API-ul Google Pay în aplicațiile web.

Constructor

Inițializează obiectul PaymentsClient . Trebuie să apelați acest constructor înainte de a apela metodele membre.

new PaymentsClient(opțiuniPlăți)

Argumente

Proprietate Descriere
paymentOptions

Un obiect care conține perechi cheie-valoare din datele de configurare ale API-ului Google Pay. Consultați PaymentOptions pentru diferitele proprietăți configurabile.

Exemplu: {environment:'PRODUCTION'}

Returnări

Tip Descriere
google.payments.api.PaymentsClient Obiectul PaymentsClient .

Aruncări

Tip Descriere
Error

Valoarea proprietății de mediu transmisă nu este acceptată.

Metode de obiect

createButton(opțiuni)

Metoda „Convenție” este utilizată pentru a genera un buton de plată Google Pay, cu cel mai recent design de branding Google Pay, pentru inserarea într-o pagină web.

Elementul HTMLElement generat include CSS inserat dinamic și o imagine SVG găzduită pe CDN-ul Google.

Consultați Ghidul nostru de brand pentru mai multe informații despre cum să selectați culoarea și tipul de buton potrivite pentru designul site-ului dvs. Este posibil să fie nevoie să modificați dimensiunile butonului pentru a se potrivi cu butoane sau elemente de finalizare a comenzii similare de pe pagina dvs. Folosiți instrumentul nostru Personalizați-vă butonul pentru a configura un buton pentru cazul dvs. de utilizare.

Argumente

Nume Descriere
options

Un obiect care conține perechi cheie-valoare pentru o configurație de buton. Consultați ButtonOptions pentru proprietăți configurabile.

Exemplu: {onClick:onGooglePaymentButtonClicked}

Returnări

Tip Descriere
HTMLElement Un <button> HTML în interiorul unui container generic de conținut de flux, cum ar fi <div> .

Aruncări

Tip Descriere
Error

O proprietate obligatorie nu este setată.

esteGataDePlată(cerereGataDePlată)

Folosește metoda isReadyToPay(isReadyToPayRequest) pentru a determina capacitatea unui utilizator de a returna o formă de plată din API-ul Google Pay.

Dacă browserul este compatibil cu Google Pay, isReadyToPay returnează true . Pentru a determina dacă utilizatorul este conectat la un cont Google sau a salvat deja o metodă de plată în Google Pay, setați IsReadyToPayRequest.existingPaymentMethodRequired la true și verificați dacă paymentMethodPresent returnează true în promisiunea rezolvată. Pentru mai multe detalii, consultați IsReadyToPayResponse .

Dacă PaymentsClient a fost inițializat cu o proprietate de mediu TEST , paymentMethodPresent returnează întotdeauna true .

Argumente

Nume Descriere
isReadyToPayRequest Un obiect care conține metode de plată acceptate de comerciant. Pentru detalii despre diferitele proprietăți configurabile, consultați IsReadyToPayRequest .

Returnări

Tip Descriere
Promise

Rezolvat: Un obiect care conține informații despre capacitatea utilizatorului de a plăti. Pentru mai multe informații, consultați IsReadyToPayResponse .

Respins: Un obiect de eroare care conține mai multe informații despre motivul respingerii. Pentru mai multe informații, consultați PaymentsError .

Erori

Cod de stare Descriere
DEVELOPER_ERROR
  • Obiectul IsReadyToPayRequest transmis a fost formatat incorect, nu a îndeplinit parametrii minimi necesari pentru a determina dacă un utilizator este pregătit să plătească sau conține un parametru și/sau o valoare nevalide.
  • Cererea a fost inițiată dintr-un context de securitate pe care agentul de plată sau browserul a ales să nu îl îndeplinească. Cel mai frecvent, aceasta este o eroare de context de browser nesigur .

încărcareDataPlată(cerereDataPlată)

Această metodă prezintă o foaie de plată Google Pay care permite selectarea unei metode de plată și configurarea opțională a unor parametri.

Această metodă trebuie apelată în timp ce browserul procesează un comportament de activare ca urmare a unui eveniment de clic. O fereastră pop-up poate fi prezentată utilizatorului pentru a selecta o metodă de plată sau alte date necesare specificate în parametrul de solicitare transmis.

Argumente

Nume Descriere
paymentDataRequest Un obiect care conține perechi cheie-valoare cu configurație completă a API-ului Google Pay. Consultați PaymentDataRequest pentru proprietăți configurabile.

Returnări

Tip Descriere
Promise

Rezolvat: Un obiect care conține datele solicitate despre cumpărător. Consultați PaymentData pentru mai multe informații.

Respins: Un obiect care conține un cod de eroare și mai multe informații despre motivul respingerii. Consultați PaymentsError pentru mai multe informații.

Erori

Cod de stare Descriere
CANCELED
  • Browserul curent sau utilizatorul Google conectat nu este acceptat.
  • Cumpărătorul a respins fișa de plată Google Pay fără autorizare de plată.
  • Cererea a fost inițiată dintr-un context de securitate pe care agentul de plată sau browserul a ales să nu îl îndeplinească. Cel mai frecvent, un context de browser nesigur .
  • Metoda a fost apelată în timp ce foaia de plată Google Pay era deja afișată.
  • Obiectul PaymentDataRequest transmis a fost respins de foaia de plată Google Pay. Parametrii PaymentMethodTokenizationSpecification lipsă sau incompleți pentru gateway-ul dvs. sau valorile parametrilor nevalide sunt o cauză frecventă.
DEVELOPER_ERROR Obiectul PaymentDataRequest transmis a fost formatat incorect, lipsesc parametrii minimi necesari sau conține un parametru și/sau o valoare nevalidă.

prefetchPaymentData(paymentDataRequest)

Folosește această metodă pentru a preîncărca o configurație PaymentDataRequest pentru a îmbunătăți timpul de execuție loadPaymentData la interacțiunile ulterioare ale utilizatorului. Nu se returnează nicio valoare.

Optimizările pentru preîncărcare sunt disponibile în Chrome pentru Android.

Argumente

Nume Descriere
paymentDataRequest Un obiect care conține perechi cheie-valoare cu configurație completă a API-ului Google Pay. Consultați PaymentDataRequest pentru proprietăți configurabile. O modificare a proprietății transactionInfo nu afectează valoarea de preîncărcare memorată în cache.

onPaymentAutorized(paymentData)

Această metodă este apelată atunci când o plată este autorizată în foaia de plată.

Argumente

Nume Descriere
paymentData Un obiect care conține datele solicitate despre cumpărător. Pentru detalii, consultați PaymentData .

Returnări

Tip Descriere
Promise

Rezolvat: Un obiect care conține informații despre rezultatele tranzacțiilor de plată. Pentru detalii, consultați PaymentAuthorizationResult .

Respins: Un obiect de eroare cu o intenție de eroare și un mesaj care va fi afișat în foaia de plată. Pentru detalii, consultați PaymentDataError .

onPaymentDataChanged(intermediatePaymentData)

Această metodă gestionează modificările datelor de plată din foaia de plată, cum ar fi adresa de livrare și opțiunile de livrare.

Argumente

Nume Descriere
intermediatePaymentData Un obiect care conține adresa și opțiunea de livrare selectate în foaia de plată. Pentru detalii, consultați IntermediatePaymentData .

Returnări

Tip Descriere
Promise

Rezolvat: Un obiect care conține informații despre noile tranzacții, opțiunile de livrare și erorile legate de datele de plată. Pentru detalii, consultați PaymentDataRequestUpdate .

Respins: Un obiect de eroare cu o intenție de eroare și un mesaj care va fi afișat în foaia de plată. Pentru detalii, consultați PaymentDataError .