{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","settings":"","results":{"codes":[]},"params":[]},"next":{"description":"","pages":[]},"title":"Pre-Authorized Debit Payments","type":"basic","slug":"pre-authorized-direct-debit-payments","excerpt":"Learn how to process Pre-Authorized Debit payments with the BlueSnap APIs.\nFor more information on topics like subscriptions and refunds, visit our [support guides](https://support.bluesnap.com/docs/pre-authorized-debit-payments).","body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"This payment method is currently in Beta. Please reach out to [BlueSnap Merchant Support](https://bluesnap.zendesk.com/hc/en-us/requests/new?ticket_form_id=360000127087) to enable it.\"\n}\n[/block]\nPre-Authorized Debit Payments are an alternative to credit cards in Canada. Pre-Authorized Debit is a payment method where money is electronically withdrawn from the shopper’s bank account and then deposited into the merchant’s own bank account. This payment method is supported for payments from Canadian shoppers to merchants in CAD.\n\nBlueSnap's [Secured Payment Collector](https://developers.bluesnap.com/v8976-Tools/docs/secured-payment-collector) allows you to securely collect your shopper's sensitive banking details for Pre-Authorized Direct Debit payments. This feature has discrete input fields that give you complete control over the look and feel of your checkout form while giving customers the seamless experience of remaining on your website. Visit our [support guides](https://developers.bluesnap.com/v8976-Tools/docs/secured-payment-collector) for complete implementation details.\n\n## Supported Currencies\nCanadian Dollar (CAD)\n\n## Supported Shopper Countries\nCanada\n\n#Benefits\n* Boost your sales in Canada by reaching additional shoppers who do not use credit cards or other payment methods.\n* Eliminate the need for paper checks and instead enable customers to provide their payment info online.\n* Store shopper account information for easier repeat purchases.\n* Enjoy transaction costs that are typically lower than credit card transactions.\n* Reduce issues with failed payments due to failed or invalid cards, since bank accounts do not have an expiration date, and your shoppers rarely switch banks.\n* Solution for B2B transactions and other payments for high-cost items where a credit card limit could be exceeded.\n\n# Transaction Processing\nThese are the main steps involved in processing Pre-Authorized Debit payments:\n\n1. On the checkout page, your shopper selects Pre-Authorized Debit and enters their routing number, account number, and personal details.\n2. Once they have entered their info, the shopper accepts the mandate authorizing their account to be debited and submits the payment.\n3. When your shopper submits the transaction, BlueSnap verifies that the routing number corresponds to a financial institution and that the bank account number is valid.\n<ul>\n<li>If both are valid, BlueSnap creates an invoice in pending status and sends the transaction for processing.</li>\n<li>If the BSB number is not valid, BlueSnap returns an error message and the transaction is not sent for processing.</li>\n</ul>\n4. Within 3 business days, the bank will notify BlueSnap if the payment was declined. \n<ul>\n<li>If the payment was declined, BlueSnap will update the status of the invoice to be canceled and a Decline IPN will be sent.</li>    \n<li>If BlueSnap does not receive the notification within this timeframe, the invoice status will be set to <b>approved</b>.</li>\n</ul>\n5. If the bank sends a declined status after 3 business days, the invoice status will be set to **refunded**.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"* We have validation criteria in place and will return an error if an invalid account number is entered.\\n* We recommend delivering the product only after you receive the approval.\\n* The shopper has 90 days to dispute the debit on their account. If this occurs, BlueSnap will remove the funds from your account and send a [Refund IPN](https://support.bluesnap.com/docs/ipns-name-reference#REFUND), and the invoice status will be updated to refunded. Please note that some banks might allow a longer timeframe for reversals.\\n* **Resolving payment rejections**: Payments can be rejected for a variety of reasons, including insufficient funds. To resolve a payment rejection, you can provide an alternative payment method and resubmit the charge.\",\n  \"title\": \"Notes\"\n}\n[/block]\n# API Integrations \nPre-Authorized Direct Debit transactions are supported in BlueSnap's Payment API. \n\nFor Payment API requests, see:\n* [Create Pre-Authorized Direct Debit Transaction ](https://developers.bluesnap.com/v8976-JSON/docs/create-pre-authorized-debit-transaction)\n* [Retrieve Pre-Authorized Direct Debit Transaction ](https://developers.bluesnap.com/v8976-JSON/docs/retrieve-pre-authorized-debit-transaction)\n\n## Requirements\n**1. Enable the Pre-Authorized Direct Debit payment method in your account.**\nFirst enable this payment method in your account. In the Merchant Portal, go to **Checkout Page** > **Payment Methods** and select **Show** in the menu next to the Pre-Authorized Direct Debit payment method. Click **Submit** to save your changes.\n\n**2. Obtain the shopper's permission to debit their account via a mandate called a Pre-Authorized Agreement.**\nFor certain Pre-Authorized Direct Debit transactions, you must obtain permission from the shopper to debit their account by having them authorize a mandate, also known as a Pre-Authorized Agreement.  \n\nMerchants must obtain this authorization in the following cases:\n* **Subscription payment**:  When the shopper makes a subscription payment and checks out using an existing debit account or adds a new one at checkout  \n* **One-time payment**: When the shopper makes a one-time payment and adds a new debit account at checkout.\n* **Editing their Returning Shopper account**:  When the shopper edits their Returning Shopper account and adds a debit account.\n\nYou do not need to obtain this authorization when the shopper makes a one-time payment and checks out using an existing debit account.\n\nOne approach is to display a mandatory checkbox next to a link that contains the following text:  \"I authorize the Pre-Authorized Debit Agreement and this transaction, agree to this debit of my account and understand that my account information will be securely stored.\" \n\nTo retrieve the mandate, call BlueSnap's [Get Debit Agreement](https://developers.bluesnap.com/v8976-JSON/docs/get-debit-agreement) API request. Keep in mind that you need to create the mandate before you can create a PAD transaction.\n\n**3. For merchant-managed subscriptions send a pre-notification message to the shopper prior to each debit.  **\n\nFind example text below.  Please replace all tags with the appropriate payment and merchant details.\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"* Please ensure that shoppers are logged in and verified using their credentials before they add or use the Pre-Authorized Direct Debit payment method. \\n* At this time the [dynamic statement descriptor](https://support.bluesnap.com/docs/statement-descriptor) is not supported for this payment method.  The soft descriptor provided in the portal will be displayed on the shopper's bank statement.\\n* The shopper’s routing number should be 9 digits in length:\\n  * If it is less than 9 digits, add leading 0s.\\n  * If it is longer than 9 digits, return an error to the shopper.\",\n  \"title\": \"Notes\"\n}\n[/block]\n\n# Hosted Pages  \nPre-Authorized Direct Debit transactions are supported in BlueSnap's Payment [Buy Now 3 Hosted Pages](https://support.bluesnap.com/docs/new-hosted-page).  \n\n## Requirements\n**1. Enable the Pre-Authorized Direct Debit payment method in your account.**\nFirst enable this payment method in your account. In the Merchant Portal, go to **Checkout Page** > **Payment Methods** and select **Show** in the menu next to the Pre-Authorized Direct Debit payment method. Click **Submit** to save your changes.\n\n**2. For merchant-managed subscriptions:**\n* Please ask the shopper to authorize the mandate. (find more info under Step 2 [here](https://developers.bluesnap.com/docs/pre-authorized-direct-debit-payments#section-requirements))\n* Send a pre-notification message to the shopper prior to each debit.  Find example text below. Please replace all tags with the appropriate payment and merchant details.\n\n###Pending charge notification in the case of Merchant Managed Subscriptions\n<div style=\"font-style:italic\">Dear Shopper, \n\nWe will be debiting you **<Insert Debit Amount>** on **<Insert date of debit e.g., 10/02/2022>** from your bank account ending in **<Insert Last 4 of the bank account number>**. \n\nIf you have any questions please contact us at: \n**<Insert Merchant name> **\n**<Insert Merchant address 1> <Insert Merchant address 2> **\n**<Insert Merchant city> <Insert Merchant province> <Insert Merchant postal code> **\n\nTel: **<Insert Merchant phone number> **\nEmail: **<Insert email>**\n\nThanks, \n**<Insert Merchant name>**\n</div>\n# Sandbox Testing\nYou may use the following bank credentials to test various scenarios.\n\nSimulate declined transaction*\nAccount number: `9990000004`\nRouting Number: `001004820` \n\nSimulate approved transaction*\nAccount number: `9990000001`\nRouting Number: `001004820`\n\n* After the initial transaction request, you will see the status change within an hour.","updates":[],"order":27,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"62e105e935f70f006387bea5","createdAt":"2022-07-27T09:31:21.370Z","user":"606df105d9ab93003f73cb10","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Guides","slug":"topics","order":7,"from_sync":false,"reference":true,"_id":"62db2350a08c5b01d83ecf2a","version":"62db2350a08c5b01d83ecf6f","project":"57336fd5a6a9c40e00e13a0b","createdAt":"2015-11-03T20:45:01.593Z","__v":0},"version":{"version":"8976-Basics","version_clean":"8976.0.0-Basics","codename":"3.43 Release","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["62db2350a08c5b01d83ecf25","62db2350a08c5b01d83ecf26","62db2350a08c5b01d83ecf27","6183ed028202aa001610248b","62db2350a08c5b01d83ecf28","62db2350a08c5b01d83ecf29","5beb278ac442ab0213f00990","62db2350a08c5b01d83ecf2a","5c3f542c12c4ac004bc51718","6183ed028202aa001610248f","5df806ccecebde0059f17225","5dfa8a8f340c2b007418eb8a","62db2350a08c5b01d83ecf2b","5e597199fd2b0200117c2c1c"],"_id":"62db2350a08c5b01d83ecf6f","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"622623052699060013831de5","createdAt":"2018-04-23T14:36:48.535Z","releaseDate":"2018-04-23T14:36:48.535Z"},"project":"57336fd5a6a9c40e00e13a0b","__v":0,"parentDoc":null,"pendingAlgoliaPublish":false}

Pre-Authorized Debit Payments

Learn how to process Pre-Authorized Debit payments with the BlueSnap APIs. For more information on topics like subscriptions and refunds, visit our [support guides](https://support.bluesnap.com/docs/pre-authorized-debit-payments).

This payment method is currently in Beta. Please reach out to BlueSnap Merchant Support to enable it.

Pre-Authorized Debit Payments are an alternative to credit cards in Canada. Pre-Authorized Debit is a payment method where money is electronically withdrawn from the shopper’s bank account and then deposited into the merchant’s own bank account. This payment method is supported for payments from Canadian shoppers to merchants in CAD.

BlueSnap's Secured Payment Collector allows you to securely collect your shopper's sensitive banking details for Pre-Authorized Direct Debit payments. This feature has discrete input fields that give you complete control over the look and feel of your checkout form while giving customers the seamless experience of remaining on your website. Visit our support guides for complete implementation details.

Supported Currencies

Canadian Dollar (CAD)

Supported Shopper Countries

Canada

Benefits

  • Boost your sales in Canada by reaching additional shoppers who do not use credit cards or other payment methods.
  • Eliminate the need for paper checks and instead enable customers to provide their payment info online.
  • Store shopper account information for easier repeat purchases.
  • Enjoy transaction costs that are typically lower than credit card transactions.
  • Reduce issues with failed payments due to failed or invalid cards, since bank accounts do not have an expiration date, and your shoppers rarely switch banks.
  • Solution for B2B transactions and other payments for high-cost items where a credit card limit could be exceeded.

Transaction Processing

These are the main steps involved in processing Pre-Authorized Debit payments:

  1. On the checkout page, your shopper selects Pre-Authorized Debit and enters their routing number, account number, and personal details.
  2. Once they have entered their info, the shopper accepts the mandate authorizing their account to be debited and submits the payment.
  3. When your shopper submits the transaction, BlueSnap verifies that the routing number corresponds to a financial institution and that the bank account number is valid.


    • If both are valid, BlueSnap creates an invoice in pending status and sends the transaction for processing.

    • If the BSB number is not valid, BlueSnap returns an error message and the transaction is not sent for processing.

  4. Within 3 business days, the bank will notify BlueSnap if the payment was declined.


    • If the payment was declined, BlueSnap will update the status of the invoice to be canceled and a Decline IPN will be sent.

    • If BlueSnap does not receive the notification within this timeframe, the invoice status will be set to approved.

  5. If the bank sends a declined status after 3 business days, the invoice status will be set to refunded.

Notes

  • We have validation criteria in place and will return an error if an invalid account number is entered.
  • We recommend delivering the product only after you receive the approval.
  • The shopper has 90 days to dispute the debit on their account. If this occurs, BlueSnap will remove the funds from your account and send a Refund IPN, and the invoice status will be updated to refunded. Please note that some banks might allow a longer timeframe for reversals.
  • Resolving payment rejections: Payments can be rejected for a variety of reasons, including insufficient funds. To resolve a payment rejection, you can provide an alternative payment method and resubmit the charge.

API Integrations

Pre-Authorized Direct Debit transactions are supported in BlueSnap's Payment API.

For Payment API requests, see:

Requirements

1. Enable the Pre-Authorized Direct Debit payment method in your account.
First enable this payment method in your account. In the Merchant Portal, go to Checkout Page > Payment Methods and select Show in the menu next to the Pre-Authorized Direct Debit payment method. Click Submit to save your changes.

2. Obtain the shopper's permission to debit their account via a mandate called a Pre-Authorized Agreement.
For certain Pre-Authorized Direct Debit transactions, you must obtain permission from the shopper to debit their account by having them authorize a mandate, also known as a Pre-Authorized Agreement.

Merchants must obtain this authorization in the following cases:

  • Subscription payment: When the shopper makes a subscription payment and checks out using an existing debit account or adds a new one at checkout
  • One-time payment: When the shopper makes a one-time payment and adds a new debit account at checkout.
  • Editing their Returning Shopper account: When the shopper edits their Returning Shopper account and adds a debit account.

You do not need to obtain this authorization when the shopper makes a one-time payment and checks out using an existing debit account.

One approach is to display a mandatory checkbox next to a link that contains the following text: "I authorize the Pre-Authorized Debit Agreement and this transaction, agree to this debit of my account and understand that my account information will be securely stored."

To retrieve the mandate, call BlueSnap's Get Debit Agreement API request. Keep in mind that you need to create the mandate before you can create a PAD transaction.

3. For merchant-managed subscriptions send a pre-notification message to the shopper prior to each debit.

Find example text below. Please replace all tags with the appropriate payment and merchant details.

Notes

  • Please ensure that shoppers are logged in and verified using their credentials before they add or use the Pre-Authorized Direct Debit payment method.
  • At this time the dynamic statement descriptor is not supported for this payment method. The soft descriptor provided in the portal will be displayed on the shopper's bank statement.
  • The shopper’s routing number should be 9 digits in length:
    • If it is less than 9 digits, add leading 0s.
    • If it is longer than 9 digits, return an error to the shopper.

Hosted Pages

Pre-Authorized Direct Debit transactions are supported in BlueSnap's Payment Buy Now 3 Hosted Pages.

Requirements

1. Enable the Pre-Authorized Direct Debit payment method in your account.
First enable this payment method in your account. In the Merchant Portal, go to Checkout Page > Payment Methods and select Show in the menu next to the Pre-Authorized Direct Debit payment method. Click Submit to save your changes.

2. For merchant-managed subscriptions:

  • Please ask the shopper to authorize the mandate. (find more info under Step 2 here)
  • Send a pre-notification message to the shopper prior to each debit. Find example text below. Please replace all tags with the appropriate payment and merchant details.

Pending charge notification in the case of Merchant Managed Subscriptions

Dear Shopper,

We will be debiting you <Insert Debit Amount> on <Insert date of debit e.g., 10/02/2022> from your bank account ending in <Insert Last 4 of the bank account number>.

If you have any questions please contact us at:
<Insert Merchant name>
<Insert Merchant address 1> <Insert Merchant address 2>
<Insert Merchant city> <Insert Merchant province> <Insert Merchant postal code>

Tel: <Insert Merchant phone number>
Email: <Insert email>

Thanks,
<Insert Merchant name>

Sandbox Testing

You may use the following bank credentials to test various scenarios.

Simulate declined transaction*
Account number: 9990000004
Routing Number: 001004820

Simulate approved transaction*
Account number: 9990000001
Routing Number: 001004820

  • After the initial transaction request, you will see the status change within an hour.