Save details for future payments with pre-authorized debit in Canada
Save payment method details for future Canadian pre-authorized debit payments.
You can use the Setup Intents API to collect payment method details in advance, with the final amount or payment date determined later. This is useful for:
- Saving payment methods to a wallet to streamline future purchases
- Collecting surcharges after fulfilling a service
- Starting a free trial for a subscription
Note
Pre-authorized debit in Canada is a delayed notification payment method, which means that funds are not immediately available after payment. A payment typically takes 5 business days to arrive in your account.
Most bank accounts in Canada hold Canadian dollars (CAD), with a small number of accounts in other currencies, including US dollars (USD). It is possible to accept PAD payments in either CAD or USD, but choosing the correct currency for your customer is important to avoid payment failures.
Unlike many card-based payment methods, you might not be able to successfully debit a CAD account in USD or debit a USD account in CAD. Most often, attempting to do so results in a delayed payment failure that takes up to five business days.
To avoid these failures, it is safest to set up PAD bank accounts in CAD unless you are confident your customer’s account accepts USD debits.
Set up StripeServer-side
First, you need a Stripe account. Register now.
Use our official libraries for access to the Stripe API from your application:
Create or retrieve a CustomerServer-side
To reuse a bank account for future payments, it must be attached to a Customer.
Create a Customer object when your customer creates an account with your business. Associating the ID of the Customer object with your own internal representation of a customer lets you retrieve and use the stored payment method details later. If your customer hasn’t created an account, you can still create a Customer object now and associate it with your internal representation of the customer’s account later.
Create a new Customer or retrieve an existing Customer to associate with these payment details. Include the following code on your server to create a new Customer.
Set up future payments
Note
This guide builds on the foundational set up future payments Checkout integration.
Use this guide to learn how to enable Canadian Pre-Authorized Debits (PADs)—it shows the differences between setting up future payments for cards and using PADs.
Enable Canadian pre-authorized debit as a payment method
When creating a new Checkout Session, you need to:
Pre-authorized debit in Canada
- Add
acss_
to the list ofdebit payment_
.method_ types - Specify additional payment_method_options parameters to describe your transaction. Learn more below.
Payments must specify a payment schedule for customers to authorize when checking out. See PAD Mandates for details on how to choose the right mandate options for your business:
Parameter | Value | Required |
---|---|---|
payment_ | Currency to use for future payments with this payment method. Must match the customer’s bank account currency. Accepted values are cad or usd . | Yes |
payment_ | The mandate payment schedule. Accepted values are interval , sporadic , or combined . See the PAD Mandates overview to help you select the right schedule for your business. | Yes |
payment_ | Text description of the payment schedule. See the PAD Mandates overview to help you construct the right interval description for your business. | Required if payment_ value is interval or combined |
payment_ | The type of the mandate you’re creating, either personal (if your customer is an individual) or business (if your customer is a business). | Yes |
Create a Checkout session
During the Checkout session, the customer is presented with a UI modal that handles bank account details collection and instant verification with an optional fallback to verification using microdeposits. If the customer opts for microdeposit verification, Stripe automatically sends two small deposits to the provided bank account which take 1-2 business days to appear on the customer’s online bank statement. When the deposits are expected to arrive, the customer receives an email with a link to confirm these amounts and verify the bank account with Stripe. After verification is completed, the payment method is ready to be used for future payments.
Test your integration
Receive micro-deposit verification email
In order to receive the micro-deposit verification email in test mode after collecting the bank account details and accepting a mandate, provide an email in the payment_
field in the form of {any_
when confirming the payment method details.
Test account numbers
Stripe provides several test account numbers you can use to make sure your integration for manually-entered bank accounts is ready for production. All test accounts that automatically succeed or fail the payment must be verified using the test micro-deposit amounts below before they can be completed.
Institution Number | Transit Number | Account Number | Scenario |
---|---|---|---|
000 | 11000 | 000123456789 | Succeeds the payment immediately after micro-deposits are verified. |
000 | 11000 | 900123456789 | Succeeds the payment with a three-minute delay after micro-deposits are verified. |
000 | 11000 | 000222222227 | Fails the payment immediately after micro-deposits are verified. |
000 | 11000 | 900222222227 | Fails the payment with a three-minute delay after micro-deposits are verified. |
000 | 11000 | 000666666661 | Fails to send verification micro-deposits. |
000 | 11000 | 000777777771 | Fails the payment due to the payment amount causing the account to exceed its weekly payment volume limit. |
000 | 11000 | 000888888881 | Fails the payment due to the payment amount exceeding the account’s transaction limit. |
To mimic successful or failed bank account verifications in test mode, use these meaningful amounts for micro-deposits:
Micro-deposit Values | Scenario |
---|---|
32 and 45 | Successfully verifies the account. |
Any other number combinations | Fails account verification. |
Use the payment methodServer-side
After completing the Checkout Session, you can collect the PaymentMethod ID and a Mandate ID. You can use these to initiate future payments without having to prompt the customer for their bank account a second time.
Warning
Future pre-authorized debit payments must be charged according to the terms of the existing mandate. Debiting at any time that doesn’t meet the terms of the mandate could be cause for a payment dispute.
When you’re ready to charge your customer off-session, provide the payment_
, customer
, and mandate
IDs when creating a PaymentIntent.