Skip to content

Udvikler-API

Integrér og tilpas

Start Payment for Stripe fra din egen app eller hjemmeside med URL-skemaer, og styr hvilke produkter der vises i appen direkte fra dit Stripe Dashboard.

Integration med URL-skemaer

Sådan fungerer det

1

Din app åbner en payment:// URL med parametre

2

Payment for Stripe starter og behandler transaktionen

3

Når det er færdigt, omdirigerer appen til din callback-URL med resultatet

Endepunkter

Opret en betaling

payment://new?

Behandl en engangsbetaling med beløb, valuta og beskrivelse.

Parametre

NavnTypePåkrævetBeskrivelse
amountintegerJaBeløb i cent (f.eks. 1000 = $10,00)
currencystringNejISO-valutakode på tre bogstaver (standard: appens aktuelle valuta)
descriptionstringNejURL-kodet betalingsbeskrivelse
customerAlias: customer_idstringNejEksisterende Stripe-kunde-ID
emailstringNejKundens e-mailadresse til kvittering
namestringNejURL-kodet kundenavn
metadatastringNejBrugerdefinerede nøgle-værdi-par (URL-kodet JSON)
callbackstringNejURL, der åbnes, når handlingen er gennemført
autoprocessAlias: autobooleanNejSpring startskærmen over, og start betalingen med det samme
auto_returnbooleanNejUdløs callback, så snart resultatet indlæses, i stedet for at vente på, at sælgeren lukker resultatdialogen. Standard: false.

Sælg varer fra dit katalog

payment://cart?

Fyld kurven med priser fra dit Stripe katalog mod en personlig betaling. Salget gemmes som en betalt Stripe faktura. Intet sendes til kunden.

Parametre

NavnTypePåkrævetBeskrivelse
pricesAlias: line_itemsstringJaKommaseparerede pris-ID'er med antal (f.eks. price_abc:2,price_xyz:1)
couponstringNejStripe kupon-ID, der skal anvendes på kurven
customerAlias: customer_idstringNejEksisterende Stripe-kunde-ID
emailstringNejKundens e-mailadresse til kvittering
namestringNejURL-kodet kundenavn
metadatastringNejBrugerdefinerede nøgle-værdi-par (URL-kodet JSON)
callbackstringNejURL, der åbnes, når handlingen er gennemført
autoprocessAlias: autobooleanNejSpring startskærmen over, og start betalingen med det samme
auto_returnbooleanNejUdløs callback, så snart resultatet indlæses, i stedet for at vente på, at sælgeren lukker resultatdialogen. Standard: false.

Betal en eksisterende faktura

payment://invoice?

Modtag en personlig betaling mod en eksisterende Stripe faktura. Beløb, valuta, kunde og moms stammer fra fakturaen. Tilsidesættelse af disse afvises. Forhandleren trykker på et kort via læseren / Tap to Pay / manuel indtastning; når fakturaen er betalt, markeres den som "out of band" og linkes via charge_id og payment_intent_id metadata. Fakturaer med abonnementer, default_payment_method eller en status som betalt, ugyldig eller uopkrævet afvises med en handlingsrettet fejl. Udkast til fakturaer: iOS færdiggør dem først, Android afviser dem med invoice_state_changed.

Parametre

NavnTypePåkrævetBeskrivelse
idstringJaStripe-faktura-ID (skal starte med in_)
callbackstringNejURL, der åbnes, når handlingen er gennemført. Modtager invoice_id og payment_intent_id ved gennemført betaling.
metadatastringNejBrugerdefinerede nøgle-værdi-par (URL-kodet JSON) flettet ind i PaymentIntent-metadataene
autoprocessAlias: autobooleanNejSpring startskærmen over, og start betalingen med det samme
auto_returnbooleanNejUdløs callback, så snart resultatet indlæses, i stedet for at vente på, at sælgeren lukker resultatdialogen. Standard: false.

Håndtering af tilbagekald

