This document covers the setup of Direct Debit using the Paysafe payment gateway for Canadian clients.
Overview
In addition to allowing your supporters to donate using their credit or debit card, you can also allow them to set up regular payments directly from their bank account using direct debit.
Before you begin, we strongly recommend that you explicitly confirm the payment methods and currencies available to you with Paysafe.
As the currency will be fixed with the AccountID of your Paysafe gateway setup, it will not be necessary to include a currency form field on your donation pages. We only support recurring (regular) payments for Direct Debit, and you will still need to include the ‘Recurring payment’ field as a hidden field on the page, with a fixed value of ‘Y’.
Setting up the gateway
It is recommended that you create and keep two separate gateway records in your account, one to be used for testing and one linked to your live gateway. Donation pages should be linked to a test gateway initially, and then switched to a live gateway before launch. To create each one:
- Click on Hello YOURNAME , then select Account settings > Gateways in the pop-up menu.
- Click New Payment Gateway to create a new entry
- The fields are set up as follows:
|
Field |
Description |
|
Reference name |
A unique name for the gateway. It is a good idea for the name to include the type of gateway (eg. Paysafe), the currency, and whether it is a live or test gateway. |
|
Select gateway |
Select the Paysafe gateway |
|
Username |
Your Paysafe account user name. |
|
API key |
Paysafe will provide this, along with your Account ID. You will typically have one Account ID for each of the currency you have enabled in your Paysafe account. |
|
Account ID |
See above. |
|
Currency |
Select the appropriate currency for the gateway, subject to what you have agreed with Paysafe. Note that changing this field in Engaging Networks will only change how currency is reported in our platform. The actual currency of the donations is determined by the currency of your Paysafe account (Account ID). |
|
Test mode |
Should be checked for a test gateway, but must be unchecked for a gateway that will accept live donations. |
Form Fields
The following fields should be set up in the default supporter record with the appropriate field ‘tag’ and added to your donation form.
Standard fields – required for every Paysafe donation page
|
Form Field |
Mandatory/optional |
Value type |
Comments |
|
Email Address |
Mandatory |
Alphanumeric |
Supporter’s email address |
|
First Name |
Mandatory
|
Alpha |
The supporter’s first name. |
|
Last Name |
Mandatory |
Alpha |
The supporter’s last name.
|
|
Address 1 |
Mandatory
|
Alphanumeric |
The first line of the supporter’s address |
|
City |
Mandatory
|
Alpha |
The address city of the supporter |
|
Region |
Mandatory
|
Alpha |
The address region of the supporter, you can provide a drop down list of counties or allow the donor to enter this themselves. |
|
Postcode |
Mandatory
|
Alphanumeric |
The donors postcode. |
|
Country |
Mandatory |
Alpha |
The country of the cardholder. This should be a 2 character code for the country. |
|
Donation Amount |
Mandatory
|
Numeric |
May be entered as a whole number, or with two decimal places. Eg. Twelve pounds may be entered as ’12’ or ‘12.00’. You may want to consider using the ‘select with input’ or ‘radio with input’ field types ‚Äì see below. |
Fields required for Direct Debit
For Direct Debit payments you will also need to collect the following details:
|
Form Field |
Mandatory/optional |
Value type |
Comments |
|
Payment Type |
Mandatory |
Alpha |
EFT |
|
Bank Account Type |
Mandatory |
Alpha |
CHECKING or SAVINGS |
|
Credit Card Holder Name |
Mandatory |
Alpha |
The full name of the bank account holder. |
|
Bank Account Number |
Mandatory |
Alphanumeric |
The account number to be used for making the payment. |
|
Bank Routing Number |
Mandatory |
Alphanumeric |
Transit Number |
|
Bank Name |
Mandatory |
Numeric |
Institution number |
Additional Required Fields for Recurring Payments
If you want to accept recurring payments and have confirmed with Paysafe that you have this option enabled for your account, in addition to the credit card fields you will need to add the following:
|
Form Field |
Value |
Description |
|
Recurring Payment |
Alpha |
Submitting ‘Y’ will flag the transaction as a recurring payment. Any other value will result in a single payment. |
|
Recurring Frequency |
Alpha |
If ‘Recurring Payment’ is set to ‘Y’. Permitted values are MONTHLY, QUARTERLY, SEMI_ANNUAL and ANNUAL. Please see the notes below on ‘select’ field types for details of ways of presenting these fields to supporters. |
|
Recurring Day |
Numeric |
The day of the month on which the recurring payment should be taken, from 1-28. |
NOTE: We only support EFT for recurring payments, therefore EFT will not work on event pages.