Skip to content
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

Cara ia berfungsi

  1. 1Aplikasi anda membuka payment:// URL dengan parameter
  2. 2Payment for Stripe dibuka dan memproses transaksi
  3. 3Setelah 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

  • amountintegerDiperlukanJumlah dalam sen (cth., 1000 = $10.00)
  • currencystringKod mata wang ISO tiga huruf (lalai: mata wang semasa aplikasi)
  • descriptionstringPenerangan caj yang dikodkan URL
  • customerstringAlias: customer_idID pelanggan Stripe sedia ada
  • emailstringE-mel pelanggan untuk resit
  • namestringNama pelanggan yang dikodkan URL
  • metadatastringPasangan kunci-nilai tersuai (JSON yang dikodkan URL)
  • callbackstringURL untuk kembali selepas selesai
  • autoprocessbooleanAlias: autoLangkau skrin utama dan mulakan caj dengan segera
  • auto_returnbooleanCetuskan panggilan balik sebaik sahaja hasil dimuatkan dan bukannya menunggu pedagang menutup dialog hasil. Lalai: false.

Jual Barang daripada Katalog Anda

payment://cart?Isi troli dengan harga daripada katalog Stripe anda dengan caj secara bersemuka. Jualan disimpan sebagai invois Stripe yang telah dibayar. Tiada apa-apa yang dihantar kepada pelanggan.

Parameter

  • pricesstringDiperlukanAlias: line_itemsID harga yang dipisahkan koma dengan kuantiti (cth., price_abc:2,price_xyz:1)
  • couponstringID kupon Stripe untuk digunakan pada troli
  • customerstringAlias: customer_idID pelanggan Stripe sedia ada
  • emailstringE-mel pelanggan untuk resit
  • namestringNama pelanggan yang dikodkan URL
  • metadatastringPasangan kunci-nilai tersuai (JSON yang dikodkan URL)
  • callbackstringURL untuk kembali selepas selesai
  • autoprocessbooleanAlias: autoLangkau skrin utama dan mulakan caj dengan segera
  • auto_returnbooleanCetuskan panggilan balik sebaik sahaja hasil dimuatkan dan bukannya menunggu pedagang menutup dialog hasil. Lalai: false.

Bayar Invois Sedia Ada

payment://invoice?Kutip bayaran secara bersemuka terhadap invois Stripe sedia ada. Amaun, mata wang, pelanggan dan cukai datang daripada invois tersebut. Penggantian mana-mana daripadanya akan ditolak. Pedagang akan mengetik kad melalui pembaca / Tap to Pay / entri manual; apabila berjaya, invois akan ditandakan sebagai dibayar di luar jalur dan dipautkan melalui metadata charge_id dan payment_intent_id. Invois dengan langganan, default_payment_method atau status dibayar, tidak sah atau tidak boleh dikutip akan ditolak dengan ralat yang boleh diambil tindakan. Draf invois: iOS memuktamadkannya terlebih dahulu, Android menolaknya dengan invoice_state_changed.

Parameter

  • idstringDiperlukanID invois Stripe (mesti bermula dengan in_)
  • callbackstringURL untuk kembali selepas selesai. Menerima invoice_id dan payment_intent_id setelah berjaya.
  • metadatastringPasangan kunci-nilai tersuai (JSON yang dikodkan URL) yang digabungkan ke dalam metadata PaymentIntent
  • autoprocessbooleanAlias: autoLangkau skrin utama dan mulakan caj dengan segera
  • auto_returnbooleanCetuskan 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

  • statussuccess | error | cancelledHasil transaksi
  • charge_idstringID caj Stripe (selepas berjaya). iOS menghantar ID caj (ch_). Android menghantar ID PaymentIntent (pi_) dan meletakkan ID caj dalam stripe_charge_id.
  • stripe_charge_idstringID cas Stripe (ch_) apabila berjaya. Android sahaja.
  • invoice_idstringID invois Stripe (apabila berjaya, aliran payment://invoice sahaja)
  • payment_intent_idstringID Stripe PaymentIntent (selepas berjaya). iOS: aliran payment://invoice sahaja. Android: setiap jualan kad.
  • errorstringMesej ralat (jika berlaku ralat)
Caj telah direkodkan tetapi invois tidak dapat ditandai sebagai telah dibayar: iOS mengembalikan status=error dengan charge_id, invoice_id dan payment_intent_id. Android mengembalikan status=success dengan invoice_reconciliation_failed=true.Medan legasi, disimpan untuk integrasi lama: success, amount, currency, chargeId, cancelled, error[message]. Integrasi baharu sepatutnya membaca medan di atas.

Contoh

  • Caj mudah

    Caj $10.00 dengan jumlah sahajapayment://new?amount=1000
  • Caj dengan penerangan

    Caj €25.00 dengan peneranganpayment://new?amount=2500&currency=eur&description=Coffee%20and%20pastry
  • Caj dengan pelanggan baharu

    Caj $50.00 dan cipta rekod pelangganpayment://new?amount=5000&name=John%20Smith&email=[email protected]
  • Caj pelanggan sedia ada

    Caj $75.00 kepada pelanggan Stripe sedia adapayment://new?amount=7500&customer=cus_ABC123xyz
  • Caj dengan metadata

    Caj $100.00 dengan metadata tersuai untuk rekod andapayment://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 selesaipayment://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 hasilpayment://new?amount=3500&autoprocess=true&auto_return=true&callback=myapp://payment-complete
  • Troli dengan item baris

    Caj untuk produk daripada katalog Stripe andapayment://cart?prices=price_coffee:2,price_muffin:1&email=[email protected]
  • Bayar invois sedia ada

    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 sepenuhnyapayment://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 URLIngat 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 berfungsiPenyembunyian 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.