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.

Ressources	Autorisation	Description
Account	`connected_account_read`	Permet d’accéder aux comptes
Account link	`account_link_write`	Permet d’accéder aux liens de compte
Apple Pay Domain	`apple_pay_domain_read`, `apple_pay_domain_write`	Permet d’accéder aux ressources du domaine Apple Pay. Vous devez enregistrer vos domaines Web auprès d’Apple pour utiliser Apple Pay. Veuillez consulter la page sur l’enregistrement de domaine pour obtenir plus d’informations.
Application Fee	`application_fee_read`, `application_fee_write`	Permet d’accéder aux commissions de la plateforme
Balance	`balance_read`	Permet d’accéder au solde
Balance transaction source	`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`, `transfer_read`
Billing clock	`billing_clock_read`, `billing_clock_write`	Permet d’accéder aux horloges de simulation
Dispositif de mesure Billing	`billing_meter_read`, `billing_meter_write`	Permet d’accéder aux dispositifs de mesure Billing
Événements de mesure Billing	`billing_meter_event_read`, `billing_meter_event_write`	Permet d’accéder aux événements de mesure Billing
Charge	`charge_read`, `charge_write`	Permet d’accéder aux paiements
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`, `sku_read`
Configuration	`terminal_configuration_read`, `terminal_configuration_write`	Permet d’accéder aux configurations
Token de confirmation	`confirmation_token_read`	Accorde un accès en lecture aux tokens de confirmation
Token de confirmation (client)	`confirmation_token_client_write`	Accorde un accès en écriture aux tokens de confirmation provenant du client.
Connection Token	`terminal_connection_token_write`	Permet d’accéder aux tokens de connexion
Coupon	`coupon_read`, `coupon_write`	Permet d’accéder aux bons de réduction
Credit note	`credit_note_read`, `credit_note_write`	Permet d’accéder aux avoirs Cette autorisation génère également les autorisations suivantes : `invoice_read`,
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`.
Customer	`customer_read`, `customer_write`	Permet d’accéder aux clients Cette autorisation génère également l’autorisation suivante : `billing_clock_read`.
Dispute	`dispute_read`, `dispute_write`	Permet d’accéder aux litiges
Edit link	`edit_link_write`	Permet d’accéder aux liens de connexion
Elements	`elements_write`	Permet d’accéder aux composants Stripe.js
Droits	`entitlement_read`	Permet d’accéder aux Droits d’accès
Event	`event_read`	Permet d’accéder aux événements
File	`file_read`, `file_write`	Permet d’accéder aux fichiers
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`.
Issuing authorization	`issuing_authorization_read`, `issuing_authorization_write`	Permet d’accéder aux autorisations
Issuing card	`issuing_card_read`, `issuing_card_write`	Permet d’accéder aux cartes
Issuing cardholder	`issuing_cardholder_read`, `issuing_cardholder_write`	Permet d’accéder aux titulaires de cartes
Issuing dispute	`issuing_dispute_read`, `issuing_dispute_write`	Permet d’accéder aux litiges Issuing
Issuing transaction	`issuing_transaction_read, issuing_transaction_write`	Permet d’accéder aux transactions
Location	`terminal_location_read`, `terminal_location_write`	Permet d’accéder aux emplacements
Mandate	`mandate_read`, `mandate_write`	Permet d’accéder aux mandats
Order	`order_read`, `order_write`	Permet d’accéder aux commandes
Payment intent	`payment_intent_read`, `payment_intent_write`	Permet d’accéder aux PaymentIntents Si vous gérez les PaymentIntents avec les Elements Stripe.js, vous devez également demander `elements_write`. Cette autorisation génère également les autorisations suivantes : `product_read`, `sku_read`
Payment links	`payment_links_read`, `payment_links_write`	Permet d’accéder aux liens de paiement Cette autorisation génère également les autorisations suivantes : `mandate_read`, `product_read`, `sku_read`
Payment method	`payment_method_read`, `payment_method_write`	Permet d’accéder aux PaymentMethods Cette autorisation génère également l’autorisation suivante : `source_read`
Payout	`payout_read`, `payout_write`	Permet d’accéder aux virements
Plan	`plan_read`, `plan_write`	Permet d’accéder aux offres, aux tarifs et (implicitement) aux produits
Product	`product_read`, `product_write`	Permet d’accéder aux produits
Promotion Code	`promotion_code_read`, `promotion_code_write`	Permet d’accéder aux codes promotionnels
Quote	`quote_read`, `quote_write`	Permet d’accéder aux devis Cette autorisation génère également les autorisations suivantes : `sku_read`, `product_read`
Reader	`terminal_reader_read`, `terminal_reader_write`	Permet d’accéder aux lecteurs
Report Runs and Report Types	`report_runs_and_report_types_read`	Permet d’accéder aux types de rapports en lecture seule et d’exécuter des rapports
Review	`review_read`, `review_write`	Permet d’accéder aux vérifications
Secret	`secret_write`	Permet d’accéder aux clés secrètes
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`
Shipping rate	`shipping_rate_read`, `shipping_rate_write`	Permet d’accéder aux frais de livraison
SKU	`sku_read`, `sku_write`	Permet d’accéder aux unités de gestion des stocks
Source	`source_read`, `source_write`	Permet d’accéder aux sources
Subscription	`subscription_read`, `subscription_write`	Permet d’accéder aux abonnements
Tax rate	`tax_rate_read`, `tax_rate_write`	Permet d’accéder aux taux de taxe
Tax settings	`tax_settings_read`, `tax_settings_write`,	Permet d’accéder aux paramètres de Tax
Tax transaction	`tax_calculations_and_transactions_read`, `tax_calculations_and_transactions_write`,	Permet d’accéder aux calculs des taxes et aux transactions
Token	`token_read`, `token_write`	Permet d’accéder aux tokens
Top up	`top_up_read`, `top_up_write`	Permet d’accéder aux recharges
Transfer	`transfer_read`, `transfer_write`	Permet d’accéder aux transferts Cette autorisation génère également les autorisations suivantes : `payout_read`, `payout_write`
Usage record	`usage_record_read`, `usage_record_write`	Permet d’accéder aux enregistrements d’utilisation
User Email	`user_email_read`	Permet d’accéder aux adresses e-mail des utilisateurs
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.

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

Account

Account link

Apple Pay Domain

Application Fee

Balance

Balance transaction source

Billing clock

Dispositif de mesure Billing

Événements de mesure Billing

Charge

Checkout Session

Configuration

Token de confirmation

Token de confirmation (client)

Connection Token

Coupon

Credit note

Customer portal

Customer

Dispute

Edit link

Elements

Droits

Event

File

Invoice

Issuing authorization

Issuing card

Issuing cardholder

Issuing dispute

Issuing transaction

Location

Mandate

Order

Payment intent

Payment links

Payment method

Payout

Plan

Product

Promotion Code

Quote

Reader

Report Runs and Report Types

Review

Secret

Setup Intent

Shipping rate

SKU

Source

Subscription

Tax rate

Tax settings

Tax transaction

Token

Top up

Transfer

Usage record

User Email

Webhook

Autorisations relatives aux événements

Voir aussi