API Pembangun

Integrasikan dan sesuaikan

Lancarkan Payment for Stripe daripada aplikasi atau laman web anda sendiri dengan skema URL, dan kawal produk yang dipaparkan dalam aplikasi terus dari Papan Pemuka Stripe anda.

Integrasi dengan skema URL

Cetuskan caj daripada aplikasi atau laman web anda, hantar data pelanggan dan uruskan panggilan balik.

Sembunyikan produk dengan metadata

Asingkan produk dalam talian sahaja daripada aplikasi dengan satu kunci metadata.

Integrasi dengan skema URL

Cara ia berfungsi

Aplikasi anda membuka payment:// URL dengan parameter

Payment for Stripe dibuka dan memproses transaksi

Setelah selesai, aplikasi akan mengalihkan ke URL panggilan balik anda dengan hasilnya

Titik akhir

Cipta Caj

payment://new?

Proses pembayaran sekali sahaja dengan jumlah, mata wang dan penerangan.

Parameter

Nama	Jenis	Diperlukan	Penerangan
`amount`	integer	Ya	Jumlah dalam sen (cth., 1000 = $10.00)
`currency`	string	Tidak	Kod mata wang ISO tiga huruf (lalai: USD)
`description`	string	Tidak	Penerangan caj yang dikodkan URL
`customer`	string	Tidak	ID pelanggan Stripe sedia ada
`email`	string	Tidak	E-mel pelanggan untuk resit
`name`	string	Tidak	Nama pelanggan yang dikodkan URL
`metadata`	string	Tidak	Pasangan kunci-nilai tersuai (JSON yang dikodkan URL)
`callback`	string	Tidak	URL untuk kembali selepas selesai
`autoprocess`	boolean	Tidak	Langkau skrin utama dan mulakan caj dengan segera
`auto_return`	boolean	Tidak	Cetuskan panggilan balik sebaik sahaja hasil dimuatkan dan bukannya menunggu pedagang menutup dialog hasil. Lalai: false.

Cipta Invois

payment://cart?

Cipta invois Stripe dengan item baris daripada katalog produk anda.

Parameter

Nama	Jenis	Diperlukan	Penerangan
`prices`	string	Ya	ID harga yang dipisahkan koma dengan kuantiti (cth., price_abc:2,price_xyz:1)
`customer`	string	Tidak	ID pelanggan Stripe sedia ada
`email`	string	Tidak	E-mel pelanggan untuk resit
`name`	string	Tidak	Nama pelanggan yang dikodkan URL
`callback`	string	Tidak	URL untuk kembali selepas selesai
`auto_return`	boolean	Tidak	Cetuskan panggilan balik sebaik sahaja hasil dimuatkan dan bukannya menunggu pedagang menutup dialog hasil. Lalai: false.

Bayar Invois Sedia Ada (iOS sahaja)

payment://invoice?

Kutip pembayaran secara bersemuka bagi invois Stripe sedia ada. Jumlah, mata wang, pelanggan dan cukai diambil daripada invois. Sebarang usaha untuk menggantikan nilai ini akan ditolak. Pedagang mengetik kad melalui pembaca kad / Tap to Pay / entri manual; setelah berjaya, invois ditandakan sebagai dibayar di luar jalur dan dipautkan melalui metadata charge_id dan payment_intent_id. Invois dengan langganan, default_payment_method atau status selain open akan ditolak dengan ralat yang menerangkan tindakan yang perlu diambil.

Parameter

Nama	Jenis	Diperlukan	Penerangan
`id`	string	Ya	ID invois Stripe (mesti bermula dengan in_)
`callback`	string	Tidak	URL untuk kembali selepas selesai. Menerima invoice_id dan payment_intent_id setelah berjaya.
`metadata`	string	Tidak	Pasangan kunci-nilai tersuai (JSON yang dikodkan URL) yang digabungkan ke dalam metadata PaymentIntent
`autoprocess`	boolean	Tidak	Langkau skrin utama dan mulakan caj dengan segera
`auto_return`	boolean	Tidak	Cetuskan panggilan balik sebaik sahaja hasil dimuatkan dan bukannya menunggu pedagang menutup dialog hasil. Lalai: false.

Mengendalikan panggilan balik

