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.

Produkt	Ressource	Berechtigung	Beschreibung

Core	Ausstehender Betrag	`balance_read`	Gewährt den Zugriff auf Salden.
Core	Quelle der Saldo-Transaktion	`balance_transaction_source_read`	Gewährt den Zugriff auf die Erweiterung des Attributs `source` beim Abrufen von Saldo-Transaktionen. Diese Berechtigung impliziert auch die folgenden Berechtigungen: `application_fee_read`, `balance_read`, und `transfer_read`.
Core	Abbuchung	`charge_read` `charge_write`	Gewährt den Zugriff auf Abbuchungen.
Core	Bestätigungs-Token (Client)	`confirmation_token_client_write`	Gewährt Schreibzugriff auf Bestätigungs-Token vom Client.
Core	Bestätigungs-Token	`confirmation_token_read`	Gewährt Lesezugriff auf Bestätigungs-Token.
Core	Kunde/Kundin	`customer_read` `customer_write`	Gewährt den Zugriff auf Kunden/Kundinnen. Diese Berechtigung schließt auch folgende Berechtigung ein: `billing_clock_read`.
Core	Angefochtene Zahlung	`dispute_read` `dispute_write`	Gewährt den Zugriff auf Zahlungsanfechtungen.
Core	Elements	`elements_write`	Gewährt den Zugriff auf Stripe.js-Elemente.
Core	Ereignis	`event_read`	Gewährt den Zugriff auf Ereignisse.
Core	Datei	`file_read` `file_write`	Gewährt den Zugriff auf Dateien.
Core	Mandat	`mandate_read` `mandate_write`	Gewährt den Zugriff auf Mandate.
Core	PaymentIntent	`payment_intent_read` `payment_intent_write`	Gewährt den Zugriff auf PaymentIntents. Wenn Sie PaymentIntents mit Stripe.js Elements verwalten, müssen Sie auch `elements_write` anfordern. Diese Berechtigung impliziert auch die folgenden Berechtigungen: `product_read` und `sku_read`.
Core	Payment Links	`payment_links_read` `payment_links_write`	Gewährt den Zugriff auf Zahlungs-Links. Diese Berechtigung impliziert auch die folgenden Berechtigungen: `mandate_read`, `product_read` und `sku_read`.
Core	Zahlungsmethode	`payment_method_read` `payment_method_write`	Gewährt den Zugriff auf Zahlungsmethoden. Diese Berechtigung schließt auch folgende Berechtigung ein: `source_read`
Core	Domain der Zahlungsmethode	`payment_method_domain_read` `payment_method_domain_write`	Gewährt den Zugriff auf Domains der Zahlungsmethode.
Core	Auszahlung	`payout_read` `payout_write`	Gewährt den Zugriff auf Auszahlungen.
Core	Produkt	`product_read` `product_write`	Gewährt den Zugriff auf Produkte.
Core	Intent einrichten	`setup_intent_read` `setup_intent_write`	Gewährt den Zugriff auf SetupIntents. Wenn Sie SetupIntents mit Stripe.js Elements verwalten, müssen Sie auch `elements_write` anfordern. Diese Berechtigung impliziert auch die folgende Berechtigung: `mandate_read`.
Core	Versandtarif	`shipping_rate_read` `shipping_rate_write`	Gewährt den Zugriff auf Versandtarife.
Core	Quelle	`source_read` `source_write`	Gewährt den Zugriff auf Quellen.
Core	Token	`token_read` `token_write`	Gewährt den Zugriff auf Token.
Bezahlvorgang	Checkout-Sitzung	`checkout_session_read` `checkout_session_write`	Gewährt den Zugriff auf Sessions. Diese Berechtigung impliziert auch die folgenden Berechtigungen: `mandate_read`, `payment_intent_read`, `payment_links_read`, `product_read`, `setup_intent_read` und `sku_read`.
Billing	Test-Uhr	`billing_clock_read` `billing_clock_write`	Gewährt den Zugriff auf Test-Uhren.
Billing	Zähler	`billing_meter_read` `billing_meter_write`	Gewährt den Zugriff auf Zähler.
Billing	Zählerereignisse	`billing_meter_event_read` `billing_meter_event_write`	Gewährt den Zugriff auf Zähler-Ereignisse.
Billing	Gutschein	`coupon_read` `coupon_write`	Gewährt den Zugriff auf Gutscheine.
Billing	Stornorechnung	`credit_note_read` `credit_note_write`	Gewährt den Zugriff auf Stornorechnungen. Diese Berechtigung impliziert auch die folgenden Berechtigungen: `invoice_read`.
Billing	Kundenportal	`customer_portal_read` `customer_portal_write`	Gewährt den Zugriff auf das Kundenportal . Wenn Sie das Kundenportal zur Verwaltung von Abonnements oder Zahlungsmethoden verwenden, müssen Sie auch `elements_write` anfordern.
Billing	Berechtigungen	`entitlement_read`	Gewährt den Zugriff auf Berechtigungen.
Billing	Rechnung	`invoice_read` `invoice_write`	Gewährt den Zugriff auf Rechnungsstellung. Diese Berechtigung impliziert auch die folgende Berechtigung: `credit_note_read`credit_note_read`. Wenn Sie die gehostete Rechnungsseite verwenden, um Rechnungen oder Zahlungen zu verwalten, müssen Sie auch `elements_write` anfordern.
Billing	Plan	`plan_read` `plan_write`	Gewährt den Zugriff auf Pläne, Preise, und (implizit) Produkte.
Billing	Promo-Code	`promotion_code_read` `promotion_code_write`	Gewährt den Zugriff auf Werbeaktion-Codes.
Billing	Quote	`quote_read` `quote_write`	Gewährt den Zugriff auf Quotes. Diese Berechtigung impliziert auch die folgenden Berechtigungen: `sku_read` und `product_read`.
Billing	Abonnement	`subscription_read` `subscription_write`	Gewährt den Zugriff auf auf Abonnements.
Billing	Steuersatz	`tax_rate_read`, `tax_rate_write`	Gewährt den Zugriff auf Steuersätze.
Billing	Nutzungsdaten	`usage_record_read` `usage_record_write`	Gewährt den Zugriff auf Nutzungsaufzeichnungen.
Berichterstattung	Berichtsverläufe und Berichtsarten	`report_runs_and_report_types_read`	Gewährt den Zugriff auf Berichtstypen und ermöglicht die Erstellung von Berichtsläufen.
Connect	Konto	`connected_account_read`	Gewährt den Lesezugriff auf Konten.
Connect	Konto-Link	`account_link_write`	Gewährt den Zugriff auf Konto-Links.
Connect	Plattformgebühr	`application_fee_read` `application_fee_write`	Gewährt den Zugriff auf Anwendungsgebühren.
Connect	Link zur Anmeldung	`edit_link_write`	Gewährt den Zugriff auf Anmeldungs-Links.
Connect	Aufstockung	`top_up_read` `top_up_write`	Gewährt den Zugriff auf Aufstockungen.
Connect	Überweisung	`transfer_read` `transfer_write`	Gewährt den Zugriff auf Übertragungen. Diese Berechtigung impliziert auch die folgende Berechtigung: `payout_read` und `payout_write`.
Issuing	Autorisierung in Issuing	`issuing_authorization_read` `issuing_authorization_write`	Gewährt den Zugriff auf Autorisierungen.
Issuing	Karte in Issuing	`issuing_card_read` `issuing_card_write`	Gewährt den Zugriff auf Karten.
Issuing	Erstellung von Karteninhaber/innen	`issuing_cardholder_read` `issuing_cardholder_write`	Gewährt den Zugriff auf Karteninhaber/innen.
Issuing	Angefochtene Zahlung in Issuing	`issuing_dispute_read` `issuing_dispute_write`	Gewährt den Zugriff auf Einleitung von Anfechtungen.
Issuing	Transaktion in Issuing	`issuing_transaction_read` `issuing_transaction_write`	Gewährt den Zugriff auf Transaktionen.
Terminal	Konfiguration	`terminal_configuration_read` `terminal_configuration_write`	Gewährt den Zugriff auf Konfigurationen.
Terminal	Verbindungs-Token	`terminal_connection_token_write`	Gewährt den Zugriff auf Verbindungs-Token.
Terminal	Ort:	`terminal_location_read` `terminal_location_write`	Gewährt den Zugriff auf Standorte.
Terminal	Lesegerät	`terminal_reader_read` `terminal_reader_write`	Gewährt den Zugriff auf Lesegeräte.
Steuer	Steuereinstellungen	`tax_settings_read` `tax_settings_write`	Gewährt den Zugriff auf Steuereinstellungen.
Steuer	Steuerliche Transaktion	`tax_calculations_and_transactions_read` `tax_calculations_and_transactions_write`	Gewährt den Zugriff auf Steuerberechnungen und -transaktionen.
Radar	Prüfen	`review_read` `review_write`	Gewährt den Zugriff auf Prüfungen.
Stripe-Apps	Geheimschlüssel	`secret_write`	Gewährt den Zugriff auf Geheimnisse.
Stripe-Apps	Nutzer-E-Mail	`user_email_read`	Gewährt den Zugriff auf die E-Mails der Nutzer/in.
Webhooks	Webhook	`webhook_read` `webhook_write`	Gewährt den 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.
Bestellungen	Bestellung	`order_read` `order_write`	Gewährt den Zugriff auf Bestellungen.
Bestellungen	SKU	`sku_read` `sku_write`	Gewährt den Zugriff auf SKUs.

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

Berechtigungen für Ereignisse

Siehe auch