Utvecklar-API
Integrera med URL-scheman
Starta Payment for Stripe från din app eller webbplats för att behandla transaktioner. Skicka kunddata, belopp och produktinformation och hantera sedan återuppringningen när den är klar.
Hur det fungerar
Din app öppnar en betalning:// URL med parametrar
Betalning för Stripe startas och behandlar transaktionen
När det är klart omdirigerar appen till din återuppringnings-URL med resultatet
Slutpunkter
Skapa en debitering
payment://new?Bearbeta en engångsbetalning med belopp, valuta och beskrivning.
Parametrar
| Namn | Typ | Nödvändig | Beskrivning |
|---|---|---|---|
amount | integer | Ja | Belopp i cent (t.ex. 1000 = 10,00 USD) |
currency | string | Inga | ISO-valutakod med tre bokstäver (standard: USD) |
description | string | Inga | URL-kodad debiteringsbeskrivning |
customer | string | Inga | Befintligt Stripe-kund-ID |
email | string | Inga | Kundens e-postadress för kvitto |
name | string | Inga | URL-kodat kundnamn |
metadata | string | Inga | Anpassade nyckel-värde-par (URL-kodad JSON) |
callback | string | Inga | URL att återgå till efter avslutad |
autoprocess | boolean | Inga | Hoppa över startskärmen och starta laddningen direkt |
auto_return | boolean | Inga | Utlös återuppringning när resultatet laddas istället för att vänta på att säljaren stänger resultatdialogrutan. Standardvärdet är falskt. |
Skapa en faktura
payment://cart?Skapa en Stripe-faktura med radartiklar från din produktkatalog.
Parametrar
| Namn | Typ | Nödvändig | Beskrivning |
|---|---|---|---|
prices | string | Ja | Kommaavgränsade pris-ID:n med kvantiteter (t.ex. price_abc:2,price_xyz:1) |
customer | string | Inga | Befintligt Stripe-kund-ID |
email | string | Inga | Kundens e-postadress för kvitto |
name | string | Inga | URL-kodat kundnamn |
callback | string | Inga | URL att återgå till efter avslutad |
auto_return | boolean | Inga | Utlös återuppringning när resultatet laddas istället för att vänta på att säljaren stänger resultatdialogrutan. Standardvärdet är falskt. |
Betala en befintlig faktura (endast iOS)
payment://invoice?Gör en personlig betalning mot en befintlig Stripe-faktura. Belopp, valuta, kund och moms kommer från fakturan. Åsidosättning av någon av dessa avvisas. Handlaren trycker på ett kort via läsaren / Tryck för att betala / manuell inmatning; när fakturan lyckas markeras den som betald utanför betalningsbandet och länkas via metadata för charge_id och payment_intent_id. Fakturor med statusen prenumerationer, standardbetalningsmetod eller ej öppen avvisas med ett åtgärdsfel.
Parametrar
| Namn | Typ | Nödvändig | Beskrivning |
|---|---|---|---|
id | string | Ja | Stripe-faktura-ID (måste börja med in_) |
callback | string | Inga | URL att återgå till efter slutförande. Tar emot invoice_id och payment_intent_id vid lyckat resultat. |
metadata | string | Inga | Anpassade nyckel-värde-par (URL-kodad JSON) sammanfogade i PaymentIntent-metadata |
autoprocess | boolean | Inga | Hoppa över startskärmen och starta laddningen direkt |
auto_return | boolean | Inga | Utlös återuppringning när resultatet laddas istället för att vänta på att säljaren stänger resultatdialogrutan. Standardvärdet är falskt. |
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 handlaren stänger resultatdialogrutan så att de kan vidta åtgärder efter debitering (skicka ett kvitto via e-post, återbetala). Skicka auto_return=true så att resultatet aktiveras så snart som möjligt. 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 betalning://faktura) |
payment_intent_id | string | Stripe PaymentIntent ID (vid lyckad betalning, endast flödet payment://invoice) |
error | string | Felmeddelande (vid fel) |
Exempel
Enkel laddning
Debitera 10,00 USD 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 USD och skapa en kundpost
payment://new?amount=5000&name=John%20Smith&[email protected]Debitera befintliga kunder
Debitera 75,00 USD för en befintlig Stripe-kund
payment://new?amount=7500&customer=cus_ABC123xyzLadda med metadata
Debitera 100,00 USD för anpassad metadata för dina 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 bearbetning 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 retur på resultat
Utför återuppringningen så snart resultatet är känt, istället för att vänta på att handlaren stänger resultatdialogrutan.
payment://new?amount=3500&autoprocess=true&auto_return=true&callback=myapp://payment-completeFaktura med radposter
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)
Samla in personlig betalning 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.