Documentation relatives aux autorisations

Liste des événements disponibles et des autorisations nécessaires.

Une application Stripe requiert une autorisation pour lire ou écrire des données utilisateur. Cela inclut les situations suivantes :

Accès aux objets API Stripe : voir Autorisations relatives aux objets
Abonnement à des événements : voir Autorisations relatives aux événements

Pour demander des autorisations, ajoutez-les au tableau permissions de votre fichier de manifeste d’application. Vous pouvez aussi gérer le tableau via la CLI. Les administrateurs de compte ayant installé votre application doivent accepter les demandes d’autorisation que vous avez ajoutées avant de pouvoir l’utiliser.

Si votre application effectue une action sans en avoir l’autorisation, Stripe peut envoyer une erreur de requête invalide.

Gérer les autorisations

Vous pouvez ajouter une autorisation au tableau permissions du fichier de manifeste d’application stripe-app.json en utilisant la commande suivante :

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

Remplacez :

PERMISSION_NAME avec le nom de l’autorisation. Vous trouverez les noms d’autorisation pour les objets et les événements dans les sections ci-dessous.
EXPLANATION avec une explication relative à l’autorisation d’accès. Les utilisateurs voient cette explication lorsqu’ils installent votre application.

Répétez cette étape pour chaque autorisation que vous souhaitez ajouter à votre application.

Par exemple, après avoir ajouté l’autorisation customer_read, le fichier du manifeste de votre application pourrait ressembler à ce qui suit :

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"
    }
  ],
}

Pour supprimer une autorisation, vous pouvez aussi utiliser la CLI :

Command Line
stripe apps revoke permission "PERMISSION_NAME"

Autorisations relatives aux objets

Pour chaque objet API que votre application lit ou écrit, vous devez demander au moins l’une des autorisations correspondantes.

Si vous développez des objets dans les réponses de vos requêtes API, vous devez également demander au moins une autorisation correspondante pour chaque objet API que vous développez.

Produit	Ressources	Autorisation	Description

