Referensi klien

Referensi ini menjelaskan metode klien JavaScript yang digunakan untuk menerapkan Google Pay API di aplikasi web Anda.

Konstruktor

Menginisialisasi objek PaymentsClient. Anda harus memanggil konstruktor ini sebelum memanggil metode anggota.

new PaymentsClient(paymentOptions)

Argumen

Properti Deskripsi
paymentOptions

Objek yang berisi pasangan nilai kunci data konfigurasi Google Pay API. Lihat PaymentOptions untuk mengetahui berbagai properti yang dapat dikonfigurasi.

Contoh: {environment:'PRODUCTION'}

Pengembalian

Jenis Deskripsi
google.payments.api.PaymentsClient Objek PaymentsClient.

Lemparan

Jenis Deskripsi
Error

Nilai properti lingkungan yang diteruskan tidak didukung.

Metode objek

createButton(options)

Metode praktis digunakan untuk membuat tombol pembayaran Google Pay yang diberi gaya dengan branding Google Pay terbaru untuk disisipkan ke halaman web.

HTMLElement yang dihasilkan mencakup CSS yang disisipkan secara dinamis dan gambar SVG yang dihosting di CDN Google.

Lihat Pedoman merek kami untuk mengetahui informasi selengkapnya tentang cara memilih warna tombol dan jenis tombol yang sesuai untuk desain situs Anda. Anda mungkin perlu mengubah dimensi tombol agar sesuai dengan tombol serupa atau elemen checkout di halaman Anda. Gunakan alat Sesuaikan tombol Anda untuk mengonfigurasi tombol untuk kasus penggunaan Anda.

Argumen

Nama Deskripsi
options

Objek yang berisi key-value pair untuk konfigurasi tombol. Lihat ButtonOptions untuk properti yang dapat dikonfigurasi.

Contoh: {onClick:onGooglePaymentButtonClicked}

Pengembalian

Jenis Deskripsi
HTMLElement <button> HTML di dalam penampung konten alur generik seperti <div>.

Lemparan

Jenis Deskripsi
Error

Properti wajib tidak ditetapkan.

isReadyToPay(isReadyToPayRequest)

Gunakan metode isReadyToPay(isReadyToPayRequest) untuk menentukan kemampuan pengguna untuk menampilkan metode pembayaran dari Google Pay API.

Jika browser mendukung Google Pay, isReadyToPay akan menampilkan true. Untuk menentukan apakah pengguna login ke Akun Google, atau telah menyimpan metode pembayaran di Google Pay, tetapkan IsReadyToPayRequest.existingPaymentMethodRequired ke true dan verifikasi bahwa paymentMethodPresent menampilkan true dalam promise yang diselesaikan. Untuk detail selengkapnya, lihat IsReadyToPayResponse.

Jika PaymentsClient diinisialisasi dengan properti lingkungan TEST, paymentMethodPresent akan selalu menampilkan true.

Argumen

Nama Deskripsi
isReadyToPayRequest Objek yang berisi metode pembayaran yang didukung oleh penjual. Untuk mengetahui detail tentang berbagai properti yang dapat dikonfigurasi, lihat IsReadyToPayRequest.

Pengembalian

Jenis Deskripsi
Promise

Terselesaikan: Objek yang berisi informasi tentang kemampuan pengguna untuk membayar. Untuk informasi selengkapnya, lihat IsReadyToPayResponse.

Ditolak: Objek error yang berisi informasi selengkapnya tentang alasan penolakan. Untuk mengetahui informasi selengkapnya, lihat PaymentsError.

Error

statusCode Deskripsi
DEVELOPER_ERROR
  • Objek IsReadyToPayRequest yang diteruskan tidak diformat dengan benar, tidak memiliki parameter minimum yang diperlukan untuk menentukan kesiapan pengguna untuk membayar, atau berisi parameter dan/atau nilai yang tidak valid.
  • Permintaan dimulai dari konteks keamanan yang tidak ingin dipenuhi oleh agen pembayaran atau browser. Penyebab paling umumnya adalah error konteks browser tidak aman.

loadPaymentData(paymentDataRequest)

Metode ini menampilkan halaman pembayaran Google Pay yang memungkinkan pemilihan metode pembayaran dan parameter yang dikonfigurasi secara opsional.

Metode ini harus dipanggil saat browser memproses perilaku aktivasi sebagai hasil dari peristiwa klik. Jendela pop-up dapat ditampilkan kepada pengguna untuk memilih metode pembayaran atau data lain yang diperlukan yang ditentukan dalam parameter permintaan yang diteruskan.

Argumen

Nama Deskripsi
paymentDataRequest Objek yang berisi pasangan nilai kunci dari konfigurasi Google Pay API lengkap. Lihat PaymentDataRequest untuk properti yang dapat dikonfigurasi.

Pengembalian

Jenis Deskripsi
Promise

Terselesaikan: Objek yang berisi data pembeli yang diminta. Lihat PaymentData untuk mengetahui informasi selengkapnya.

Ditolak: Objek yang berisi kode error dan informasi selengkapnya tentang alasan penolakan. Lihat PaymentsError untuk mengetahui informasi selengkapnya.

Error

statusCode Deskripsi
CANCELED
DEVELOPER_ERROR Objek PaymentDataRequest yang diteruskan diformat dengan tidak benar, tidak memiliki parameter minimum yang diperlukan, atau berisi parameter dan/atau nilai yang tidak valid.

prefetchPaymentData(paymentDataRequest)

Gunakan metode ini untuk mengambil data konfigurasi PaymentDataRequest terlebih dahulu guna meningkatkan waktu eksekusi loadPaymentData pada interaksi pengguna berikutnya. Tidak ada nilai yang ditampilkan.

Pengoptimalan pengambilan data awal tersedia di Chrome untuk Android.

Argumen

Nama Deskripsi
paymentDataRequest Objek yang berisi pasangan nilai kunci dari konfigurasi Google Pay API lengkap. Lihat PaymentDataRequest untuk properti yang dapat dikonfigurasi. Perubahan pada properti transactionInfo tidak memengaruhi nilai pengambilan data yang di-cache.

onPaymentAuthorized(paymentData)

Metode ini dipanggil saat pembayaran diotorisasi di halaman pembayaran.

Argumen

Nama Deskripsi
paymentData Objek yang berisi data pembeli yang diminta. Untuk mengetahui detailnya, lihat PaymentData.

Pengembalian

Jenis Deskripsi
Promise

Resolved: Objek yang berisi informasi tentang hasil transaksi pembayaran. Untuk mengetahui detailnya, lihat PaymentAuthorizationResult.

Ditolak: Objek error dengan maksud dan pesan error yang akan dirender di halaman pembayaran. Untuk mengetahui detailnya, lihat PaymentDataError.

onPaymentDataChanged(intermediatePaymentData)

Metode ini menangani perubahan data pembayaran di halaman pembayaran seperti alamat pengiriman dan opsi pengiriman.

Argumen

Nama Deskripsi
intermediatePaymentData Objek yang berisi alamat dan opsi pengiriman yang dipilih di lembar pembayaran. Untuk mengetahui detailnya, lihat IntermediatePaymentData.

Pengembalian

Jenis Deskripsi
Promise

Selesai: Objek yang berisi informasi tentang informasi transaksi baru, opsi pengiriman, dan error data pembayaran. Untuk mengetahui detailnya, lihat PaymentDataRequestUpdate.

Ditolak: Objek error dengan maksud dan pesan error yang akan dirender di halaman pembayaran. Untuk mengetahui detailnya, lihat PaymentDataError.