Udvikler-API
Integrer med URL-ordninger
Start Betaling for Stripe fra din app eller dit websted for at behandle transaktioner. Videresend kundedata, beløb og produktoplysninger, og håndter derefter tilbagekaldet, når det er færdigt.
Sådan fungerer det
Din app åbner en betaling:// URL med parametre
Betaling for Stripe starter og behandler transaktionen
Når det er færdigt, omdirigerer appen til din callback-URL med resultatet
Endepunkter
Opret en opkrævning
payment://new?Behandl en engangsbetaling med beløb, valuta og beskrivelse.
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
amount | integer | Ja | Beløb i cent (f.eks. 1000 = $10,00) |
currency | string | Ingen | ISO-valutakode med tre bogstaver (standard: USD) |
description | string | Ingen | URL-kodet debiteringsbeskrivelse |
customer | string | Ingen | Eksisterende Stripe-kunde-ID |
email | string | Ingen | Kundens e-mailadresse til kvittering |
name | string | Ingen | URL-kodet kundenavn |
metadata | string | Ingen | Brugerdefinerede nøgle-værdi-par (URL-kodet JSON) |
callback | string | Ingen | URL, der skal vendes tilbage til efter færdiggørelse |
autoprocess | boolean | Ingen | Spring startskærmen over og start opladning med det samme |
auto_return | boolean | Ingen | Udfør callback, når resultatet indlæses, i stedet for at vente på, at forhandleren lukker resultatdialogboksen. Standardværdi: falsk. |
Opret en faktura
payment://cart?Opret en Stripe-faktura med linjeelementer fra dit produktkatalog.
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
prices | string | Ja | Kommaseparerede pris-ID'er med mængder (f.eks. price_abc:2,price_xyz:1) |
customer | string | Ingen | Eksisterende Stripe-kunde-ID |
email | string | Ingen | Kundens e-mailadresse til kvittering |
name | string | Ingen | URL-kodet kundenavn |
callback | string | Ingen | URL, der skal vendes tilbage til efter færdiggørelse |
auto_return | boolean | Ingen | Udfør callback, når resultatet indlæses, i stedet for at vente på, at forhandleren lukker resultatdialogboksen. Standardværdi: falsk. |
Betal en eksisterende faktura (kun iOS)
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æser / Tryk for at betale / manuel indtastning; når betalingen lykkes, markeres fakturaen som betalt uden for båndet og linkes via metadataene charge_id og payment_intent_id. Fakturaer med status som abonnementer, standardbetalingsmetode eller ikke-åben afvises med en handlingsrettet fejl.
Parametre
| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
id | string | Ja | Stripe-faktura-ID (skal starte med in_) |
callback | string | Ingen | URL, der skal vendes tilbage til efter afslutning. Modtager invoice_id og payment_intent_id, når processen er gennemført. |
metadata | string | Ingen | Brugerdefinerede nøgle-værdi-par (URL-kodet JSON) flettet ind i PaymentIntent-metadataene |
autoprocess | boolean | Ingen | Spring startskærmen over og start opladning med det samme |
auto_return | boolean | Ingen | Udfør callback, når resultatet indlæses, i stedet for at vente på, at forhandleren lukker resultatdialogboksen. Standardværdi: falsk. |
Håndtering af tilbagekald
Når transaktionen er fuldført, omdirigerer Payment for Stripe til din callback-URL med forespørgselsparametre, der angiver resultatet. Som standard aktiveres omdirigeringen, når forhandleren lukker resultatdialogboksen, så de kan foretage handlinger efter debitering (sende en kvittering via e-mail, refundere). Giv auto_return=true besked, så snart resultatet er kendt. Understøttes på iOS og Android.
Tilbagekaldsparametre
| Parameter | Værdier | Beskrivelse |
|---|---|---|
status | success | error | cancelled | Resultat af transaktionen |
charge_id | string | Stripe-betalings-ID (ved succes) |
invoice_id | string | Stripe faktura-ID (kun ved succes, betaling://fakturaflow) |
payment_intent_id | string | Stripe PaymentIntent ID (kun ved succes, betaling://fakturaflow) |
error | string | Fejlmeddelelse (ved fejl) |
Eksempler
Simpel opladning
Opkræv 10,00 USD med blot et beløb
payment://new?amount=1000Opkræv med beskrivelse
Opkræv 25,00 € med en beskrivelse
payment://new?amount=2500¤cy=eur&description=Coffee%20and%20pastryOpkræv med ny kunde
Opkræv 50,00 USD og opret en kundepost
payment://new?amount=5000&name=John%20Smith&[email protected]Opkræv betaling fra eksisterende kunde
Opkræv 75,00 USD for en eksisterende Stripe-kunde
payment://new?amount=7500&customer=cus_ABC123xyzOpladning med metadata
Opkræv 100,00 USD for 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%7DAutomatisk 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-completeAutomatisk retur på resultat
Udfør tilbagekaldet, så snart resultatet er kendt, i stedet for at vente på, at forhandleren lukker resultatdialogboksen.
payment://new?amount=3500&autoprocess=true&auto_return=true&callback=myapp://payment-completeFaktura med linjeposter
Opret en faktura med produkter fra dit Stripe-katalog
payment://cart?prices=price_coffee:2,price_muffin:1&[email protected]Betal en eksisterende faktura (iOS)
Modtag personlig betaling 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-paidKomplet eksempel
Alle parametre kombineret for et fuldt integreret flow
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
Husk at URL-kode specialtegn i parameterværdier. Mellemrum bliver %20, krøllede parenteser bliver %7B og %7D.
Klar til at integrere?
Download appen og begynd at teste din integration i dag.