Bannière de notification

Affiche une bannière de notification qui répertorie les tâches en cours susceptibles d’affecter l’état ou les fonctionnalités d’un compte connecté. Les tâches peuvent concerner des interventions en matière de gestion des risques ou des exigences à remplir associées aux fonctionnalités de compte, telles que l’acceptation de paiements et de virements. La bannière ne s’affiche que lorsque le compte connecté doit répondre à des interventions liées aux risques ou fournir des exigences en attente de résolution après l’inscription initiale.

Options de collecte des exigences

Vous pouvez contrôler la collecte des exigences currently_due ou eventually_due et l’ajout des exigences futures en utilisant l’attribut collectionOptions lors de l’intégration du composant bannière de notification.

External account collection

Use the external_account_collection feature to control whether the component collects external account information. This parameter is enabled by default, and only platforms responsible for collecting updated information when requirements are due or change (including Custom accounts) can disable it. When external_account_collection is enabled, user authentication is required. You can opt out of Stripe user authentication with the disable_stripe_user_authentication parameter.

Disable Stripe user authentication

Utilisez la fonctionnalité disable_stripe_user_authentication pour contrôler si le composant nécessite une authentification utilisateur Stripe. La valeur par défaut est l’opposé de la valeur external_account_collection. Par exemple, si vous ne définissez pas external_account_collection, sa valeur est définie sur « true » par défaut, et disable_stripe_user_authentication est défini par défaut sur « false ». Cette valeur ne peut être « true » que pour les comptes pour lesquels controller.requirement_collection est application.

We recommend implementing 2FA or equivalent security measures as a best practice. For account configurations that support this feature, such as Custom accounts, you assume liability for connected accounts if they can’t pay back negative balances.

Créer une session de compte

Lorsque vous créez une session de compte, activez la bannière de notification en spécifiant notification_banner dans le paramètre components.

curl https://api.stripe.com/v1/account_sessions \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -d account=
{{CONNECTED_ACCOUNT_ID}} \
  -d "components[notification_banner][enabled]"=true \
  -d "components[notification_banner][features][external_account_collection]"=true

Afficher le composant de bannière de notification

// Include this element in your HTML
const notificationBanner = stripeConnectInstance.create('notification-banner');
container.appendChild(notificationBanner);

// Optional:
// notificationBanner.setCollectionOptions({
//   fields: 'eventually_due',
//   futureRequirements: 'include',
// })

Configurer le comportement de la bannière personnalisée

Vous pouvez configurer un comportement personnalisé, tel que des marges différentes lorsque la bannière inclut des notifications ou lorsque les notifications requièrent une action. Pour ce faire, définissez une fonction de rappel personnalisée via onNotificationsChange.

// index.html

<h1 id="notification-banner-action-warning"></h1>

<div id="notification-banner-container"></div>


// index.js
const handleNotificationsChange = (response) => {
  const warning = document.getElementById("notification-banner-action-warning");

  if (response.actionRequired > 0) {
    // Do something related to required actions, such as adding margins to the banner container or tracking the current number of notifications.
    warning.style.display = "block";
    warning.textContent =
      "You must resolve the notifications on this page before proceeding.";
  } else if (response.total > 0) {
    // Do something related to notifications that don't require action.
    warning.style.display = "block";
    warning.textContent = "The items below are in review.";
  } else {
    warning.style.display = "none";
  }
};


const container = document.getElementById('notification-banner-container');
const notificationBanner = stripeConnectInstance.create('notification-banner');
notificationBanner.setOnNotificationsChange(handleNotificationsChange);
container.appendChild(notificationBanner);

Effectuer des tests

Pour tester ce composant dans un environnement de test, indiquez différentes valeurs de test dans les champs pour lesquels la vérification échoue ou qui génèrent des exigences sur le compte. Par exemple, vous pouvez utiliser le composant de gestion des comptes pour saisir address_no_match dans line1 de l’adresse d’une personne afin de déclencher une non-concordance d’adresse. En production, il peut être difficile de vérifier que ce composant fonctionne comme prévu, car il est masqué lorsqu’un compte n’a pas d’éléments de bannière. Pour valider le fonctionnement de votre intégration, vous pouvez :

• Définir un rappel utilisant onNotificationsChange, qui vérifie que la valeur de response.total est égale à zéro
• Confirmer que le composant est affiché sans contenu à l’aide d’un gestionnaire de démarrage de chargeur

Inscription des comptes

Utilisez la bannière de notification une fois que le compte a terminé son inscription et soumis les informations details_submitted. La bannière n’affichera pas d’interface utilisateur si les informations details_submitted ne figurent pas dans le compte.