Core	Balance	`balance_read`	Permet d’accéder au solde de la Balance.
Core	Source de l’opération sur solde	`balance_transaction_source_read`	Permet d’accéder à l’attribut `source` pour le développer lors de la récupération des opérations sur solde. Cette autorisation génère également les autorisations suivantes : `application_fee_read`, `balance_read` et `transfer_read`.
Core	Charge	`charge_read` `charge_write`	Permet d’accéder aux paiements.
Core	Token de confirmation (client)	`confirmation_token_client_write`	Accorde un accès en écriture aux tokens de confirmation provenant du client.
Core	Token de confirmation	`confirmation_token_read`	Permet d’accéder aux tokens de confirmation en lecture.
Core	Customer	`customer_read` `customer_write`	Permet d’accéder aux clients. Cette autorisation génère également l’autorisation suivante : `billing_clock_read`.
Core	Dispute	`dispute_read` `dispute_write`	Permet d’accéder aux litiges.
Core	Elements	`elements_write`	Permet d’accéder à Stripe.js Elements.
Core	Event	`event_read`	Permet d’accéder aux événements.
Core	File	`file_read` `file_write`	Permet d’accéder aux fichiers.
Core	Mandate	`mandate_read` `mandate_write`	Permet d’accéder aux mandats.
Core	Payment Intent	`payment_intent_read` `payment_intent_write`	Permet d’accéder à Payment Intents. Si vous gérez les Payment Intents avec les composants Elements Stripe.js, vous devez également demander `elements_write`. Cette autorisation génère également les autorisations suivantes : `product_read` et `sku_read`.
Core	Payment Links	`payment_links_read` `payment_links_write`	Permet d’accéder à Payment Links. Cette autorisation génère également les autorisations suivantes : `mandate_read`, `product_read` et `sku_read`.
Core	Moyen de paiement	`payment_method_read` `payment_method_write`	Permet d’accéder à Moyens de paiement. Cette autorisation génère également l’autorisation suivante : `source_read`
Core	Domaine des moyens de paiement	`payment_method_domain_read` `payment_method_domain_write`	Permet d’accéder aux Domaines de moyens de paiement.
Core	Payout	`payout_read` `payout_write`	Permet d’accéder aux virements.
Core	Product	`product_read` `product_write`	Permet d’accéder aux produits.
Core	Setup Intent	`setup_intent_read` `setup_intent_write`	Permet d’accéder aux SetupIntents. Si vous gérez les SetupIntents avec les Elements Stripe.js, vous devez également demander `elements_write`. Cette autorisation génère également l’autorisation suivante : `mandate_read`.
Core	Frais de livraison	`shipping_rate_read` `shipping_rate_write`	Permet d’accéder aux frais de livraison.
Core	Source	`source_read` `source_write`	Permet d’accéder aux sources.
Core	Token	`token_read` `token_write`	Permet d’accéder aux tokens.
Checkout	Checkout Session	`checkout_session_read` `checkout_session_write`	Permet d’accéder aux sessions. Cette autorisation génère également les autorisations suivantes : `mandate_read`, `payment_intent_read`, `payment_links_read`, `product_read`, `setup_intent_read` et `sku_read`.
Billing	Horloge de simulation	`billing_clock_read` `billing_clock_write`	Permet d’accéder aux Horloges de simulation.
Billing	Dispositif de mesure	`billing_meter_read` `billing_meter_write`	Permet d’accéder aux Compteurs.
Billing	Événements de mesure	`billing_meter_event_read` `billing_meter_event_write`	Permet d’accéder aux Événements du compteur.
Billing	Coupon	`coupon_read` `coupon_write`	Permet d’accéder aux bons de réduction.
Billing	Note de crédit .	`credit_note_read` `credit_note_write`	Permet d’accéder aux avoirs. Cette autorisation génère également les autorisations suivantes : `invoice_read`.
Billing	Customer portal	`customer_portal_read` `customer_portal_write`	Permet d’accéder au portail client. Si vous utilisez le portail client pour gérer les abonnements ou les moyens de paiement, vous devez également demander `elements_write`.
Billing	Droits	`entitlement_read`	Permet d’accéder aux droits d’accès.
Billing	Invoice	`invoice_read` `invoice_write`	Permet d’accéder aux factures. Cette autorisation génère également l’autorisation suivante : `credit_note_read`. Si vous utilisez la page de facture hébergée pour gérer des factures ou des moyens de paiement, vous devez également demander `elements_write`. –
Billing	Plan	`plan_read` `plan_write`	Permet d’accéder aux plans, aux tarifs et (implicitement) aux produits.
Billing	Promotion Code	`promotion_code_read` `promotion_code_write`	Permet d’accéder aux codes promotionnels.
Billing	Quote	`quote_read` `quote_write`	Permet d’accéder aux devis. Cette autorisation génère également les autorisations suivantes : `sku_read` et `product_read`.
Billing	Subscription	`subscription_read` `subscription_write`	Permet d’accéder aux Subscriptions
Billing	Tax rate	`tax_rate_read`, `tax_rate_write`	Permet d’accéder aux taux taxés
Billing	Usage record	`usage_record_read` `usage_record_write`	Permet d’accéder aux enregistrements d’utilisation.
Reporting	Report Runs and Report Types	`report_runs_and_report_types_read`	Permet d’accéder en lecture aux types de rapports et de créer des exécutions de rapports.
Connect	Account	`connected_account_read`	Permet d’accéder aux comptes en lecture.
Connect	Account link	`account_link_write`	Permet d’accéder à Account Links.
Connect	Application Fee	`application_fee_read` `application_fee_write`	Permet d’accéder aux commissions de plateforme.
Connect	Lien de connexion	`edit_link_write`	Permet d’accéder aux liens de connexion.
Connect	Recharge	`top_up_read` `top_up_write`	Permet d’accéder aux recharges.
Connect	Transfer	`transfer_read` `transfer_write`	Permet d’accéder à transferts. Cette autorisation génère également les autorisations suivantes : `payout_read` et `payout_write`.
Émission	Issuing authorization	`issuing_authorization_read` `issuing_authorization_write`	Permet d’accéder aux autorisations.
Émission	Issuing card	`issuing_card_read` `issuing_card_write`	Permet d’accéder aux cartes bancaires.
Émission	Issuing cardholder	`issuing_cardholder_read` `issuing_cardholder_write`	Permet d’accéder aux titulaires de carte.
Émission	Issuing dispute	`issuing_dispute_read` `issuing_dispute_write`	Permet d’accéder aux litiges Issuing.
Émission	Issuing transaction	`issuing_transaction_read` `issuing_transaction_write`	Permet d’accéder aux transactions.
Terminal	Configuration	`terminal_configuration_read` `terminal_configuration_write`	Permet d’accéder aux configurations.
Terminal	Connection Token	`terminal_connection_token_write`	Permet d’accéder aux tokens de connexion.
Terminal	Location	`terminal_location_read` `terminal_location_write`	Permet d’accéder aux emplacements.
Terminal	Reader	`terminal_reader_read` `terminal_reader_write`	Permet d’accéder aux lecteurs.
Taxes	Tax settings	`tax_settings_read` `tax_settings_write`	Permet d’accéder aux paramètres taxés.
Taxes	Tax transaction	`tax_calculations_and_transactions_read` `tax_calculations_and_transactions_write`	Permet d’accéder aux calculs des taxes et aux transactions.
Radar	Review	`review_read` `review_write`	Permet d’accéder aux vérifications.
Stripe Apps	Secret	`secret_write`	Permet d’accéder aux clés secrètes.
Stripe Apps	User Email	`user_email_read`	Permet d’accéder aux adresses e-mail des utilisateurs.
Webhooks	Webhook	`webhook_read` `webhook_write`	Permet d’accéder aux endpoints de webhook. Pour la plupart des applications, il n’est pas nécessaire d’ajouter `webhook_write`. Configurez plutôt un webhook pour écouter les événements de vos comptes connectés. Si vous avez toujours besoin de `webhook_write`, contactez le support Stripe.
Commandes	Order	`order_read` `order_write`	Permet d’accéder aux commandes.
Commandes	SKU	`sku_read` `sku_write`	Permet d’accéder aux unités de gestion des stocks.

Autorisations relatives aux événements

Pour chaque événement auquel votre application s’abonne, elle doit demander au moins l’une des autorisations correspondantes.

Chargement…

Documentation relatives aux autorisations

Liste des événements disponibles et des autorisations nécessaires.

Gérer les autorisations

Autorisations relatives aux objets

Autorisations relatives aux événements

Voir aussi