Referenzdokument Berechtigungen

Eine Liste der verfügbaren Ereignisse und die erforderlichen 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:

Command Line
stripe apps grant permission "PERMISSION_NAME" "EXPLANATION"

Ersetzen:

PERMISSION_NAME mit dem Namen der Berechtigung. Berechtigungsnamen für Objekte und Ereignisse finden Sie in den folgenden Abschnitten.
EXPLANATION mit einer 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 Berechtigung, die Sie zu Ihrer App hinzufügen möchten.

Nachdem Sie beispielsweise die Berechtigung customer_read hinzugefügt haben, könnte Ihre App-Manifestdatei wie folgt aussehen:

stripe-app.json
{
  "id": "com.example.app",
  "version": "1.2.3",
  "name": "Example App",
  "icon": "./example_icon_32.png",
  "permissions": [
    {
      "permission": "customer_read",
      "purpose": "Receive access to the customer’s phone number"
    }
  ],
}

Um eine Berechtigung zu entfernen, können Sie auch die CLI verwenden:

Command Line
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`	Gewährt Zugriff auf die Domain-Ressourcen von Apple Pay. Um Apple Pay nutzen zu können, müssen Sie Ihre Web-Domains bei Apple registrieren. Weitere Informationen finden Sie unter Domain-Registrierung.
Plattformgebühr	`application_fee_read`, `application_fee_write`	Gewährt Zugriff auf Plattformgebühren
Ausstehender Betrag	`balance_read`	Gewährt Zugriff auf Guthaben
Saldo-Transaktionsquelle	`balance_transaction_source_read`	Gewährt Zugriff zur Erweiterung des `source`-Attributs beim Abrufen von Saldo-Transaktionen Diese Berechtigung schließt auch folgende Berechtigungen ein: `application_fee_read`, `balance_read`, `transfer_read`
Abrechnungsuhr	`billing_clock_read`, `billing_clock_write`	Gewährt Zugriff auf Test-Uhren
Abrechnungszähler	`billing_meter_read`, `billing_meter_write`	Gewährt Zugriff auf Zähler
Abrechnungszählerereignisse	`billing_meter_event_read`, `billing_meter_event_write`	Gewährt Zugriff auf Billing-Zählerereignisse
Abbuchung	`charge_read`, `charge_write`	Gewährt Zugriff auf Abbuchungen
Checkout-Sitzung	`checkout_session_read`, `checkout_session_write`	Gewährt Zugriff auf Sitzungen Diese Berechtigung schließt auch folgende Berechtigungen ein: `mandate_read`, `payment_intent_read`, `payment_links_read`, `product_read`, `setup_intent_read`, `sku_read`
Konfiguration	`terminal_configuration_read`, `terminal_configuration_write`	Gewährt Zugriff auf Konfigurationen
Bestätigungs-Token	`confirmation_token_read`	Gewährt Lesezugriff auf Bestätigungs-Token
Bestätigungs-Token (Client)	`confirmation_token_client_write`	Gewährt Schreibzugriff auf Bestätigungs-Token vom Client.
Verbindungs-Token	`terminal_connection_token_write`	Gewährt Zugriff auf Verbindungs-Token
Gutschein	`coupon_read`, `coupon_write`	Gewährt Zugriff auf Gutscheine
Stornorechnung	`credit_note_read`, `credit_note_write`	Gewährt Zugriff auf Stornorechnungen Diese Berechtigung schließt auch folgende Berechtigungen ein: `invoice_read`,
Kundenportal	`customer_portal_read`, `customer_portal_write`	Gewährt Zugriff auf das Kundenportal Wenn Sie das Kundenportal zur Verwaltung von Abonnements oder Zahlungsmethoden verwenden, müssen Sie auch `elements_write` anfordern.
Kunde/Kundin	`customer_read`, `customer_write`	Gewährt Zugriff auf Kundinnen/Kunden Diese Berechtigung schließt auch folgende Berechtigung ein: `billing_clock_read`.
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
Berechtigungen	`entitlement_read`	Gewährt Zugriff auf Berechtigungen
Ereignis	`event_read`	Gewährt Zugriff auf Ereignisse
Datei	`file_read`, `file_write`	Gewährt Zugriff auf Dateien
Rechnung	`invoice_read`, `invoice_write`	Gewährt Zugriff auf Rechnungen Diese Berechtigung schließt auch folgende Berechtigung ein: `credit_note_read` Wenn Sie die gehostete Rechnungsseite zur Verwaltung von Rechnungen oder Zahlungsmethoden verwenden, müssen Sie auch `elements_write` anfordern.
Autorisierung in Issuing	`issuing_authorization_read`, `issuing_authorization_write`	Gewährt Zugriff auf Autorisierungen
Karte in Issuing	`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 in Issuing	`issuing_dispute_read`, `issuing_dispute_write`	Gewährt Zugriff auf angefochtene Zahlungen in Issuing
Transaktion in Issuing	`issuing_transaction_read, issuing_transaction_write`	Gewährt Zugriff auf Transaktionen
Ort:	`terminal_location_read`, `terminal_location_write`	Gewährt Zugriff auf Standorte
Mandat	`mandate_read`, `mandate_write`	Gewährt Zugriff auf Mandate
Bestellung	`order_read`, `order_write`	Gewährt Zugriff auf Bestellungen
Payment Intent	`payment_intent_read`, `payment_intent_write`	Gewährt Zugriff auf PaymentIntents Wenn Sie PaymentIntents mit Stripe.js Elements verwalten, müssen Sie auch `elements_write` anfordern. Diese Berechtigung schließt auch folgende Berechtigungen ein: `product_read`, `sku_read`
Zahlungslinks	`payment_links_read`, `payment_links_write`	Gewährt Zugriff auf Payment Links Diese Berechtigung schließt auch folgende Berechtigungen ein: `mandate_read`, `product_read`, `sku_read`
Zahlungsmethode	`payment_method_read`, `payment_method_write`	Gewährt Zugriff auf Zahlungsmethoden Diese Berechtigung schließt auch folgende Berechtigung ein: `source_read`
Auszahlung	`payout_read`, `payout_write`	Gewährt Zugriff auf Auszahlungen
Plan	`plan_read`, `plan_write`	Gewährt Zugriff auf Pläne, Preise und (implizit) Produkte
Produkt	`product_read`, `product_write`	Gewährt Zugriff auf Produkte
Promo-Code	`promotion_code_read`, `promotion_code_write`	Gewährt Zugriff auf Promo-Codes
Quote	`quote_read`, `quote_write`	Gewährt Zugriff auf Angebote Diese Berechtigung schließt auch folgende Berechtigungen ein: `sku_read`, `product_read`
Lesegerät	`terminal_reader_read`, `terminal_reader_write`	Gewährt Zugriff auf Lesegeräte
Berichtsverläufe und Berichtsarten	`report_runs_and_report_types_read`	Gewährt Lesezugriff auf Berichtstypen und ermöglicht die Erstellung von Berichtsausführungen
Prüfen	`review_read`, `review_write`	Gewährt Zugriff auf Überprüfungen
Geheimschlüssel	`secret_write`	Gewährt Zugriff auf Geheimschlüssel
Intent einrichten	`setup_intent_read`, `setup_intent_write`	Gewährt Zugriff auf SetupIntents Wenn Sie SetupIntents mit Stripe.js Elements verwalten, müssen Sie auch `elements_write` anfordern. Diese Berechtigung schließt auch folgende Berechtigung ein: `mandate_read`
Versandkosten	`shipping_rate_read`, `shipping_rate_write`	Gewährt Zugriff auf Versandkosten
SKU	`sku_read`, `sku_write`	Gewährt Zugriff auf SKUs
Quelle	`source_read`, `source_write`	Gewährt Zugriff auf Sources
Abonnement	`subscription_read`, `subscription_write`	Gewährt Zugriff auf Abonnements
Steuersatz	`tax_rate_read`, `tax_rate_write`	Gewährt Zugriff auf Steuersätze
Steuereinstellungen	`tax_settings_read`, `tax_settings_write`,	Gewährt Zugriff auf Steuereinstellungen
Steuerliche Transaktion	`tax_calculations_and_transactions_read`, `tax_calculations_and_transactions_write`,	Gewährt Zugriff auf Steuerberechnungen und Transaktionen
Token	`token_read`, `token_write`	Gewährt Zugriff auf Token
Aufladen	`top_up_read`, `top_up_write`	Gewährt Zugriff auf Aufstockungen
Überweisung	`transfer_read`, `transfer_write`	Gewährt Zugriff auf Transfers Diese Berechtigung schließt auch folgende Berechtigung ein: `payout_read`, `payout_write`
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`, `webhook_write`	Gewährt Zugriff auf Webhook-Endpoints Bei den meisten Apps müssen Sie `webhook_write` nicht einschließen. Richten Sie stattdessen einen Webhook ein, um Ereignisse von Ihren verbundenen Konten abzuhören. Wenn Sie `webhook_write` dennoch benötigen, wenden Sie sich an den Stripe-Support.

Berechtigungen für Ereignisse

Für jedes Ereignis, das von Ihrer App abonniert wird, müssen Sie mindestens eine der entsprechenden Berechtigungen anfordern.

Wird geladen ...

Referenzdokument Berechtigungen

Eine Liste der verfügbaren Ereignisse und die erforderlichen Berechtigungen.

Berechtigungen verwalten

Objektberechtigungen

Konto

Konto-Link

Apple Pay-Domain

Plattformgebühr

Ausstehender Betrag

Saldo-Transaktionsquelle

Abrechnungsuhr

Abrechnungszähler

Abrechnungszählerereignisse

Abbuchung

Checkout-Sitzung

Konfiguration

Bestätigungs-Token

Bestätigungs-Token (Client)

Verbindungs-Token

Gutschein

Stornorechnung

Kundenportal

Kunde/Kundin

Angefochtene Zahlung

Bearbeitungslink

Elements

Berechtigungen

Ereignis

Datei

Rechnung

Autorisierung in Issuing

Karte in Issuing

Erstellung von Karteninhaber/innen

Angefochtene Zahlung in Issuing

Transaktion in Issuing

Ort:

Mandat

Bestellung

Payment Intent

Zahlungslinks

Zahlungsmethode

Auszahlung

Plan

Produkt

Promo-Code

Quote

Lesegerät

Berichtsverläufe und Berichtsarten

Prüfen

Geheimschlüssel

Intent einrichten

Versandkosten

SKU

Quelle

Abonnement

Steuersatz

Steuereinstellungen

Steuerliche Transaktion

Token

Aufladen

Überweisung

Nutzungsdaten

Nutzer-E-Mail

Webhook

Berechtigungen für Ereignisse

Siehe auch