Skip to content

API za razvojne programere

Integrirajte i prilagodite

Pokrenite Payment for Stripe iz vlastite aplikacije ili web stranice s URL shemama i kontrolirajte koji se proizvodi pojavljuju u aplikaciji izravno s vaše Stripe nadzorne ploče.

Integracija sa shemama URL-ova

Kako funkcionira

1

Vaša aplikacija otvara payment:// URL s parametrima

2

Payment for Stripe se pokreće i obrađuje transakciju

3

Nakon završetka, aplikacija preusmjerava na vaš URL povratnog poziva s rezultatom

Krajnje točke

Napravi naplatu

payment://new?

Obradite jednokratno plaćanje s iznosom, valutom i opisom.

Parametri

NazivTipObaveznoOpis
amountintegerDaIznos u centima (npr. 1000 = 10,00 USD)
currencystringNeTroslovni ISO kod valute (zadano: trenutna valuta aplikacije)
descriptionstringNeOpis naplate kodiran URL-om
customerAlias: customer_idstringNeID postojećeg Stripe kupca
emailstringNeE-pošta kupca za potvrdu
namestringNeURL-kodirano ime kupca
metadatastringNePrilagođeni parovi ključ-vrijednost (URL-kodirani JSON)
callbackstringNeURL za povratak nakon završetka
autoprocessAlias: autobooleanNePreskoči početni zaslon i odmah pokreni naplatu
auto_returnbooleanNeAktiviraj povratni poziv kada se rezultat učita umjesto čekanja da trgovac zatvori dijalog s rezultatima. Zadana vrijednost je "false".

Prodajte artikle iz svog kataloga

payment://cart?

Napunite košaricu cijenama iz svog Stripe kataloga za osobnu naplatu. Prodaja se sprema kao plaćeni Stripe račun. Kupcu se ništa ne šalje.

Parametri

NazivTipObaveznoOpis
pricesAlias: line_itemsstringDaID-ovi cijena odvojeni zarezima, s količinama (npr. price_abc:2,price_xyz:1)
couponstringNeID kupona Stripe za primjenu u košarici
customerAlias: customer_idstringNeID postojećeg Stripe kupca
emailstringNeE-pošta kupca za potvrdu
namestringNeURL-kodirano ime kupca
metadatastringNePrilagođeni parovi ključ-vrijednost (URL-kodirani JSON)
callbackstringNeURL za povratak nakon završetka
autoprocessAlias: autobooleanNePreskoči početni zaslon i odmah pokreni naplatu
auto_returnbooleanNeAktiviraj povratni poziv kada se rezultat učita umjesto čekanja da trgovac zatvori dijalog s rezultatima. Zadana vrijednost je "false".

Platite postojeću fakturu

payment://invoice?

Naplatite osobno na temelju postojećeg Stripe računa. Iznos, valuta, kupac i porez potječu s računa. Poništavanje bilo kojeg od tih podataka se odbija. Trgovac prisloni karticu putem čitača / Tap to Pay / ručno unese; u slučaju uspjeha, račun se označava kao plaćen izvan opsega i povezuje putem metapodataka charge_id i payment_intent_id. Računi s pretplatama, default_payment_method ili statusom plaćeno, nevažeće ili nenaplativo odbijaju se s pogreškom na koju se može poduzeti mjera. Nacrti računa: iOS ih prvo finalizira, Android ih odbija s invoice_state_changed.

Parametri

NazivTipObaveznoOpis
idstringDaID Stripe fakture (mora započeti s in_)
callbackstringNeURL za povratak nakon završetka. U slučaju uspjeha prima invoice_id i payment_intent_id.
metadatastringNePrilagođeni parovi ključ-vrijednost (URL-kodirani JSON) koji se spajaju u metapodatke PaymentIntenta
autoprocessAlias: autobooleanNePreskoči početni zaslon i odmah pokreni naplatu
auto_returnbooleanNeAktiviraj povratni poziv kada se rezultat učita umjesto čekanja da trgovac zatvori dijalog s rezultatima. Zadana vrijednost je "false".

Obrada povratnih poziva

