# Enregistrez vos informations pour vos futurs paiements par prélèvement automatique canadien Enregistrez les informations du moyen de paiement pour vos futurs paiements par prélèvement automatique canadien. # Paiement > This is a Paiement for when payment-ui is checkout. View the full page at https://docs.stripe.com/payments/acss-debit/set-up-payment?payment-ui=checkout. Vous pouvez utiliser l’[API Setup Intents](https://docs.stripe.com/payments/setup-intents.md) pour collecter à l’avance les données d’un moyen de paiement, en vue d’un paiement dont la date et le montant seront déterminés ultérieurement. Cette possibilité est utile pour : - Enregistrer des moyens de paiement dans un portefeuille pour faciliter les futurs achats - Encaisser des suppléments de facturation après la prestation d’un service - Mettre en place une période d’essai gratuite pour un abonnement > Pre-authorized debit in Canada est un **moyen de paiement à notification différée**, ce qui signifie que les fonds ne sont pas disponibles immédiatement après paiement. Il faut généralement **5 business days** pour qu’un paiement arrive sur votre compte. La plupart des comptes bancaires au Canada sont libellés en dollars canadiens (CAD), avec un petit nombre de comptes dans d’autres devises, notamment en dollars américains (USD). Il est possible d’accepter des paiements PAD en CAD ou en USD, mais il est important de choisir la devise adaptée à votre client afin d’éviter les échecs de paiement. Contrairement à de nombreux moyens de paiement par carte, vous pourriez ne pas être en mesure de prélever un montant en CAD d’un compte tenu en USD, ou inversement. La plupart du temps, ces tentatives de prélèvement engendre un échec de paiement différé dont la notification peut prendre jusqu’à cinq jours ouvrables. Pour éviter ces échecs, il est plus sûr de configurer les comptes bancaires PAD en CAD, sauf si vous êtes certain que le compte de votre client accepte les prélèvements en USD. ## Configurer Stripe [Côté serveur] Pour commencer, il vous faut un compte Stripe. [S’inscrire](https://dashboard.stripe.com/register). Utilisez nos bibliothèques officielles pour accéder à l’API Stripe depuis votre application : #### Ruby ```bash # Available as a gem sudo gem install stripe ``` ```ruby # If you use bundler, you can add this line to your Gemfile gem 'stripe' ``` ## Créer ou récupérer un objet Customer [Côté serveur] Pour réutiliser un compte bancaire pour des paiements futurs, le compte en question doit être associé à un objet [Customer](https://docs.stripe.com/api/customers.md). Créez un objet Customer lorsque votre client crée un compte auprès de votre entreprise. En associant l’ID de l’objet Customer à votre propre représentation interne de ce client, vous pourrez par la suite récupérer et utiliser les informations stockées concernant son moyen de paiement. Si votre client n’a pas créé de compte, il vous est toujours possible de lui créer un objet Customer sans attendre, que vous associerez ultérieurement à votre représentation interne de ce compte client. Créez ou récupérez un objet Customer client afin de l’associer à ces informations de paiement. Ajoutez le code suivant à votre serveur pour créer un objet Customer. ```curl curl -X POST https://api.stripe.com/v1/customers \ -u "<>:" ``` ## Configurer des paiements futurs > Ce guide s’appuie sur l’intégration de base Checkout qui permet de [configurer des paiements futurs](https://docs.stripe.com/payments/save-and-reuse.md). Utilisez ce guide pour apprendre à activer les prélèvements automatiques canadiens (PAD) : il montre les différences entre la configuration de paiements futurs à l’aide de méthodes dynamiques et la configuration manuelle des moyens de paiement et des PAD. ### Activer les paiements par prélèvement automatique canadien comme moyen de paiement Lors de la création d’une nouvelle [session Checkout](https://docs.stripe.com/api/checkout/sessions.md), vous devez : 1. Ajoutez `acss_debit` à la liste `payment_method_types`. 1. Définissez des paramètres [payment_method_options](https://docs.stripe.com/api/setup_intents/create.md#create_setup_intent-payment_method_options-acss_debit) supplémentaires pour décrire votre transaction. Découvrez plus d’informations à ce sujet ci-dessous. La [fréquence des paiements](https://docs.stripe.com/api/checkout/sessions/create.md#create_checkout_session-payment_method_options-acss_debit-mandate_options-payment_schedule) doit être définie, puis validée par les clients lors du paiement. Consultez la section [Mandats de prélèvement automatique](https://docs.stripe.com/payments/acss-debit.md#mandates) pour obtenir plus d’informations l’option de mandat qui convient de sélectionner pour votre entreprise : | Paramètre | Valeur | Obligatoire | | --------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ | | `payment_method_options[acss_debit][currency]` | Devise à utiliser pour les futurs paiements effectués avec ce moyen de paiement. Elle doit correspondre à la devise du compte bancaire du client. Les valeurs acceptées sont `cad` ou `usd`. | Oui | | `payment_method_options[acss_debit][mandate_options][payment_schedule]` | La fréquence des paiements définie dans le mandat. Les valeurs acceptées sont `interval`, `sporadic` ou `combined`. Consultez la section [Mandats de prélèvement automatique](https://docs.stripe.com/payments/acss-debit.md#mandates) pour vous aider à sélectionner la fréquence la plus adaptée à votre entreprise. | Oui | | `payment_method_options[acss_debit][mandate_options][interval_description]` | Description textuelle de la fréquence des paiements. Consultez l’aperçu [Mandats de prélèvement automatique](https://docs.stripe.com/payments/acss-debit.md#mandates) pour vous aider à élaborer la description de période la plus adaptée à votre entreprise. | Obligatoire si la valeur `payment_schedule` est définie sur `interval` ou `combined` | | `payment_method_options[acss_debit][mandate_options][transaction_type]` | Le type de transactions pour lesquelles vous utiliserez le mandat, qu’elles soient `personal` (si les transactions se font pour des raisons personnelles) ou `business` (si les transactions se font pour des raisons professionnelles). | Oui | | `payment_method_options[acss_debit][mandate_options][default_for]` | Un tableau des finalités du mandat. Pour en savoir plus, consultez la présentation des [mandats PAD](https://docs.stripe.com/payments/acss-debit.md#mandates) afin de choisir la finalité par défaut adaptée à votre entreprise. | Non | ### Créer une session Checkout #### Une page hébergée par Stripe ```curl curl https://api.stripe.com/v1/checkout/sessions \ -u "<>:" \ -d "customer={{CUSTOMER_ID}}" \ -d mode=setup \ -d "payment_method_options[acss_debit][currency]=cad" \ -d "payment_method_options[acss_debit][mandate_options][payment_schedule]=interval" \ -d "payment_method_options[acss_debit][mandate_options][interval_description]=First day of every month" \ -d "payment_method_options[acss_debit][mandate_options][transaction_type]=personal" \ -d "payment_method_types[]=acss_debit" \ --data-urlencode "success_url=https://example.com/success" ``` #### Formulaire intégré ```curl curl https://api.stripe.com/v1/checkout/sessions \ -u "<>:" \ -d "customer={{CUSTOMER_ID}}" \ -d mode=setup \ -d "payment_method_options[acss_debit][currency]=cad" \ -d "payment_method_options[acss_debit][mandate_options][payment_schedule]=interval" \ -d "payment_method_options[acss_debit][mandate_options][interval_description]=First day of every month" \ -d "payment_method_options[acss_debit][mandate_options][transaction_type]=personal" \ -d "payment_method_types[]=acss_debit" \ --data-urlencode "return_url=https://example.com/return" \ -d ui_mode=embedded_page ``` Lors de la session Checkout, une fenêtre modale d’interface utilisateur s’affiche pour le client. Elle lui permet de gérer la collecte des informations du compte bancaire et la vérification instantanée, ainsi qu’une vérification supplémentaire facultative par microversements. Si le client opte pour cette vérification par microversements, Stripe envoie automatiquement deux versements d’un faible montant au compte bancaire indiqué. Ces versements apparaissent au bout d’un à deux jours ouvrables sur le relevé bancaire en ligne du client. Au moment de leur arrivée, le client reçoit un e-mail contenant un lien pour *confirmer* (Confirming an intent indicates that the customer intends to use the current or provided payment method. Upon confirmation, the intent attempts to initiate the portions of the flow that have real-world side effects) ces montants et vérifier le compte bancaire avec Stripe. Une fois cette vérification effectuée, le moyen de paiement est prêt à être utilisé pour les futurs paiements. ## Tester votre intégration ### Tokens de moyens de paiement de test Utilisez des tokens de moyens de paiement de test pour tester votre intégration sans avoir à saisir manuellement les informations du compte bancaire. Ces tokens contournent les étapes de collecte et de vérification du compte bancaire. | Token | Scénario | | --------------------------------- | --------------------------------------------------------------------- | | `pm_acssDebit_success` | Le paiement est effectué immédiatement après l’acceptation du mandat. | | `pm_acssDebit_noAccount` | Le paiement échoue car aucun compte n’est trouvé. | | `pm_acssDebit_accountClosed` | Le paiement échoue parce que le compte est clôturé. | | `pm_acssDebit_insufficientFunds` | Le paiement échoue en raison de fonds insuffisants. | | `pm_acssDebit_debitNotAuthorized` | Le paiement échoue parce que les débits ne sont pas autorisés. | | `pm_acssDebit_dispute` | Le paiement est effectué mais déclenche un litige | ### Numéros de comptes de test Stripe fournit plusieurs numéros de compte test que vous pouvez utiliser pour vous assurer que votre intégration pour les comptes bancaires saisis manuellement sont prêts pour le mode production. Tous les comptes test avec un paiement qui réussit ou échoue automatiquement doivent être vérifiés à l’aide des montants de microversement test ci-dessous avant de pouvoir être effectués. | Numéro d’établissement | Numéro de transit | Numéro de compte | Scénario | | ---------------------- | ----------------- | ---------------- | ---------------------------------------------------------------------------------------------------------------------------------- | | `000` | `11000` | `000123456789` | Réussite immédiate du paiement après la vérification des microversements. | | `000` | `11000` | `900123456789` | Réussite du paiement avec un délai de trois minutes après la vérification des microversements. | | `000` | `11000` | `000222222227` | Échec immédiat du paiement après la vérification des microversements. | | `000` | `11000` | `900222222227` | Échec du paiement avec un délai de trois minutes après la vérification des microversements. | | `000` | `11000` | `000666666661` | Échec d’envoi des microversements de vérification. | | `000` | `11000` | `000777777771` | Échec du paiement, car le montant du paiement a entraîné le dépassement de la limite de volume de paiement hebdomadaire du compte. | | `000` | `11000` | `000888888881` | Échec du paiement, car son montant dépasse la limite du volume de transactions du compte. | Pour simuler les réussites ou les échecs de la vérification des comptes bancaires dans un environnement de test, utilisez ces montants représentatifs pour les microversements : | Valeurs des micro-versements | Scénario | | ----------------------------------- | ----------------------------------------------------------------------- | | `32` et `45` | Vérification du compte réussie. | | `10` et `11` | Simule le dépassement du nombre de tentatives de vérification autorisé. | | Toute autre combinaison de montants | Échec de la vérification du compte. | ## Utilisez le moyen de paiement [Côté serveur] Une fois la session Checkout effectuée, vous pouvez [collecter](https://docs.stripe.com/payments/checkout/save-and-reuse.md?payment-ui=stripe-hosted#retrieve-checkout-session) les ID des objets [PaymentMethod](https://docs.stripe.com/api/payment_methods.md) et [Mandate](https://docs.stripe.com/api/mandates.md). Ils peuvent être utilisés pour initier des paiements futurs sans devoir demander les coordonnées bancaires du client une seconde fois. > Les futurs paiements par prélèvement automatique doivent être débités conformément aux conditions mentionnées dans le mandat existant. Tout prélèvement réalisé à une date quelconque en violation des conditions du mandat pourrait donner lieu à une contestation de paiement. Au moment de facturer votre client hors session, fournissez les ID des objets `payment_method`, `customer` et `mandate` lors de la [création d’un PaymentIntent](https://docs.stripe.com/api/payment_intents/create.md). Si vous n’avez pas encore capturer l’ID du SetupIntent, vous pouvez rechercher les objets PaymentMethod et Mandate pour la débiter en [dressant](https://docs.stripe.com/api/setup_intents/list.md) la liste des SetupIntents associés à votre client : ```curl curl -G https://api.stripe.com/v1/setup_intents \ -u "<>:" \ -d "customer={{CUSTOMER_ID}}" ``` ### Réutilisation d’un moyen de paiement avec un mandat de autoriser existant Après avoir obtenu les ID de PaymentMethod et de Mandate à partir du SetupIntent approprié, créez un PaymentIntent indiquant le montant et la devise du paiement. Définissez quelques autres paramètres afin d’effectuer le *paiement hors session* (A payment is described as off-session if it occurs without the direct involvement of the customer, using previously-collected payment information) : - Définissez la propriété [confirm](https://docs.stripe.com/api/payment_intents/create.md#create_payment_intent-confirm) du PaymentIntent sur la valeur `true`, ce qui aura pour effet de générer immédiatement une confirmation lors de la création du PaymentIntent. - Renseignez l’ID de l’objet PaymentMethod dans [payment_method](https://docs.stripe.com/api/payment_intents/create.md#create_payment_intent-payment_method), l’ID de l’objet Mandate dans [mandate](https://docs.stripe.com/api/payment_intents/create.md#create_payment_intent-mandate) et l’ID de l’objet Customer dans [customer](https://docs.stripe.com/api/payment_intents/create.md#create_payment_intent-customer). ```curl curl https://api.stripe.com/v1/payment_intents \ -u "<>:" \ -d "payment_method_types[]=acss_debit" \ -d "payment_method={{PAYMENTMETHOD_ID}}" \ -d "customer={{CUSTOMER_ID}}" \ -d "mandate={{MANDATE_ID}}" \ -d confirm=true \ -d amount=100 \ -d currency=cad ``` Un e-mail de notification de prélèvement doit être envoyé lorsque vous réutilisez un mandat existant avec le nouveau PaymentIntent. Par défaut, Stripe s’en occupe à votre place, sauf si vous choisissez d’[envoyer des notifications personnalisées](https://docs.stripe.com/payments/acss-debit.md#mandate-and-debit-notification-emails). ## Optional: Vérification instantanée uniquement [Côté serveur] Par défaut, les paiements par prélèvement préautorisé canadien permettent à vos clients d’utiliser soit la vérification instantanée du compte bancaire, soit les microdépôts. Vous pouvez exiger uniquement la vérification instantanée en utilisant le paramètre `payment_method_options[acss_debit][verification_method]` lors de la création de la session Checkout. ```curl curl https://api.stripe.com/v1/checkout/sessions \ -u "<>:" \ -d mode=setup \ -d customer={{CUSTOMER_ID}} \ -d "payment_method_types[]=acss_debit" \ -d "payment_method_options[acss_debit][currency]=cad" \ -d "payment_method_options[acss_debit][mandate_options][payment_schedule]=interval" \ --data-urlencode "payment_method_options[acss_debit][mandate_options][interval_description]=On November 25, 2021" \ -d "payment_method_options[acss_debit][mandate_options][transaction_type]=personal" \ -d "payment_method_options[acss_debit][verification_method]=instant" \ --data-urlencode "success_url=https://example.com/success" ``` ## Optional: Vérification par microversements uniquement [Côté serveur] Par défaut, les paiements par prélèvement préautorisé canadien permettent à vos clients d’utiliser soit la vérification instantanée du compte bancaire, soit les microdépôts. Vous pouvez exiger uniquement la vérification par microdépôts en utilisant le paramètre `payment_method_options[acss_debit][verification_method]` lors de la création de la session Checkout. ```curl curl https://api.stripe.com/v1/checkout/sessions \ -u "<>:" \ -d mode=setup \ -d customer={{CUSTOMER_ID}} \ -d "payment_method_types[]=acss_debit" \ -d "payment_method_options[acss_debit][currency]=cad" \ -d "payment_method_options[acss_debit][mandate_options][payment_schedule]=interval" \ --data-urlencode "payment_method_options[acss_debit][mandate_options][interval_description]=On November 25, 2021" \ -d "payment_method_options[acss_debit][mandate_options][transaction_type]=personal" \ -d "payment_method_options[acss_debit][verification_method]=microdeposits" \ --data-urlencode "success_url=https://example.com/success" ``` # API directe > This is a API directe for when payment-ui is direct-api. View the full page at https://docs.stripe.com/payments/acss-debit/set-up-payment?payment-ui=direct-api. Vous pouvez utiliser l’[API Setup Intents](https://docs.stripe.com/payments/setup-intents.md) pour collecter à l’avance les données d’un moyen de paiement, en vue d’un paiement dont la date et le montant seront déterminés ultérieurement. Cette possibilité est utile pour : - Enregistrer des moyens de paiement dans un portefeuille pour faciliter les futurs achats - Encaisser des suppléments de facturation après la prestation d’un service - Mettre en place une période d’essai gratuite pour un *abonnement* (A Subscription represents the product details associated with the plan that your customer subscribes to. Allows you to charge the customer on a recurring basis) La plupart des comptes bancaires au Canada sont libellés en dollars canadiens (CAD), avec un petit nombre de comptes dans d’autres devises, notamment en dollars américains (USD). Il est possible d’accepter des paiements PAD en CAD ou en USD, mais il est important de choisir la devise adaptée à votre client afin d’éviter les échecs de paiement. Contrairement à de nombreux moyens de paiement par carte, vous pourriez ne pas être en mesure de prélever un montant en CAD d’un compte tenu en USD, ou inversement. La plupart du temps, ces tentatives de prélèvement engendre un échec de paiement différé dont la notification peut prendre jusqu’à cinq jours ouvrables. Pour éviter ces échecs, il est plus sûr de configurer les comptes bancaires PAD en CAD, sauf si vous êtes certain que le compte de votre client accepte les prélèvements en USD. ## Configurer Stripe [Côté serveur] Pour commencer, il vous faut un compte Stripe. [S’inscrire](https://dashboard.stripe.com/register). Utilisez nos bibliothèques officielles pour accéder à l’API Stripe depuis votre application : #### Ruby ```bash # Available as a gem sudo gem install stripe ``` ```ruby # If you use bundler, you can add this line to your Gemfile gem 'stripe' ``` ## Créer ou récupérer un objet Customer [Côté serveur] Pour réutiliser un compte bancaire à l’occasion de paiements ultérieurs, le compte en question doit être associé à un objet *Customer* (Customer objects represent customers of your business. They let you reuse payment methods and give you the ability to track multiple payments). Vous devez créer un objet Customer lorsque votre client crée un compte auprès de votre entreprise. En associant l’ID de l’objet Customer à votre propre représentation interne d’un client, vous pourrez récupérer et utiliser ultérieurement les informations du moyen de paiement sauvegardées. Si votre client n’a pas encore créé de compte, vous pouvez toujours créer un objet Customer dès maintenant et l’associer ultérieurement à votre représentation interne du compte de ce client. Créez ou récupérez un objet Customer client afin de l’associer à ces informations de paiement. Ajoutez le code suivant à votre serveur pour créer un objet Customer. ```curl curl -X POST https://api.stripe.com/v1/customers \ -u "<>:" ``` ## Créer un SetupIntent [Côté serveur] Un [SetupIntent](https://docs.stripe.com/api/setup_intents.md) est un objet qui représente votre intention de configurer le moyen de paiement d’un client en vue de futurs paiements. Le `SetupIntent` suit les étapes de ce processus de configuration. Pour recourir aux prélèvements pré-autorisés canadiens, vous devez obtenir l’autorisation de vos clients pour les paiements ponctuels et récurrents à l’aide d’un mandat de prélèvement automatique (consultez la section [Mandats de prélèvement automatique](https://docs.stripe.com/payments/acss-debit.md#mandates)). L’objet [Mandate](https://docs.stripe.com/api/mandates.md) enregistre le mandat et l’autorisation. Créez un SetupIntent sur votre serveur en définissant [payment_method_types](https://docs.stripe.com/api/setup_intents/create.md#create_setup_intent-payment_method_types) sur `acss_debit` et indiquez l’[id](https://docs.stripe.com/api/customers/object.md#customer_object-id) du client. Pour définir une fréquence de paiement sur l’objet [Mandate](https://docs.stripe.com/api/mandates.md) pour ce SetupIntent, incluez également les paramètres suivants : | Paramètre | Valeur | Obligatoire | | --------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ | | `payment_method_options[acss_debit][currency]` | Devise à utiliser pour les futurs paiements effectués avec ce moyen de paiement. Elle doit correspondre à la devise du compte bancaire du client. Les valeurs acceptées sont `cad` ou `usd`. | Oui | | `payment_method_options[acss_debit][mandate_options][payment_schedule]` | La fréquence des paiements définie dans le mandat. Les valeurs acceptées sont `interval`, `sporadic` ou `combined`. Consultez la section [Mandats de prélèvement automatique](https://docs.stripe.com/payments/acss-debit.md#mandates) pour vous aider à sélectionner la fréquence la plus adaptée à votre entreprise. | Oui | | `payment_method_options[acss_debit][mandate_options][interval_description]` | Description textuelle de la période de fréquence des paiements. Consultez la section [Mandats de prélèvement automatique](https://docs.stripe.com/payments/acss-debit.md#mandates) pour vous aider à élaborer la description de période la plus adaptée à votre entreprise. | Si la valeur `payment_schedule` est définie sur `interval` ou `combined` | | `payment_method_options[acss_debit][mandate_options][transaction_type]` | Le type de transactions pour lesquelles vous utiliserez le mandat, qu’elles soient `personal` (si les transactions se font pour des raisons personnelles) ou `business` (si les transactions se font pour des raisons professionnelles). | Oui | | `payment_method_options[acss_debit][mandate_options][default_for]` | Un tableau des finalités du mandat. Pour en savoir plus, consultez la présentation des [mandats PAD](https://docs.stripe.com/payments/acss-debit.md#mandates) afin de choisir la finalité par défaut adaptée à votre entreprise. | Non | ```curl curl https://api.stripe.com/v1/setup_intents \ -u "<>:" \ -d "payment_method_types[]=acss_debit" \ -d customer={{CUSTOMER_ID}} \ -d "payment_method_options[acss_debit][currency]=cad" \ -d "payment_method_options[acss_debit][mandate_options][payment_schedule]=interval" \ -d "payment_method_options[acss_debit][mandate_options][interval_description]=First day of every month" \ -d "payment_method_options[acss_debit][mandate_options][transaction_type]=personal" ``` ### Récupérer la clé secrète du client Le SetupIntent contient une *clé secrète* (The client secret is a unique key returned from Stripe as part of a PaymentIntent. This key lets the client access important fields from the PaymentIntent (status, amount, currency) while hiding sensitive ones (metadata, customer)) à utiliser côté client pour finaliser le processus de paiement en toute sécurité. Vous pouvez adopter différentes approches pour transmettre cette clé secrète côté client. #### Application monopage Récupérez la clé secrète du client à partir d’un endpoint sur votre serveur, à l’aide de la fonction `fetch` du navigateur. Cette approche est recommandée si votre côté client est une application d’une seule page, en particulier si elle repose sur un framework front-end moderne tel que React. Créez l’endpoint de serveur qui gère la clé secrète du client : #### Ruby ```ruby get '/secret' do intent = # ... Create or retrieve the SetupIntent {client_secret: intent.client_secret}.to_json end ``` Récupérez ensuite la clé secrète du client à l’aide JavaScript côté client : ```javascript (async () => { const response = await fetch('/secret'); const {client_secret: clientSecret} = await response.json(); // Render the form using the clientSecret })(); ``` #### Rendu côté serveur Transmettez la clé secrète à votre client depuis votre serveur. Cette approche fonctionne mieux si votre application génère du contenu statique sur le serveur avant de l’envoyer sur le navigateur. Ajoutez le [client_secret](https://docs.stripe.com/api/setup_intents/object.md#setup_intent_object-client_secret) à votre formulaire de paiement. Dans votre code côté serveur, récupérez la clé secrète du client à partir du SetupIntent : #### Ruby ```erb
``` ```ruby get '/checkout' do @intent = # ... Fetch or create the SetupIntent erb :checkout end ``` ## Collecter les informations du moyen de paiement et obtenir la confirmation du mandat [Côté client] Lorsqu’un client clique pour payer avec Canadian pre-authorized debit, nous vous recommandons d’utiliser Stripe.js pour soumettre le paiement à Stripe. [Stripe.js](https://docs.stripe.com/payments/elements.md) est notre bibliothèque JavaScript de base pour créer les tunnels de paiement : elle gère automatiquement les opérations complexes d’intégration et vous permettra de facilement étendre votre intégration à d’autres moyens de paiement par la suite. Intégrez le script Stripe.js à votre page de paiement en l’ajoutant entre les balises `head` de votre fichier HTML. ```html Checkout ``` Créez une instance de Stripe.js avec le code JavaScript suivant sur votre page de paiement. ```javascript // Set your publishable key. Remember to change this to your live publishable key in production! // See your keys here: https://dashboard.stripe.com/apikeys const stripe = Stripe('<>'); ``` Plutôt que d’envoyer la totalité de l’objet PaymentIntent au client, utilisez sa *clé secrète* (The client secret is a unique key returned from Stripe as part of a PaymentIntent. This key lets the client access important fields from the PaymentIntent (status, amount, currency) while hiding sensitive ones (metadata, customer)) provenant de l’étape précédente. Il ne s’agit pas de vos clés API qui authentifient les requêtes de l’API de Stripe. Le clé secrète du client doit néanmoins être manipulée avec précaution, car elle peut permettre de finaliser le paiement. Ne l’enregistrez pas dans les logs, ne l’intégrez pas dans des URL et ne l’exposez à personne d’autre que le client. Utilisez [stripe.confirmAcssDebitSetup](https://docs.stripe.com/js/setup_intents/confirm_acss_debit_setup) pour collecter les informations du compte bancaire et effectuer la vérification, confirmer le mandat et lancer la configuration lorsque l’utilisateur envoie le formulaire. Il est nécessaire d’inclure l’adresse électronique et le nom du client dans la propriété `billing_details` du paramètre `payment_method` pour créer un moyen de paiement pour le prélèvement préautorisé. ```javascript const form = document.getElementById('payment-form'); const accountholderName = document.getElementById('accountholder-name'); const email = document.getElementById('email'); const submitButton = document.getElementById('submit-button'); const clientSecret = submitButton.dataset.secret; form.addEventListener('submit', async (event) => { event.preventDefault(); const {setupIntent, error} = await stripe.confirmAcssDebitSetup( clientSecret, { payment_method: { billing_details: { name: accountholderName.value, email: email.value, }, }, } ); if (error) { // Inform the customer that there was an error. console.log(error.message); } else { // Handle next step based on SetupIntent's status. console.log("SetupIntent ID: " + setupIntent.id); console.log("SetupIntent status: " + setupIntent.status); } }); ``` Stripe.js charge ensuite une interface utilisateur du modal sur la page qui gère la collecte et la vérification des informations du compte bancaire, présente un accord de mandat hébergé et collecte l’autorisation. > `stripe.confirmAcssDebitSetup` peut prendre plusieurs secondes. Pendant ce temps, bloquez le renvoi de votre formulaire et affichez un indicateur d’attente. Si vous recevez une erreur, montrez-la au client, réactivez le formulaire et masquez l’indicateur d’attente. S’il réussit, Stripe renvoie un objet [SetupIntent](https://docs.stripe.com/api/setup_intents/object.md) avec l’un des possibles états suivants : | État | Description | Prochaine étape | | ----------------- | ------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `succeeded` | Le compte bancaire a été vérifié instantanément ou la vérification n’était pas nécessaire. | Aucune action requise | | `requires_action` | Aucune action n’est requise pour effectuer la vérification du compte bancaire. | Étape 5 : [Vérifier le compte bancaire à l’aide de micro-versements](https://docs.stripe.com/payments/acss-debit/set-up-payment.md#web-verify-with-microdeposits) | Une fois le SetupIntent confirmé, une confirmation de mandat et les informations du compte bancaire collectées doivent être envoyées par e-mail à votre client. Stripe gère cette étape par défaut, mais vous pouvez choisir, si vous préférez, d’[envoyer des notifications personnalisées](https://docs.stripe.com/payments/acss-debit.md#mandate-and-debit-notification-emails). > Les e-mails de confirmation de mandat ne sont pas envoyés à l’adresse e-mail du client lors des tests de l’intégration. Si le client choisit de fermer la boîte de dialogue modale sans terminer le flux de vérification, Stripe.js renvoie l’erreur suivante : ```json { "error": { "type": "validation_error", "code": "incomplete_payment_details", "message": "Please provide complete payment details." } } ``` ## Vérifier le compte bancaire à l'aide de micro-versements [Côté client] Tous les clients ne peuvent pas vérifier instantanément le compte bancaire. Cette étape ne s’applique que si votre client a choisi de se désinscrire du flux de vérification instantanée dans l’étape précédente. Dans ce cas, Stripe envoie automatiquement deux microversements sur le compte bancaire du client. Ces versements sont effectués sous un à deux jours ouvrables avant d’apparaître sur le relevé en ligne du client et sont accompagnés de libellés de relevé bancaire contenant `ACCTVERIFY`. Le résultat de l’appel du moyen de paiement `stripe.confirmAcssDebitSetup` est un SetupIntent avec l’état `requires_action`. Le SetupIntent contient un champ `next_action` qui contient des informations utiles pour effectuer la vérification. Stripe informe votre client de la date à laquelle les versements devraient arriver en envoyant un message à [l’adresse e-mail de facturation](https://docs.stripe.com/api/payment_methods/object.md#payment_method_object-billing_details-email). L’e-mail inclut un lien vers la page de vérification hébergée par Stripe où il peut confirmer les montants des versements et effectuer la vérification. Le nombre de tentatives de vérification infructueuses est limité à trois. Si cette limite est dépassée, le compte bancaire ne peut plus être vérifié. Par ailleurs, les vérifications par micro-dépôts expirent au bout de 10 jours. Si les micro-dépôts ne sont pas vérifiés dans ce délai, le PaymentIntent revient à l’état exigeant de nouvelles informations de moyen de paiement. Des messages clairs expliquant ce que sont ces micro-dépôts et comment vous les utilisez peuvent aider vos clients à éviter les problèmes de vérification. ### Facultatif : un e-mail et une page de vérification personnalisés Si vous avez préalablement choisi d’envoyer des [notifications personnalisées par e-mail](https://docs.stripe.com/payments/acss-debit.md#mandate-and-debit-notification-emails), vous devez à la place envoyer un e-mail à votre client. Pour ce faire, vous pouvez utiliser l’URL `verify_with_microdeposits[hosted_verification_url]` dans l’objet `next_action` pour que votre client puisse effectuer le processus de vérification. Si vous envoyez des e-mails personnalisés et ne souhaitez pas utiliser la page de vérification hébergée par Stripe, vous pouvez créer un formulaire sur votre site afin que vos clients vous communiquent ces montants et vérifier le compte bancaire à l’aide de [Stripe.js](https://docs.stripe.com/js/payment_intents/verify_microdeposits_for_payment). ```javascript stripe.verifyMicrodepositsForSetup(clientSecret, { amounts: [32, 45], }); ``` Lorsque le compte bancaire est vérifié, Stripe renvoie l’[objet SetupIntent](https://docs.stripe.com/api/setup_intents/object.md) avec un `status` `succeeded` et envoie un événement webhook `setup_intent.succeeded`. La vérification peut échouer pour plusieurs raisons. L’échec peut survenir de manière synchrone sous la forme d’une réponse d’erreur directe, ou de manière asynchrone via un événement webhook `setup_intent.payment_failed` (présenté dans les exemples suivants). #### Erreur synchrone ```json { "error": { "code": "payment_method_microdeposit_verification_amounts_mismatch", "message": "The amounts provided do not match the amounts that were sent to the bank account. You have {attempts_remaining} verification attempts remaining.", "type": "invalid_request_error" } } ``` #### Événement webhook ```javascript { "object": { "id": "seti_1234", "object": "setup_intent", "customer": "cus_0246", ... "last_setup_error": { "code": "payment_method_microdeposit_verification_attempts_exceeded", "message": "You have exceeded the number of allowed verification attempts." }, ... "status": "requires_payment_method" } } ``` | Code d’erreur | Synchrone ou asynchrone | Message | Changement d’état | | ------------------------------------------------------------ | --------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | | `payment_method_microdeposit_failed` | De façon synchrone ou asynchrone à travers un événement webhook | Les micro-versements ont échoué. Veuillez vérifier la validité des numéros de compte, de l’établissement et de transit fournis. | `status` est défini sur `requires_payment_method` et `last_setup_error` est défini. | | `payment_method_microdeposit_verification_amounts_mismatch` | De façon synchrone | Les montants fournis ne correspondent pas à ceux envoyés au compte bancaire. Il vous reste {attempts_remaining} tentative(s) de vérification. | Inchangé | | `payment_method_microdeposit_verification_attempts_exceeded` | De façon synchrone et asynchrone à travers un événement webhook | Dépassement du nombre de tentatives de vérification autorisé | `status` est défini sur `requires_payment_method` et `last_setup_error` est défini. | | `payment_method_microdeposit_verification_timeout` | De façon asynchrone à travers un événement webhook | Expiration du microversement. Le client n’a pas vérifié son compte bancaire dans le délai de 10 jours prévu. | `status` est défini sur `requires_payment_method` et `last_setup_error` est défini. | ## Tester votre intégration ### Tokens de moyens de paiement de test Utilisez des tokens de moyens de paiement de test pour tester votre intégration sans avoir à saisir manuellement les informations du compte bancaire. Ces tokens contournent les étapes de collecte et de vérification du compte bancaire. | Token | Scénario | | --------------------------------- | --------------------------------------------------------------------- | | `pm_acssDebit_success` | Le paiement est effectué immédiatement après l’acceptation du mandat. | | `pm_acssDebit_noAccount` | Le paiement échoue car aucun compte n’est trouvé. | | `pm_acssDebit_accountClosed` | Le paiement échoue parce que le compte est clôturé. | | `pm_acssDebit_insufficientFunds` | Le paiement échoue en raison de fonds insuffisants. | | `pm_acssDebit_debitNotAuthorized` | Le paiement échoue parce que les débits ne sont pas autorisés. | | `pm_acssDebit_dispute` | Le paiement est effectué mais déclenche un litige | ### Numéros de comptes de test Stripe fournit plusieurs numéros de compte test que vous pouvez utiliser pour vous assurer que votre intégration pour les comptes bancaires saisis manuellement sont prêts pour le mode production. Tous les comptes test avec un paiement qui réussit ou échoue automatiquement doivent être vérifiés à l’aide des montants de microversement test ci-dessous avant de pouvoir être effectués. | Numéro d’établissement | Numéro de transit | Numéro de compte | Scénario | | ---------------------- | ----------------- | ---------------- | ---------------------------------------------------------------------------------------------------------------------------------- | | `000` | `11000` | `000123456789` | Réussite immédiate du paiement après la vérification des microversements. | | `000` | `11000` | `900123456789` | Réussite du paiement avec un délai de trois minutes après la vérification des microversements. | | `000` | `11000` | `000222222227` | Échec immédiat du paiement après la vérification des microversements. | | `000` | `11000` | `900222222227` | Échec du paiement avec un délai de trois minutes après la vérification des microversements. | | `000` | `11000` | `000666666661` | Échec d’envoi des microversements de vérification. | | `000` | `11000` | `000777777771` | Échec du paiement, car le montant du paiement a entraîné le dépassement de la limite de volume de paiement hebdomadaire du compte. | | `000` | `11000` | `000888888881` | Échec du paiement, car son montant dépasse la limite du volume de transactions du compte. | Pour simuler les réussites ou les échecs de la vérification des comptes bancaires dans un environnement de test, utilisez ces montants représentatifs pour les microversements : | Valeurs des micro-versements | Scénario | | ----------------------------------- | ----------------------------------------------------------------------- | | `32` et `45` | Vérification du compte réussie. | | `10` et `11` | Simule le dépassement du nombre de tentatives de vérification autorisé. | | Toute autre combinaison de montants | Échec de la vérification du compte. | ## Optional: Accepter des paiements futurs [Côté serveur] Une fois le SetupIntent créé, vous disposez des nouveaux objets *PaymentMethod* (PaymentMethods represent your customer's payment instruments, used with the Payment Intents or Setup Intents APIs) et [Mandate](https://docs.stripe.com/api/mandates.md). Vous pouvez utiliser ces objets pour initier des paiements futurs sans devoir demander une deuxième fois au client son compte bancaire. > Les futurs paiements par prélèvement automatique doivent être débités conformément aux conditions mentionnées dans le mandat existant. Tout prélèvement réalisé à une date quelconque en violation des conditions du mandat pourrait donner lieu à une contester de paiement. Au moment de débiter votre client hors session, utilisez les ID des objets Customer, PaymentMethod et Mandate pour créer un PaymentIntent. Si vous n’avez pas encore capturer l’ID du SetupIntent, vous pouvez rechercher les objets PaymentMethod et Mandate pour la débiter en [dressant](https://docs.stripe.com/api/setup_intents/list.md) la liste des SetupIntents associés à votre client : ```curl curl -G https://api.stripe.com/v1/setup_intents \ -u "<>:" \ -d "customer={{CUSTOMER_ID}}" ``` ### Réutilisation d’un moyen de paiement avec un mandat de autoriser existant Après avoir obtenu les ID de PaymentMethod et de Mandate à partir du SetupIntent approprié, créez un PaymentIntent indiquant le montant et la devise du paiement. Définissez quelques autres paramètres afin d’effectuer le *paiement hors session* (A payment is described as off-session if it occurs without the direct involvement of the customer, using previously-collected payment information) : - Définissez la propriété [confirm](https://docs.stripe.com/api/payment_intents/create.md#create_payment_intent-confirm) du PaymentIntent sur la valeur `true`, ce qui aura pour effet de générer immédiatement une confirmation lors de la création du PaymentIntent. - Renseignez l’ID de l’objet PaymentMethod dans [payment_method](https://docs.stripe.com/api/payment_intents/create.md#create_payment_intent-payment_method), l’ID de l’objet Mandate dans [mandate](https://docs.stripe.com/api/payment_intents/create.md#create_payment_intent-mandate) et l’ID de l’objet Customer dans [customer](https://docs.stripe.com/api/payment_intents/create.md#create_payment_intent-customer). ```curl curl https://api.stripe.com/v1/payment_intents \ -u "<>:" \ -d "payment_method_types[]=acss_debit" \ -d "payment_method={{PAYMENTMETHOD_ID}}" \ -d "customer={{CUSTOMER_ID}}" \ -d "mandate={{MANDATE_ID}}" \ -d confirm=true \ -d amount=100 \ -d currency=cad ``` Un e-mail de notification de prélèvement doit être envoyé lorsque vous réutilisez un mandat existant avec le nouveau PaymentIntent. Par défaut, Stripe s’en occupe à votre place, sauf si vous choisissez d’[envoyer des notifications personnalisées](https://docs.stripe.com/payments/acss-debit.md#mandate-and-debit-notification-emails). ### Réutiliser un moyen de paiement avec un nouveau mandat Si vous devez prélever un client selon des conditions différents, mais ne souhaitez pas lui demander de saisir une nouvelle fois ses coordonnées bancaires, vous pouvez réutiliser l’objet PaymentMethod existant et demander un nouveau mandat à votre client. Pour cela, suivez les instructions pour [créer un PaymentIntent](https://docs.stripe.com/payments/acss-debit/accept-a-payment.md#web-create-payment-intent) ou [créer un SetupIntent](https://docs.stripe.com/payments/acss-debit/set-up-payment.md#web-create-setup-intent), avec les modifications suivantes : - Ajoutez le paramètre supplémentaire `payment_method` avec comme valeur l’ID de l’objet PaymentMethod existant lors de la création du PaymentIntent ou SetupIntent. - N’ajoutez pas les données `payment_method` et `acss_debit` dans les informations du moyen de paiement lors des appels `stripe.confirmAcssDebitPayment` ou `stripe.confirmAcssDebitSetup`. > Aucune vérification n’est requise pour les PaymentIntents et SetupIntents créés avec un objet PaymentMethod réutilisé et un nouvel objet Mandate, mais vous devez envoyer un nouvel e-mail de confirmation du mandat. Les paiements seront alors différés de trois jours. ## Optional: Vérification instantanée uniquement [Côté serveur] Par défaut, les paiements par prélèvement préautorisé canadien permettent à vos clients d’utiliser soit la vérification instantanée du compte bancaire, soit les microdépôts. Vous pouvez exiger uniquement la vérification instantanée en utilisant le paramètre [verification_method](https://docs.stripe.com/api/payment_intents/create.md#create_payment_intent-payment_method_options-acss_debit-verification_method) lors de la création du PaymentIntent. ```curl curl https://api.stripe.com/v1/setup_intents \ -u "<>:" \ -d "payment_method_types[]=acss_debit" \ -d customer={{CUSTOMER_ID}} \ -d "payment_method_options[acss_debit][currency]=cad" \ -d "payment_method_options[acss_debit][mandate_options][payment_schedule]=interval" \ -d "payment_method_options[acss_debit][mandate_options][interval_description]=First day of every month" \ -d "payment_method_options[acss_debit][mandate_options][transaction_type]=personal" \ -d "payment_method_options[acss_debit][verification_method]=instant" ``` ## Optional: Vérification par microversements uniquement [Côté serveur] Par défaut, les paiements par prélèvement préautorisé canadien permettent à vos clients d’utiliser soit la vérification instantanée du compte bancaire, soit les microdépôts. Vous pouvez exiger uniquement la vérification par microdépôts en utilisant le paramètre [verification_method](https://docs.stripe.com/api/payment_intents/create.md#create_payment_intent-payment_method_options-acss_debit-verification_method) lors de la création du PaymentIntent. ```curl curl https://api.stripe.com/v1/setup_intents \ -u "<>:" \ -d "payment_method_types[]=acss_debit" \ -d customer={{CUSTOMER_ID}} \ -d "payment_method_options[acss_debit][currency]=cad" \ -d "payment_method_options[acss_debit][mandate_options][payment_schedule]=interval" \ -d "payment_method_options[acss_debit][mandate_options][interval_description]=First day of every month" \ -d "payment_method_options[acss_debit][mandate_options][transaction_type]=personal" \ -d "payment_method_options[acss_debit][verification_method]=microdeposits" ``` ## See also - [Accepter un paiement par prélèvement automatique canadien](https://docs.stripe.com/payments/acss-debit/accept-a-payment.md)