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
Appen din åpner en payment:// URL med parametere
Payment for Stripe starter og behandler transaksjonen
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
| Navn | Type | Obligatorisk | Beskrivelse |
|---|---|---|---|
amount | integer | Ja | Beløp i cent (f.eks. 1000 = $10,00) |
currency | string | Nei | ISO-valutakode med tre bokstaver (standard: USD) |
description | string | Nei | URL-kodet betalingsbeskrivelse |
customer | string | Nei | Eksisterende Stripe-kunde-ID |
email | string | Nei | Kundens e-postadresse for kvittering |
name | string | Nei | URL-kodet kundenavn |
metadata | string | Nei | Tilpassede nøkkelverdipar (URL-kodet JSON) |
callback | string | Nei | URL å gå tilbake til etter fullføring |
autoprocess | boolean | Nei | Hopp over startskjermen og start betalingen umiddelbart |
auto_return | boolean | Nei | Utfø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
| Navn | Type | Obligatorisk | Beskrivelse |
|---|---|---|---|
prices | string | Ja | Kommaseparerte pris-ID-er med mengder (f.eks. price_abc:2,price_xyz:1) |
customer | string | Nei | Eksisterende Stripe-kunde-ID |
email | string | Nei | Kundens e-postadresse for kvittering |
name | string | Nei | URL-kodet kundenavn |
callback | string | Nei | URL å gå tilbake til etter fullføring |
auto_return | boolean | Nei | Utfø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
| Navn | Type | Obligatorisk | Beskrivelse |
|---|---|---|---|
id | string | Ja | Stripe-faktura-ID (må starte med in_) |
callback | string | Nei | URL å gå tilbake til etter fullføring. Mottar invoice_id og payment_intent_id ved vellykket gjennomføring. |
metadata | string | Nei | Tilpassede nøkkelverdipar (URL-kodet JSON) slått sammen med PaymentIntent-metadataene |
autoprocess | boolean | Nei | Hopp over startskjermen og start betalingen umiddelbart |
auto_return | boolean | Nei | Utfø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
| Parameter | Verdier | Beskrivelse |
|---|---|---|
status | success | error | cancelled | Resultatet av transaksjonen |
charge_id | string | Stripe-betalings-ID (ved suksess) |
invoice_id | string | Stripe-faktura-ID (ved suksess, kun payment://invoice-flyt) |
payment_intent_id | string | Stripe PaymentIntent-ID (ved suksess, kun payment://invoice-flyt) |
error | string | Feilmelding (ved feil) |
Eksempler
Enkel betaling
Belast $10,00 med bare et beløp
payment://new?amount=1000Belast med beskrivelse
Belast €25,00 med en beskrivelse
payment://new?amount=2500¤cy=eur&description=Coffee%20and%20pastryBelast 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_ABC123xyzBetaling 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%7DAutomatisk 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-completeAutomatisk 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-completeFaktura 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-paidKomplett eksempel
Alle parametere kombinert for en fullstendig integrert flyt
payment://new?amount=15000¤cy=usd&description=Service%20Fee&customer=cus_ABC123xyz&metadata=%7B%22invoice%22%3A%22INV-2024-001%22%7D&autoprocess=true&callback=myapp://payment-resultURL-koding
Husk å URL-kode spesialtegn i parameterverdier. Mellomrom blir %20, krøllparenteser blir %7B og %7D.
Klar til å integrere?
Last ned appen og begynn å teste integrasjonen din i dag.