Skip to content

API Pembangun

Integrasikan dengan Skema URL

Lancarkan Pembayaran untuk Stripe daripada aplikasi atau laman web anda untuk memproses transaksi. Serahkan data pelanggan, jumlah dan maklumat produk — kemudian kendalikan panggilan balik apabila selesai.

Cara ia berfungsi

1

Aplikasi anda membuka pembayaran:// URL dengan parameter

2

Pembayaran untuk Stripe melancarkan dan memproses transaksi

3

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 perihalan.

Parameter

NamaJenisDiperlukanPenerangan
amountintegerYaAmaun dalam sen (cth., 1000 = $10.00)
currencystringTidakKod mata wang ISO tiga huruf (lalai: USD)
descriptionstringTidakHuraian caj yang dikodkan URL
customerstringTidakID pelanggan Stripe sedia ada
emailstringTidakEmel pelanggan untuk resit
namestringTidakNama pelanggan yang dikodkan URL
metadatastringTidakPasangan nilai-kunci tersuai (JSON yang dikodkan URL)
callbackstringTidakURL untuk kembali selepas selesai
autoprocessbooleanTidakLangkau skrin utama dan mulakan pengecasan dengan segera
auto_returnbooleanTidakJalankan panggilan balik apabila hasil dimuatkan dan bukannya menunggu pedagang menolak dialog hasil. Lalai palsu.

Cipta Invois

payment://cart?

Cipta invois Stripe dengan item baris daripada katalog produk anda.

Parameter

NamaJenisDiperlukanPenerangan
pricesstringYaID harga yang dipisahkan koma dengan kuantiti (cth., price_abc:2,price_xyz:1)
customerstringTidakID pelanggan Stripe sedia ada
emailstringTidakEmel pelanggan untuk resit
namestringTidakNama pelanggan yang dikodkan URL
callbackstringTidakURL untuk kembali selepas selesai
auto_returnbooleanTidakJalankan panggilan balik apabila hasil dimuatkan dan bukannya menunggu pedagang menolak dialog hasil. Lalai palsu.

Bayar Invois Sedia Ada (iOS sahaja)

payment://invoice?

Kumpulkan pembayaran secara bersemuka dengan invois Stripe sedia ada. Amaun, mata wang, pelanggan dan cukai datang daripada invois — mengatasi mana-mana daripadanya akan ditolak. Pedagang mengetik kad melalui pembaca / Ketik untuk Bayar / 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 tidak terbuka akan ditolak dengan ralat yang boleh diambil tindakan.

Parameter

NamaJenisDiperlukanPenerangan
idstringYaID invois jalur (mesti bermula dengan in_)
callbackstringTidakURL untuk kembali selepas selesai. Menerima invoice_id dan payment_intent_id setelah berjaya.
metadatastringTidakPasangan nilai kunci tersuai (JSON yang dikodkan URL) digabungkan ke dalam metadata PaymentIntent
autoprocessbooleanTidakLangkau skrin utama dan mulakan pengecasan dengan segera
auto_returnbooleanTidakJalankan panggilan balik apabila hasil dimuatkan dan bukannya menunggu pedagang menolak dialog hasil. Lalai palsu.

Mengendalikan panggilan balik

Apabila transaksi selesai, Pembayaran untuk Stripe akan mengalihkan ke URL panggilan balik anda dengan parameter pertanyaan yang menunjukkan hasilnya. Secara lalai, pengalihan akan diaktifkan selepas pedagang menolak dialog hasil supaya mereka boleh mengambil tindakan selepas caj (emelkan resit, bayaran balik). Lulus auto_return=true kepada api sebaik sahaja hasilnya diketahui. Disokong pada iOS dan Android.

Parameter Panggilan Balik

ParameterNilai-nilaiPenerangan
statussuccess | error | cancelledHasil transaksi
charge_idstringID caj jalur (selepas berjaya)
invoice_idstringID invois Stripe (apabila berjaya, aliran pembayaran://invois sahaja)
payment_intent_idstringID Niat Pembayaran Stripe (apabila berjaya, aliran pembayaran://invois sahaja)
errorstringMesej ralat (apabila ralat)

Contoh

Caj mudah

Caj $10.00 hanya dengan sejumlah wang

payment://new?amount=1000

Cas 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

Cas 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

Pulangan automatik pada hasil

Jalankan panggilan balik sebaik sahaja hasilnya diketahui, dan bukannya menunggu pedagang menolak 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 bayaran 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 mengekod URL aksara khas dalam nilai parameter. Ruang menjadi %20, pendakap kerinting menjadi %7B dan %7D.

Bersedia untuk berintegrasi?

Muat turun aplikasi dan mula menguji integrasi anda hari ini.