Skip to content

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 Dashboard.

Integrera med URL-scheman

Hur det fungerar

1

Din app öppnar en betalning:// URL med parametrar

2

Betalning för Stripe startas och behandlar transaktionen

3

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

NamnTypNödvändigBeskrivning
amountintegerJaBelopp i cent (t.ex. 1000 = 10,00 USD)
currencystringIngaISO-valutakod med tre bokstäver (standard: USD)
descriptionstringIngaURL-kodad debiteringsbeskrivning
customerstringIngaBefintligt Stripe-kund-ID
emailstringIngaKundens e-postadress för kvitto
namestringIngaURL-kodat kundnamn
metadatastringIngaAnpassade nyckel-värde-par (URL-kodad JSON)
callbackstringIngaURL att återgå till efter avslutad
autoprocessbooleanIngaHoppa över startskärmen och starta laddningen direkt
auto_returnbooleanIngaUtlö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

NamnTypNödvändigBeskrivning
pricesstringJaKommaavgränsade pris-ID:n med kvantiteter (t.ex. price_abc:2,price_xyz:1)
customerstringIngaBefintligt Stripe-kund-ID
emailstringIngaKundens e-postadress för kvitto
namestringIngaURL-kodat kundnamn
callbackstringIngaURL att återgå till efter avslutad
auto_returnbooleanIngaUtlö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

NamnTypNödvändigBeskrivning
idstringJaStripe-faktura-ID (måste börja med in_)
callbackstringIngaURL att återgå till efter slutförande. Tar emot invoice_id och payment_intent_id vid lyckat resultat.
metadatastringIngaAnpassade nyckel-värde-par (URL-kodad JSON) sammanfogade i PaymentIntent-metadata
autoprocessbooleanIngaHoppa över startskärmen och starta laddningen direkt
auto_returnbooleanIngaUtlö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

ParameterVärdenBeskrivning
statussuccess | error | cancelledResultat av transaktionen
charge_idstringStripe-debiterings-ID (vid lyckad betalning)
invoice_idstringStripe-faktura-ID (vid lyckad betalning, endast flödet betalning://faktura)
payment_intent_idstringStripe PaymentIntent ID (vid lyckad betalning, endast flödet payment://invoice)
errorstringFelmeddelande (vid fel)

Exempel

Enkel laddning

Debitera 10,00 USD med bara ett belopp

payment://new?amount=1000

Debitering med beskrivning

Debitera 25,00 € med en beskrivning

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

Debitering 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_ABC123xyz

Ladda 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%7D

Automatisk 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-complete

Automatisk 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-complete

Faktura 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-paid

Komplett exempel

Alla parametrar kombinerade för ett helt integrerat flöde

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-kodning

Kom ihåg att URL-koda specialtecken i parametervärden. Mellanslag blir %20, klammerparenteser blir %7B och %7D.

Dölj produkter med metadata

Dölj produkter i appen

Appen visar produkterna och priserna från ditt Stripe-konto. För att hålla en av dem utanför appen (till exempel varor som bara säljs via din webbutik), lägg till denna metadatanyckel på produkten eller priset i Stripe Dashboard:

payment_hidden = true

På en produkt: döljer produkten och alla dess priser.

På ett pris: döljer bara det priset.

Ta bort nyckeln, eller sätt den till false, för att visa den igen. Ändringar gäller nästa gång appen läser in din produktlista.

Varukorgslänkar fortsätter att fungera

Döljning påverkar bara produktlistan i appen. payment://cart-URL:er som refererar till ett dolt pris fortsätter att fungera, och befintliga prenumerationer påverkas inte.

Redo att integrera?

Ladda ner appen och börja testa din integration idag.