Entwickler-API
Integrieren mit URL-Schemas
Starten Sie die Stripe-Zahlungsabwicklung direkt in Ihrer App oder auf Ihrer Website, um Transaktionen zu verarbeiten. Übergeben Sie Kundendaten, Beträge und Produktinformationen und verarbeiten Sie anschließend den Callback nach Abschluss der Transaktion.
So funktioniert es
Ihre App öffnet eine Zahlung:// URL mit Parametern
Stripe startet die Zahlung und verarbeitet die Transaktion.
Nach Abschluss der Anwendung werden Sie mit dem Ergebnis an Ihre Callback-URL weitergeleitet.
Endpunkte
Eine Ladung erstellen
payment://new?Eine einmalige Zahlung mit Betrag, Währung und Beschreibung verarbeiten.
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
amount | integer | Ja | Betrag in Cent (z. B. 1000 = 10,00 $) |
currency | string | NEIN | Dreistelliger ISO-Währungscode (Standard: USD) |
description | string | NEIN | URL-codierte Gebührenbeschreibung |
customer | string | NEIN | Vorhandene Stripe-Kunden-ID |
email | string | NEIN | Kunden-E-Mail für den Beleg |
name | string | NEIN | URL-codierter Kundenname |
metadata | string | NEIN | Benutzerdefinierte Schlüssel-Wert-Paare (URL-codiertes JSON) |
callback | string | NEIN | URL, zu der nach Abschluss zurückgekehrt werden soll |
autoprocess | boolean | NEIN | Startbildschirm überspringen und Ladevorgang sofort starten |
auto_return | boolean | NEIN | Die Callback-Funktion soll beim Laden des Ergebnisses ausgelöst werden, anstatt darauf zu warten, dass der Händler den Ergebnisdialog schließt. Standardmäßig deaktiviert. |
Rechnung erstellen
payment://cart?Erstellen Sie eine Stripe-Rechnung mit Positionen aus Ihrem Produktkatalog.
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
prices | string | Ja | Durch Kommas getrennte Preis-IDs mit Mengen (z. B. price_abc:2,price_xyz:1) |
customer | string | NEIN | Vorhandene Stripe-Kunden-ID |
email | string | NEIN | Kunden-E-Mail für den Beleg |
name | string | NEIN | URL-codierter Kundenname |
callback | string | NEIN | URL, zu der nach Abschluss zurückgekehrt werden soll |
auto_return | boolean | NEIN | Die Callback-Funktion soll beim Laden des Ergebnisses ausgelöst werden, anstatt darauf zu warten, dass der Händler den Ergebnisdialog schließt. Standardmäßig deaktiviert. |
Eine bestehende Rechnung bezahlen (nur iOS)
payment://invoice?Eine persönliche Zahlung wird gegen eine bestehende Stripe-Rechnung eingezogen. Betrag, Währung, Kunde und Steuer werden aus der Rechnung übernommen. Änderungen dieser Daten sind nicht möglich. Der Händler führt eine Karte per Lesegerät/Tap-to-Pay/manueller Eingabe durch. Bei erfolgreicher Zahlung wird die Rechnung als außerbörslich bezahlt markiert und über die Metadaten charge_id und payment_intent_id verknüpft. Rechnungen mit Abonnements, der Standardzahlungsmethode oder dem Status „Nicht offen“ werden mit einer entsprechenden Fehlermeldung abgelehnt.
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
id | string | Ja | Stripe-Rechnungs-ID (muss mit in_ beginnen) |
callback | string | NEIN | URL, zu der nach Abschluss zurückgekehrt werden soll. Erhält bei Erfolg die Rechnungs-ID und die Zahlungsabsichts-ID. |
metadata | string | NEIN | Benutzerdefinierte Schlüssel-Wert-Paare (URL-codiertes JSON) wurden in die PaymentIntent-Metadaten integriert. |
autoprocess | boolean | NEIN | Startbildschirm überspringen und Ladevorgang sofort starten |
auto_return | boolean | NEIN | Die Callback-Funktion soll beim Laden des Ergebnisses ausgelöst werden, anstatt darauf zu warten, dass der Händler den Ergebnisdialog schließt. Standardmäßig deaktiviert. |
Bearbeitung von Rückrufen
Nach Abschluss der Transaktion leitet Payment for Stripe mit Abfrageparametern, die das Ergebnis angeben, an Ihre Callback-URL weiter. Standardmäßig erfolgt die Weiterleitung, nachdem der Händler den Ergebnisdialog geschlossen hat, damit er nach der Abbuchung weitere Aktionen durchführen kann (z. B. eine Quittung per E-Mail versenden oder eine Rückerstattung veranlassen). Mit `auto_return=true` wird die Weiterleitung ausgelöst, sobald das Ergebnis bekannt ist. Unterstützt iOS und Android.
Callback-Parameter
| Parameter | Werte | Beschreibung |
|---|---|---|
status | success | error | cancelled | Ergebnis der Transaktion |
charge_id | string | Stripe-Zahlungs-ID (bei Erfolg) |
invoice_id | string | Stripe-Rechnungs-ID (nur im Erfolgsfall, payment://invoice-Ablauf) |
payment_intent_id | string | Stripe PaymentIntent-ID (nur bei Erfolg, payment://invoice-Ablauf) |
error | string | Fehlermeldung (bei einem Fehler) |
Beispiele
Einfaches Aufladen
Berechnen Sie 10,00 $ mit nur einem Betrag
payment://new?amount=1000Gebühr mit Beschreibung
Gebühr 25,00 € mit Beschreibung
payment://new?amount=2500¤cy=eur&description=Coffee%20and%20pastryGebühr bei Neukunden
Berechnen Sie 50,00 $ und erstellen Sie einen Kundendatensatz.
payment://new?amount=5000&name=John%20Smith&[email protected]Bestehende Kunden belasten
Einem bestehenden Stripe-Kunden 75,00 $ in Rechnung stellen
payment://new?amount=7500&customer=cus_ABC123xyzAufladen mit Metadaten
Berechnen Sie 100,00 $ inklusive benutzerdefinierter Metadaten für Ihre Datensätze
payment://new?amount=10000&description=Invoice%20%231234&metadata=%7B%22order_id%22%3A%221234%22%2C%22location%22%3A%22Store%20A%22%7DAutomatische Verarbeitung mit Rückruffunktion
Überspringen Sie den Startbildschirm und kehren Sie nach Abschluss der Arbeit zu Ihrer App zurück.
payment://new?amount=3500&autoprocess=true&callback=myapp://payment-completeAutomatische Rückkehr zum Ergebnis
Die Callback-Funktion sollte ausgelöst werden, sobald das Ergebnis bekannt ist, anstatt darauf zu warten, dass der Händler den Ergebnisdialog schließt.
payment://new?amount=3500&autoprocess=true&auto_return=true&callback=myapp://payment-completeRechnung mit Einzelposten
Erstellen Sie eine Rechnung mit Produkten aus Ihrem Stripe-Katalog
payment://cart?prices=price_coffee:2,price_muffin:1&[email protected]Eine bestehende Rechnung bezahlen (iOS)
Akzeptiert Zahlungen vor Ort für eine bestehende Stripe-Rechnung. Gibt bei Erfolg die Rechnungs-ID und die Zahlungsabsichts-ID zurück.
payment://invoice?id=in_1ABC123xyz&autoprocess=true&callback=myapp://invoice-paidVollständiges Beispiel
Alle Parameter kombiniert für einen vollständig integrierten Durchfluss
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-Codierung
Denken Sie daran, Sonderzeichen in Parameterwerten URL-zu-kodieren. Leerzeichen werden zu %20, geschweifte Klammern zu %7B und %7D.
Bereit zur Integration?
Laden Sie die App herunter und testen Sie noch heute Ihre Integration.