Utvecklar-API
Integrera och anpassa
Starta Payment for Stripe från din egen app eller webbplats med URL-scheman, och styr vilka produkter som visas i appen direkt från din Stripe-instrumentpanel.
Integrera med URL-scheman
Hur det fungerar
Din app öppnar en payment:// URL med parametrar
Payment for Stripe startas och behandlar transaktionen
När det är klart omdirigerar appen till din återuppringnings-URL med resultatet
Slutpunkter
Skapa en debitering
payment://new?Genomför en engångsbetalning med belopp, valuta och beskrivning.
Parametrar
| Namn | Typ | Obligatorisk | Beskrivning |
|---|---|---|---|
amount | integer | Ja | Belopp i cent (t.ex. 1000 = 10,00 dollar) |
currency | string | Nej | ISO-valutakod med tre bokstäver (standard: USD) |
description | string | Nej | URL-kodad debiteringsbeskrivning |
customer | string | Nej | Befintligt Stripe-kund-ID |
email | string | Nej | Kundens e-postadress för kvitto |
name | string | Nej | URL-kodat kundnamn |
metadata | string | Nej | Anpassade nyckel-värde-par (URL-kodad JSON) |
callback | string | Nej | URL att återgå till när det är klart |
autoprocess | boolean | Nej | Hoppa över startskärmen och starta debiteringen direkt |
auto_return | boolean | Nej | Utlös återuppringning när resultatet laddas i stället för att vänta på att säljaren stänger resultatdialogrutan. Standard: false. |
Skapa en faktura
payment://cart?Skapa en Stripe-faktura med rader från din produktkatalog.
Parametrar
| Namn | Typ | Obligatorisk | Beskrivning |
|---|---|---|---|
prices | string | Ja | Kommaavgränsade pris-ID:n med kvantiteter (t.ex. price_abc:2,price_xyz:1) |
customer | string | Nej | Befintligt Stripe-kund-ID |
email | string | Nej | Kundens e-postadress för kvitto |
name | string | Nej | URL-kodat kundnamn |
callback | string | Nej | URL att återgå till när det är klart |
auto_return | boolean | Nej | Utlös återuppringning när resultatet laddas i stället för att vänta på att säljaren stänger resultatdialogrutan. Standard: false. |
Betala en befintlig faktura (endast iOS)
payment://invoice?Ta emot en betalning på plats mot en befintlig Stripe-faktura. Belopp, valuta, kund och moms kommer från fakturan. Försök att ändra något av dem avvisas. Säljaren debiterar kortet via läsare / Tap to Pay / manuell inmatning; vid lyckad betalning markeras fakturan som betald utanför Stripe (out-of-band) och länkas via metadata för charge_id och payment_intent_id. Fakturor med prenumerationer, default_payment_method eller annan status än öppen avvisas med ett tydligt felmeddelande.
Parametrar
| Namn | Typ | Obligatorisk | Beskrivning |
|---|---|---|---|
id | string | Ja | Stripe-faktura-ID (måste börja med in_) |
callback | string | Nej | URL att återgå till efter slutförande. Tar emot invoice_id och payment_intent_id vid lyckat resultat. |
metadata | string | Nej | Anpassade nyckel-värde-par (URL-kodad JSON) sammanfogade i PaymentIntent-metadata |
autoprocess | boolean | Nej | Hoppa över startskärmen och starta debiteringen direkt |
auto_return | boolean | Nej | Utlös återuppringning när resultatet laddas i stället för att vänta på att säljaren stänger resultatdialogrutan. Standard: false. |
Hantera återuppringningar
När transaktionen är klar omdirigerar Payment for Stripe till din återuppringnings-URL med frågeparametrar som anger resultatet. Som standard aktiveras omdirigeringen efter att säljaren stänger resultatdialogrutan så att de kan vidta åtgärder efter debitering (skicka ett kvitto via e-post, återbetala). Skicka auto_return=true för att utlösa den så snart resultatet är känt. Stöds på iOS och Android.
Återuppringningsparametrar
| Parameter | Värden | Beskrivning |
|---|---|---|
status | success | error | cancelled | Resultat av transaktionen |
charge_id | string | Stripe-debiterings-ID (vid lyckad betalning) |
invoice_id | string | Stripe-faktura-ID (vid lyckad betalning, endast flödet payment://invoice) |
payment_intent_id | string | Stripe PaymentIntent-ID (vid lyckad betalning, endast flödet payment://invoice) |
error | string | Felmeddelande (vid fel) |
Exempel
Enkel debitering
Debitera 10,00 dollar med bara ett belopp
payment://new?amount=1000Debitering med beskrivning
Debitera 25,00 € med en beskrivning
payment://new?amount=2500¤cy=eur&description=Coffee%20and%20pastryDebitering med ny kund
Debitera 50,00 dollar och skapa en kundpost
payment://new?amount=5000&name=John%20Smith&[email protected]Debitera befintlig kund
Debitera en befintlig Stripe-kund 75,00 dollar
payment://new?amount=7500&customer=cus_ABC123xyzDebitering med metadata
Debitera 100,00 dollar med anpassad metadata för din bokföring
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 återuppringning
Hoppa över startskärmen och återgå till din app när du är klar
payment://new?amount=3500&autoprocess=true&callback=myapp://payment-completeAutomatisk återgång vid resultat
Utlös återuppringningen så snart resultatet är känt, i stället för att vänta på att säljaren stänger resultatdialogrutan
payment://new?amount=3500&autoprocess=true&auto_return=true&callback=myapp://payment-completeFaktura med rader
Skapa en faktura med produkter från din Stripe-katalog
payment://cart?prices=price_coffee:2,price_muffin:1&[email protected]Betala en befintlig faktura (iOS)
Ta emot en betalning på plats för en befintlig Stripe-faktura. Returnerar invoice_id och payment_intent_id vid lyckad betalning.
payment://invoice?id=in_1ABC123xyz&autoprocess=true&callback=myapp://invoice-paidKomplett exempel
Alla parametrar kombinerade för ett helt integrerat flöde
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-kodning
Kom ihåg att URL-koda specialtecken i parametervärden. Mellanslag blir %20, klammerparenteser blir %7B och %7D.
Redo att integrera?
Ladda ner appen och börja testa din integration idag.