Kada se transakcija završi, Payment for Stripe preusmjerava na vaš URL povratnog poziva s parametrima upita koji sadrže rezultat. Prema zadanim postavkama preusmjeravanje se aktivira nakon što trgovac zatvori dijalog s rezultatom, kako bi mogao poduzeti radnje nakon naplate (poslati potvrdu e-poštom, izvršiti povrat novca). Proslijedite auto_return=true da bi se preusmjeravanje aktiviralo čim je rezultat poznat. Podržano na iOS-u i Androidu.

Parametri povratnog poziva

ParametarVrijednostiOpis
statussuccess | error | cancelledRezultat transakcije
charge_idstringID naplate Stripe (u slučaju uspjeha). iOS šalje ID naplate (ch_). Android šalje ID namjere plaćanja (pi_) i stavlja ID naplate u stripe_charge_id.
stripe_charge_idstringID naplate Stripe (ch_) u slučaju uspjeha. Samo za Android.
invoice_idstringID Stripe fakture (u slučaju uspjeha, samo tijek payment://invoice)
payment_intent_idstringStripe PaymentIntent ID (u slučaju uspjeha). iOS: samo payment://invoice tijek. Android: svaka prodaja karticom.
errorstringPoruka o pogrešci (u slučaju greške)

Naplata je izvršena, ali račun nije mogao biti označen kao plaćen: iOS vraća status=error s charge_id, invoice_id i payment_intent_id. Android vraća status=success s invoice_reconciliation_failed=true.

Stara polja, sačuvana za starije integracije: success, amount, currency, chargeId, cancelled, error[message]. Nove integracije trebaju čitati gornja polja.

Primjeri

Jednostavna naplata

Naplatite 10,00 USD samo s iznosom

payment://new?amount=1000

Naplata s opisom

Naplatite 25,00 € s opisom

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

Naplata s novim kupcem

Naplatite 50,00 USD i stvorite zapis o kupcu

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

Naplata postojećem kupcu

Naplatite 75,00 USD postojećem Stripe kupcu

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

Naplata s metapodacima

Naplatite 100,00 USD s prilagođenim metapodacima za svoje zapise

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

Automatska obrada s povratnim pozivom

Preskočite početni zaslon i vratite se u svoju aplikaciju po završetku

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

Automatski povratak po rezultatu

Pokrenite povratni poziv čim je rezultat poznat, umjesto da se čeka da trgovac zatvori dijalog s rezultatom

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

Košarica s stavkama

Naplata za proizvode iz vašeg Stripe kataloga

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

Platite postojeću fakturu

Naplatite uživo postojeću Stripe fakturu. U slučaju uspjeha vraća invoice_id i payment_intent_id.

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

Potpuni primjer

Svi parametri zajedno za potpuno integrirani tijek

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

Kodiranje URL-ova

Ne zaboravite URL-kodirati posebne znakove u vrijednostima parametara. Razmaci postaju %20, vitičaste zagrade postaju %7B i %7D.

Sakrijte proizvode pomoću metapodataka

Skrivanje proizvoda iz aplikacije

Aplikacija prikazuje proizvode i cijene s vašeg Stripe računa. Da biste neki od njih izostavili iz aplikacije (na primjer, artikle koji se prodaju samo u vašoj online trgovini), dodajte ovaj ključ metapodataka proizvodu ili cijeni na Stripe nadzornoj ploči:

payment_hidden = true

Na proizvodu: skriva proizvod i sve njegove cijene.

Na cijeni: skriva samo tu cijenu.

Uklonite ključ ili ga postavite na vrijednost "false" da biste ga ponovno prikazali. Promjene se primjenjuju sljedeći put kada aplikacija učita vaš popis proizvoda.

Poveznice za košaricu i dalje rade

Skrivanje utječe samo na popis proizvoda unutar aplikacije. URL-ovi payment://cart koji upućuju na skrivenu cijenu i dalje rade, a postojeće pretplate ostaju nepromijenjene.

Spremni za integraciju?

Preuzmite aplikaciju i počnite testirati svoju integraciju već danas.