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

Utlös betalningar från din app eller webbplats, skicka kunddata och hantera callbacks.

Dölj produkter med metadata

Håll produkter som bara säljs online utanför appen med en enda metadatanyckel.

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: appens aktuella valuta)
`description`	string	Nej	URL-kodad debiteringsbeskrivning
`customer`Alias: `customer_id`	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`Alias: `auto`	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.

Sälj varor från din katalog

payment://cart?

Fyll varukorgen med priser från din Stripe katalog mot en personlig betalning. Försäljningen sparas som en betald Stripe faktura. Ingenting skickas till kunden.

Parametrar

Namn	Typ	Obligatorisk	Beskrivning
`prices`Alias: `line_items`	string	Ja	Kommaavgränsade pris-ID:n med kvantiteter (t.ex. price_abc:2,price_xyz:1)
`coupon`	string	Nej	Stripe kupong-ID som ska tillämpas på varukorgen
`customer`Alias: `customer_id`	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`Alias: `auto`	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.

Betala en befintlig faktura

payment://invoice?

Samla in 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 / Tap to Pay / manuell inmatning; vid lyckad betalning markeras fakturan som betald utanför gränsen och länkas via charge_id och payment_intent_id metadata. Fakturor med prenumerationer, default_payment_method, eller statusen betald, ogiltig eller ej indrivbar avvisas med ett åtgärdsfel. Utkast till fakturor: iOS slutför dem först, Android avvisar dem med invoice_state_changed.

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`Alias: `auto`	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 lyckat resultat). iOS skickar debiterings-ID:t (ch_). Android skickar PaymentIntent-ID:t (pi_) och placerar debiterings-ID:t i stripe_charge_id.
`stripe_charge_id`	string	Stripe debiterings-ID (ch_) lyckades. Endast Android.
`invoice_id`	string	Stripe-faktura-ID (vid lyckad betalning, endast flödet payment://invoice)
`payment_intent_id`	string	Stripe PaymentIntent ID (vid lyckat köp). iOS: endast payment://invoice flöde. Android: varje kortköp.
`error`	string	Felmeddelande (vid fel)

Debitering debiterad men fakturan kunde inte markeras som betald: iOS returnerar status=error med charge_id, invoice_id och payment_intent_id. Android returnerar status=success med invoice_reconciliation_failed=true.

Äldre fält, behållna för äldre integrationer: success, amount, currency, chargeId, cancelled, error[message]. Nya integrationer ska läsa fälten ovan.

Exempel

Enkel debitering

Debitera 10,00 dollar 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 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_ABC123xyz

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

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

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

Varukorg med radartiklar

Ta betalt för produkter från din Stripe katalog

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

Betala en befintlig faktura

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-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-instrumentpanelen:

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

Att dölja produkter 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.

Ladda ner för iOS Ladda ner för Android

Kontakta supporten