Documentation relatives aux autorisations
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 :
stripe apps grant permission "PERMISSION_NAME" "EXPLANATION"
Remplacez :
PERMISSION_NAME
: nom de l’autorisation que vous souhaitez ajouter. Voir les noms d’autorisation acceptés.EXPLANATION
: explication relative à l’autorisation d’accès. Les utilisateurs voient cette explication lorsqu’ils installent votre application.
Répétez cette étape pour toutes les nouvelles autorisations que vous souhaitez ajouter à votre application.
Une fois l'autorisation ajoutée, le fichier du manifeste de votre application devrait ressembler à ceci :
Pour supprimer une autorisation, vous pouvez aussi utiliser la CLI :
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.
Ressource | Autorisation | Description |
---|---|---|
Compte | connected_account_read | Permet d’accéder aux comptes |
Lien de compte | account_link_write | Permet d’accéder aux liens de compte |
Domaine Apple Pay | 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. |
Commission de la plateforme | application_fee_read , application_fee_write | Permet d’accéder aux commissions de la plateforme |
Solde | balance_read | Permet d’accéder au solde |
Source de l’opération sur solde |
| Permet d’accéder à l’attribut Cette autorisation génère également les autorisations suivantes : |
Horloge de facturation | billing_clock_read , billing_clock_write | Permet d’accéder à des horloges de simulation |
Paiement | charge_read , charge_write | Permet d’accéder aux paiements |
Session Checkout |
| Permet d’accéder aux sessions Cette autorisation génère également les autorisations suivantes : |
Configuration | terminal_configuration_read , terminal_configuration_write | Grants access to Configurations |
Connection Token | terminal_connection_token_write | Grants access to Connection Tokens |
Bon de réduction | coupon_read , coupon_write | Permet d’accéder aux bons de réduction |
Avoir |
| Permet d’accéder aux avoirs Cette autorisation génère également les autorisations suivantes : |
Portail client |
| Grants access to the customer portal If you’re using the customer portal to manage subscriptions or payment methods, you must also request |
Client |
| Permet d’accéder aux clients Cette autorisation génère également l’autorisation suivante : |
Litige | dispute_read , dispute_write | Permet d’accéder aux litiges |
Modifier un lien | edit_link_write | Permet d’accéder aux liens de connexion |
Elements | elements_write | Accorde l’accès aux Elements Stripe.js |
Événement | event_read | Permet d’accéder aux événements |
Fichier | file_read , file_write | Permet d’accéder aux fichiers |
Facture |
| Permet d’accéder aux factures Cette autorisation génère également l’autorisation suivante : If you’re using the hosted invoice page to manage invoices or payment methods, you must also request |
Autorisation Issuing | issuing_authorization_read , issuing_authorization_write | Permet d’accéder aux autorisations |
Carte Issuing | issuing_card_read , issuing_card_write | Permet d’accéder aux cartes |
Titulaire de carte Issuing | issuing_cardholder_read , issuing_cardholder_write | Permet d’accéder aux titulaires de cartes |
Litige Issuing | issuing_dispute_read , issuing_dispute_write | Permet d’accéder aux litiges Issuing |
Transaction Issuing | issuing_transaction_read, issuing_transaction_write | Permet d’accéder aux transactions |
Location | terminal_location_read , terminal_location_write | Grants access to Locations |
Mandat | mandate_read , mandate_write | Permet d’accéder aux mandats |
Commande | order_read , order_write | Permet d’accéder aux commandes |
Payment Intent |
| Permet d’accéder aux PaymentIntents If you’re managing PaymentIntents with Stripe.js Elements, you must also request Cette autorisation génère également les autorisations suivantes : |
Liens de paiement |
| Permet d’accéder aux liens de paiement Cette autorisation génère également les autorisations suivantes : |
Moyen de paiement |
| Permet d’accéder aux PaymentMethods Cette autorisation génère également l’autorisation suivante : |
Virement | payout_read , payout_write | Permet d’accéder aux virements |
Plan | plan_read , plan_write | Grants access to Plans and Prices |
Produit | product_read , product_write | Permet d’accéder aux produits |
Code promotionnel | promotion_code_read , promotion_code_write | Grants access to Promotion Codes |
Devis |
| Permet d’accéder aux devis Cette autorisation génère également les autorisations suivantes : |
Reader | terminal_reader_read , terminal_reader_write | Grants access to Readers |
Exécutions de rapports et types de rapports | report_runs_and_report_types_read | Permet d’accéder aux types de rapports en lecture seule et d’exécuter des rapports |
Vérifier | review_read , review_write | Grants access to Reviews |
Secret | secret_write | Permet d’accéder aux clés secrètes |
Setup Intent |
| Permet d’accéder aux SetupIntents If you’re managing SetupIntents with Stripe.js Elements, you must also request Cette autorisation génère également l’autorisation suivante : |
Shipping rate | shipping_rate_read , shipping_rate_write | Grants access to Shipping Rates |
Unité de gestion des stocks | sku_read , sku_write | Permet d’accéder aux SKU |
Source | source_read , source_write | Permet d’accéder aux sources |
Abonnement | subscription_read , subscription_write | Permet d’accéder aux abonnements |
Taux de taxe | tax_rate_read , tax_rate_write | Permet d’accéder aux taux de taxe |
Token | token_read , token_write | Permet d’accéder aux tokens |
Recharger | top_up_read , top_up_write | Permet d’accéder aux recharges |
Transfert |
| Permet d’accéder aux transferts Cette autorisation génère également l’autorisation suivante : |
Enregistrement d’utilisation | usage_record_read , usage_record_write | Permet d’accéder aux enregistrements d’utilisation |
E-mail utilisateur | user_email_read | Permet d’accéder aux adresses e-mail des utilisateurs |
Webhook | webhook_read | Permet d’accéder aux endpoints de webhook |
Autorisations relatives aux événements
Pour chaque événement auquel votre application s’abonne, elle doit demander au moins l’une des autorisations correspondantes.