Når transaktionen er gennemført, omdirigerer Payment for Stripe til din callback-URL med forespørgselsparametre, der angiver resultatet. Som standard sker omdirigeringen, når sælgeren lukker resultatdialogen, så sælgeren kan gøre noget efter betalingen (sende en kvittering via e-mail, refundere). Angiv auto_return=true for at udløse den, så snart resultatet er kendt. Understøttes på iOS og Android.

Tilbagekaldsparametre

ParameterVærdierBeskrivelse
statussuccess | error | cancelledResultat af transaktionen
charge_idstringStripe-debiterings-ID (ved succes). iOS sender debiterings-ID'et (ch_). Android sender PaymentIntent-ID'et (pi_) og placerer debiterings-ID'et i stripe_charge_id.
stripe_charge_idstringStripe-betalings-ID (ch_) er bekræftet. Kun Android.
invoice_idstringStripe-faktura-ID (kun ved succes, kun payment://invoice-flow)
payment_intent_idstringStripe PaymentIntent ID (ved succes). iOS: Kun payment://invoice flow. Android: Hvert kortsalg.
errorstringFejlmeddelelse (ved fejl)

Beløbet er registreret, men fakturaen kunne ikke markeres som betalt: iOS returnerer status=error med charge_id, invoice_id og payment_intent_id. Android returnerer status=success med invoice_reconciliation_failed=true.

Ældre felter, gemt for ældre integrationer: success, amount, currency, chargeId, cancelled, error[message]. Nye integrationer skal læse ovenstående felter.

Eksempler

Simpel betaling

Opkræv $10,00 med blot et beløb

payment://new?amount=1000

Opkræv med beskrivelse

Opkræv 25,00 € med en beskrivelse

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

Opkræv med ny kunde

Opkræv $50,00 og opret en kundepost

payment://new?amount=5000&name=John%20Smith&[email protected]

Opkræv betaling fra eksisterende kunde

Opkræv $75,00 hos en eksisterende Stripe-kunde

payment://new?amount=7500&customer=cus_ABC123xyz

Betaling med metadata

Opkræv $100,00 med brugerdefinerede metadata til dine optegnelser

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 tilbagekald

Spring startskærmen over, og vend tilbage til din app, når du er færdig

payment://new?amount=3500&autoprocess=true&callback=myapp://payment-complete

Automatisk retur ved resultat

Udløs callback, så snart resultatet er kendt, i stedet for at vente på, at sælgeren lukker resultatdialogen

payment://new?amount=3500&autoprocess=true&auto_return=true&callback=myapp://payment-complete

Kurv med linjevarer

Betaling for produkter fra dit Stripe katalog

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

Betal en eksisterende faktura

Tag imod en betaling på stedet for en eksisterende Stripe-faktura. Returnerer invoice_id og payment_intent_id, hvis betalingen er gennemført.

payment://invoice?id=in_1ABC123xyz&autoprocess=true&callback=myapp://invoice-paid

Komplet eksempel

Alle parametre kombineret for et fuldt integreret flow

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

Husk at URL-kode specialtegn i parameterværdier. Mellemrum bliver %20, krøllede parenteser bliver %7B og %7D.

Skjul produkter med metadata

Skjul produkter i appen

Appen viser produkterne og priserne fra din Stripe-konto. Vil du holde et af dem ude af appen (for eksempel varer, der kun sælges via din webshop), skal du tilføje denne metadatanøgle til produktet eller prisen i Stripe Dashboard:

payment_hidden = true

På et produkt: skjuler produktet og alle dets priser.

På en pris: skjuler kun den pris.

Fjern nøglen, eller sæt den til false, for at vise det igen. Ændringer træder i kraft, næste gang appen indlæser din produktliste.

Indkøbskurv-links virker fortsat

Skjulning påvirker kun produktlisten i appen. payment://cart-URL'er, der henviser til en skjult pris, virker stadig, og eksisterende abonnementer påvirkes ikke.

Klar til at integrere?

Download appen og begynd at teste din integration i dag.