Skip to content

Utvikler-API

Integrer og tilpass

Start Payment for Stripe fra din egen app eller nettside med URL-skjemaer, og styr hvilke produkter som vises i appen direkte fra Stripe-dashbordet.

Integrasjon med URL-skjemaer

Slik fungerer det

1

Appen din åpner en payment:// URL med parametere

2

Payment for Stripe starter og behandler transaksjonen

3

Når det er fullført, omdirigerer appen til tilbakeringings-URL-en din med resultatet

Endepunkter

Opprett en betaling

payment://new?

Behandle en engangsbetaling med beløp, valuta og beskrivelse.

Parametere

NavnTypeObligatoriskBeskrivelse
amountintegerJaBeløp i cent (f.eks. 1000 = $10,00)
currencystringNeiISO-valutakode med tre bokstaver (standard: USD)
descriptionstringNeiURL-kodet betalingsbeskrivelse
customerstringNeiEksisterende Stripe-kunde-ID
emailstringNeiKundens e-postadresse for kvittering
namestringNeiURL-kodet kundenavn
metadatastringNeiTilpassede nøkkelverdipar (URL-kodet JSON)
callbackstringNeiURL å gå tilbake til etter fullføring
autoprocessbooleanNeiHopp over startskjermen og start betalingen umiddelbart
auto_returnbooleanNeiUtfør tilbakeringing når resultatet lastes inn i stedet for å vente på at selgeren skal lukke resultatdialogboksen. Standard: false.

Opprett en faktura

payment://cart?

Opprett en Stripe-faktura med fakturalinjer fra produktkatalogen din.

Parametere

NavnTypeObligatoriskBeskrivelse
pricesstringJaKommaseparerte pris-ID-er med mengder (f.eks. price_abc:2,price_xyz:1)
customerstringNeiEksisterende Stripe-kunde-ID
emailstringNeiKundens e-postadresse for kvittering
namestringNeiURL-kodet kundenavn
callbackstringNeiURL å gå tilbake til etter fullføring
auto_returnbooleanNeiUtfør tilbakeringing når resultatet lastes inn i stedet for å vente på at selgeren skal lukke resultatdialogboksen. Standard: false.

Betal en eksisterende faktura (kun iOS)

payment://invoice?

Ta imot en betaling på stedet mot en eksisterende Stripe-faktura. Beløp, valuta, kunde og skatt kommer fra fakturaen. Forsøk på å overstyre noen av disse avvises. Selgeren tar kortet via leser / Tap to Pay / manuell inntasting; ved vellykket betaling merkes fakturaen som betalt utenfor Stripe (out-of-band) og kobles via metadataene charge_id og payment_intent_id. Fakturaer med abonnementer, default_payment_method eller annen status enn åpen avvises med en tydelig feilmelding.

Parametere

NavnTypeObligatoriskBeskrivelse
idstringJaStripe-faktura-ID (må starte med in_)
callbackstringNeiURL å gå tilbake til etter fullføring. Mottar invoice_id og payment_intent_id ved vellykket gjennomføring.
metadatastringNeiTilpassede nøkkelverdipar (URL-kodet JSON) slått sammen med PaymentIntent-metadataene
autoprocessbooleanNeiHopp over startskjermen og start betalingen umiddelbart
auto_returnbooleanNeiUtfør tilbakeringing når resultatet lastes inn i stedet for å vente på at selgeren skal lukke resultatdialogboksen. Standard: false.

Håndtering av tilbakeringinger

Når transaksjonen er fullført, omdirigerer Payment for Stripe til tilbakeringings-URL-en din med spørreparametere som angir resultatet. Som standard skjer omdirigeringen etter at selgeren har lukket resultatdialogboksen, slik at selgeren kan gjøre noe etter betalingen (sende kvittering på e-post, refundere). Angi auto_return=true for å utløse den så snart resultatet er kjent. Støttes på iOS og Android.

Tilbakeringingsparametere

ParameterVerdierBeskrivelse
statussuccess | error | cancelledResultatet av transaksjonen
charge_idstringStripe-betalings-ID (ved suksess)
invoice_idstringStripe-faktura-ID (ved suksess, kun payment://invoice-flyt)
payment_intent_idstringStripe PaymentIntent-ID (ved suksess, kun payment://invoice-flyt)
errorstringFeilmelding (ved feil)

Eksempler

Enkel betaling

Belast $10,00 med bare et beløp

payment://new?amount=1000

Belast med beskrivelse

Belast €25,00 med en beskrivelse

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

Belast med ny kunde

Belast $50,00 og opprett en kundepost

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

Belast eksisterende kunde

Belast en eksisterende Stripe-kunde med $75,00

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

Betaling med metadata

Belast $100,00 med tilpassede metadata for dine poster

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

Automatisk behandling med tilbakeringing

Hopp over startskjermen og gå tilbake til appen når du er ferdig

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

Automatisk retur ved resultat

Utfør tilbakeringingen så snart resultatet er kjent, i stedet for å vente på at selgeren skal lukke resultatdialogboksen.

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

Faktura med fakturalinjer

Opprett en faktura med produkter fra Stripe-katalogen din

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

Betal en eksisterende faktura (iOS)

Ta imot en betaling på stedet for en eksisterende Stripe-faktura. Returnerer invoice_id og payment_intent_id ved vellykket betaling.

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

Komplett eksempel

Alle parametere kombinert for en fullstendig integrert flyt

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

URL-koding

Husk å URL-kode spesialtegn i parameterverdier. Mellomrom blir %20, krøllparenteser blir %7B og %7D.

Skjul produkter med metadata

Skjul produkter i appen

Appen viser produktene og prisene fra Stripe-kontoen din. For å holde ett av dem utenfor appen (for eksempel varer som kun selges via nettbutikken din), legger du til denne metadatanøkkelen på produktet eller prisen i Stripe-dashbordet:

payment_hidden = true

På et produkt: skjuler produktet og alle prisene til produktet.

På en pris: skjuler bare den prisen.

Fjern nøkkelen, eller sett den til false, for å vise det igjen. Endringer gjelder neste gang appen laster produktlisten din.

Handlekurv-lenker fungerer fortsatt

Skjuling påvirker bare produktlisten i appen. payment://cart-URL-er som refererer til en skjult pris fungerer fortsatt, og eksisterende abonnementer påvirkes ikke.

Klar til å integrere?

Last ned appen og begynn å teste integrasjonen din i dag.