Referenzdokument Berechtigungen
Eine Stripe -App benötigt die Berechtigung, Nutzerdaten zu lesen oder zu schreiben. Dazu gehören folgende Situationen:
- Zugriff auf Stripe-API-Objekte – siehe Objektberechtigungen
- Ereignisse abonnieren – siehe Ereignisberechtigungen
Um Berechtigungen anzufordern, listen Sie diese im Array permissions
in Ihrer App-Manifest-Datei auf. Sie können dieses Array auch über die CLI verwalten. Kontoadministratoren, die Ihre App installieren, müssen die von Ihnen aufgeführten Berechtigungen akzeptieren, bevor Sie die App verwenden können.
Wenn Ihre App eine Aktion ausführt, für die sie keine Berechtigung hat, kann Stripe einen Fehler bei ungültiger Anfrage ausgeben.
Berechtigungen verwalten
Sie können dem Array permissions
in Ihrer App-Manifestdatei stripe-app.json
mit dem folgenden Befehl eine Berechtigung hinzufügen:
stripe apps grant permission "PERMISSION_NAME" "EXPLANATION"
Ersetzen:
PERMISSION_NAME
: Der Name der Berechtigung, die Sie hinzufügen möchten. Siehe mögliche Berechtigungen.EXPLANATION
: Erklärung für die Aktivierung des Zugriffs. Nutzer/innen sehen diese Erklärung, wenn sie Ihre App installieren.
Wiederholen Sie diesen Schritt für jede neue Berechtigung, die Sie zu Ihrer App hinzufügen möchten.
Nachdem Sie Ihre Berechtigung hinzugefügt haben, sollte Ihre App-Manifestdatei wie folgt aussehen:
Um eine Berechtigung zu entfernen, können Sie auch die CLI verwenden:
stripe apps revoke permission "PERMISSION_NAME"
Objektberechtigungen
Für jedes API object, das Ihre App liest oder schreibt, muss es mindestens eine der entsprechenden Berechtigungen anfordern.
Wenn Sie in den Antworten auf Ihre API-Anfragen Objekte erweitern, müssen Sie auch mindestens eine entsprechende Berechtigung für jedes erweiterte API-Objekt anfordern.
Ressource | Berechtigung | Beschreibung |
---|---|---|
Konto | connected_account_read | Gewährt Zugriff auf das Lesen von Konten |
Konto-Link | account_link_write | Gewährt Zugriff auf Konto-Links |
Apple Pay-Domain | apple_pay_domain_read , apple_pay_domain_write | Grants access to Apple Pay Domain resources. To use Apple Pay, you need to register your web domains with Apple. See domain registration for more information. |
Plattformgebühr | application_fee_read , application_fee_write | Gewährt Zugriff auf Plattformgebühren |
Guthaben | balance_read | Gewährt Zugriff auf Guthaben |
Saldo-Transaktionsquelle |
| Gewährt Zugriff zur Erweiterung des Diese Berechtigung schließt auch folgende Berechtigungen ein: |
Abrechnungsuhr | billing_clock_read , billing_clock_write | Gewährt Zugriff auf Test-Uhren |
Zahlung | charge_read , charge_write | Gewährt Zugriff auf Zahlungen |
Checkout-Sitzung |
| Gewährt Zugriff auf Sitzungen Diese Berechtigung schließt auch folgende Berechtigungen ein: |
Configuration | terminal_configuration_read , terminal_configuration_write | Grants access to Configurations |
Connection Token | terminal_connection_token_write | Grants access to Connection Tokens |
Gutschein | coupon_read , coupon_write | Gewährt Zugriff auf Gutscheine |
Stornorechnung |
| Gewährt Zugriff auf Stornorechnungen Diese Berechtigung schließt auch folgende Berechtigungen ein: |
Kundenportal |
| Grants access to the customer portal If you’re using the customer portal to manage subscriptions or payment methods, you must also request |
Kund/in |
| Gewährt Zugriff auf Kund/innen Diese Berechtigung schließt auch folgende Berechtigung ein: |
Angefochtene Zahlung | dispute_read , dispute_write | Gewährt Zugriff auf angefochtene Zahlungen |
Bearbeitungslink | edit_link_write | Gewährt Zugriff auf Anmeldelinks |
Elements | elements_write | Gewährt Zugriff auf Stripe.js Elements |
Ereignis | event_read | Gewährt Zugriff auf Ereignisse |
Datei | file_read , file_write | Gewährt Zugriff auf Dateien |
Rechnung |
| Gewährt Zugriff auf Rechnungen Diese Berechtigung schließt auch folgende Berechtigung ein: If you’re using the hosted invoice page to manage invoices or payment methods, you must also request |
Erteilung einer Autorisierung | issuing_authorization_read , issuing_authorization_write | Gewährt Zugriff auf Autorisierungen |
Ausstellung einer Karte | issuing_card_read , issuing_card_write | Gewährt Zugriff auf Karten |
Erstellung von Karteninhaber/innen | issuing_cardholder_read , issuing_cardholder_write | Gewährt Zugriff auf Karteninhaber/innen |
Angefochtene Zahlung auslösen | issuing_dispute_read , issuing_dispute_write | Gewährt Zugriff auf auslösen angefochtener Zahlungen |
Transaktion ausstellen | issuing_transaction_read, issuing_transaction_write | Gewährt Zugriff auf Transaktionen |
Location | terminal_location_read , terminal_location_write | Grants access to Locations |
Mandat | mandate_read , mandate_write | Gewährt Zugriff auf Mandate |
Bestellung | order_read , order_write | Gewährt Zugriff auf Bestellungen |
Payment Intent |
| Gewährt Zugriff auf PaymentIntents If you’re managing PaymentIntents with Stripe.js Elements, you must also request Diese Berechtigung schließt auch folgende Berechtigungen ein: |
Zahlungslinks |
| Gewährt Zugriff auf Payment Links Diese Berechtigung schließt auch folgende Berechtigungen ein: |
Zahlungsmethode |
| Gewährt Zugriff auf Zahlungsmethoden Diese Berechtigung schließt auch folgende Berechtigung ein: |
Auszahlung | payout_read , payout_write | Gewährt Zugriff auf Auszahlungen |
Plan | plan_read , plan_write | Grants access to Plans and Prices |
Produkt | product_read , product_write | Gewährt Zugriff auf Produkte |
Promo-Code | promotion_code_read , promotion_code_write | Grants access to Promotion Codes |
Angebot |
| Gewährt Zugriff auf Angebote Diese Berechtigung schließt auch folgende Berechtigungen ein: |
Reader | terminal_reader_read , terminal_reader_write | Grants access to Readers |
Berichtsverläufe und Berichtsarten | report_runs_and_report_types_read | Gewährt Zugriff auf Report Types und ermöglicht das Erstellen von Report Runs |
Prüfen | review_read , review_write | Grants access to Reviews |
Geheimschlüssel | secret_write | Gewährt Zugriff auf Geheimschlüssel |
SetupIntent |
| Gewährt Zugriff auf SetupIntents If you’re managing SetupIntents with Stripe.js Elements, you must also request Diese Berechtigung schließt auch folgende Berechtigung ein: |
Shipping rate | shipping_rate_read , shipping_rate_write | Grants access to Shipping Rates |
SKU | sku_read , sku_write | Gewährt Zugriff auf SKUs |
Quelle | source_read , source_write | Gewährt Zugriff auf Quellen |
Abonnement | subscription_read , subscription_write | Gewährt Zugriff auf Abonnements |
Steuersatz | tax_rate_read , tax_rate_write | Gewährt Zugriff auf Steuersätze |
Token | token_read , token_write | Gewährt Zugriff auf Token |
Aufladung | top_up_read , top_up_write | Gewährt Zugriff auf Aufladungen |
Überweisung |
| Gewährt Zugriff auf Überweisungen Diese Berechtigung schließt auch folgende Berechtigung ein: |
Nutzungsdaten | usage_record_read , usage_record_write | Gewährt Zugriff auf Nutzungsdaten |
Nutzer-E-Mail | user_email_read | Gewährt Zugriff auf Nutzer-E-Mails |
Webhook | webhook_read | Gewährt Zugriff auf Webhook-Endpoints |
Berechtigungen für Ereignisse
Für jedes Ereignis, das von Ihrer App abonniert wird, müssen Sie mindestens eine der entsprechenden Berechtigungen anfordern.