Apabila transaksi selesai, Payment for Stripe mengalihkan ke URL panggilan balik anda dengan parameter pertanyaan yang menunjukkan hasilnya. Secara lalai, pengalihan berlaku selepas pedagang menutup dialog hasil supaya mereka boleh mengambil tindakan selepas caj (menghantar resit melalui e-mel, membuat bayaran balik). Hantar auto_return=true untuk mencetuskannya sebaik sahaja hasil diketahui. Disokong pada iOS dan Android.

Parameter Panggilan Balik

Parameter	Nilai	Penerangan
`status`	success \| error \| cancelled	Hasil transaksi
`charge_id`	string	ID caj Stripe (selepas berjaya)
`invoice_id`	string	ID invois Stripe (apabila berjaya, aliran payment://invoice sahaja)
`payment_intent_id`	string	ID PaymentIntent Stripe (apabila berjaya, aliran payment://invoice sahaja)
`error`	string	Mesej ralat (jika berlaku ralat)

Contoh

Caj mudah

Caj $10.00 dengan jumlah sahaja

payment://new?amount=1000

Caj dengan penerangan

Caj €25.00 dengan penerangan

payment://new?amount=2500&currency=eur&description=Coffee%20and%20pastry

Caj dengan pelanggan baharu

Caj $50.00 dan cipta rekod pelanggan

payment://new?amount=5000&name=John%20Smith&[email protected]

Caj pelanggan sedia ada

Caj $75.00 kepada pelanggan Stripe sedia ada

payment://new?amount=7500&customer=cus_ABC123xyz

Caj dengan metadata

Caj $100.00 dengan metadata tersuai untuk rekod anda

payment://new?amount=10000&description=Invoice%20%231234&metadata=%7B%22order_id%22%3A%221234%22%2C%22location%22%3A%22Store%20A%22%7D

Proses automatik dengan panggilan balik

Langkau skrin utama dan kembali ke aplikasi anda setelah selesai

payment://new?amount=3500&autoprocess=true&callback=myapp://payment-complete

Kembali automatik apabila hasil diketahui

Cetuskan panggilan balik sebaik sahaja hasilnya diketahui, dan bukannya menunggu pedagang menutup dialog hasil

payment://new?amount=3500&autoprocess=true&auto_return=true&callback=myapp://payment-complete

Invois dengan item baris

Cipta invois dengan produk daripada katalog Stripe anda

payment://cart?prices=price_coffee:2,price_muffin:1&[email protected]

Bayar invois sedia ada (iOS)

Kutip pembayaran secara bersemuka untuk invois Stripe sedia ada. Mengembalikan invoice_id dan payment_intent_id apabila berjaya.

payment://invoice?id=in_1ABC123xyz&autoprocess=true&callback=myapp://invoice-paid

Contoh lengkap

Semua parameter digabungkan untuk aliran bersepadu sepenuhnya

payment://new?amount=15000&currency=usd&description=Service%20Fee&customer=cus_ABC123xyz&metadata=%7B%22invoice%22%3A%22INV-2024-001%22%7D&autoprocess=true&callback=myapp://payment-result

Pengekodan URL

Ingat untuk melakukan pengekodan URL bagi aksara khas dalam nilai parameter. Ruang menjadi %20, pendakap kerinting menjadi %7B dan %7D.

Sembunyikan produk dengan metadata

Menyembunyikan produk daripada aplikasi

Aplikasi menyenaraikan produk dan harga daripada akaun Stripe anda. Untuk mengecualikan satu daripadanya daripada aplikasi (contohnya barangan yang hanya dijual melalui kedai dalam talian anda), tambahkan kunci metadata ini pada produk atau harga dalam Papan Pemuka Stripe:

payment_hidden = true

Pada produk: menyembunyikan produk itu dan semua harganya.

Pada harga: menyembunyikan harga itu sahaja.

Buang kunci itu, atau tetapkan kepada false, untuk memaparkannya semula. Perubahan berkuat kuasa pada kali seterusnya aplikasi memuatkan senarai produk anda.

Pautan troli terus berfungsi

Penyembunyian hanya mempengaruhi senarai produk dalam aplikasi. URL payment://cart yang merujuk harga tersembunyi terus berfungsi, dan langganan sedia ada tidak terjejas.

Bersedia untuk berintegrasi?

Muat turun aplikasi dan mula menguji integrasi anda hari ini.

Muat turun untuk iOS Muat turun untuk Android

Hubungi sokongan