The default CSV format for importing Payers to PayGate used is a standard comma separated format.
It is important to remember that iIn PayGate, a Payer record and associated payment plan are intrinsically linked. When you import or export a collection of Payers you also import or export their payment plan as part of the data set.
Optional fields can be left blank where they are not required.
Please note that the maximum size of a single Payer import file is 5000 lines – this includes any headers and blank lines.
Column Name |
Format |
Optional / Mandatory |
Explanation |
Example |
Sortcode |
6n |
M |
The Payer's sort code. PayGate will automatically remove hyphens and colons from imported sort codes PayGate will automatically append leading zeros to any imported sort codes with a length less than 6 digits. |
123456 |
Account Number |
8n |
M |
Payer’s bank account number PayGate will automatically append leading zeros to any imported account number with a length less than 8 digits. PayGate will automatically trim any leading or trailing white spaces from the imported account number. |
12345678 |
Account Holders Name |
30a |
M |
Name of the account holder of the Payer’s bank account |
|
Status |
1n |
M |
The status of the payer record. 0 - Operational 1 - Suspended 2 - Alert 3 - Closed |
0 |
Reserved for future use |
2n |
O |
||
Title |
1n |
M |
Payer's title 0 – Mr 1 - Mrs 2 - Miss 3 - Ms 4 - Mx 5 - Dr 6 - Other |
1 : |
Firstname |
30a |
M |
Payer's First Name |
|
Surname |
30a |
M |
Payer's Surname |
|
Reference |
18a |
M |
The Payers unique reference A minimum of 6 and a maximum of 18 alphanumeric characters. Use of a hyphen (-) is permitted, all other non-alphanumeric characters will be removed. |
|
Address1 |
30a |
M |
Line 1 of the payer's address |
|
Address2 |
30a |
O |
Line 2 of the payer's address |
|
Address3 |
30a |
O |
Line 3 of the payer's address |
|
Address4 |
30a |
O |
Line 4 of the payer's address |
|
Postcode |
30a |
M |
Payer's postcode |
|
254a |
O |
Payer's email address |
||
Tel1 |
30n |
O |
Payer first telephone number |
|
Reserved |
30n |
O |
Reserved for future use |
|
Mobile |
30n |
O |
Payer mobile telephone number |
|
Reserved |
10a |
O |
||
Custom Field1 |
64a |
O |
User Defined field |
|
Custom Field2 |
64a |
O |
User Defined field |
|
Custom Field3 |
64a |
O |
User Defined field |
|
Custom Field4 |
64a |
O |
User Defined field |
|
Custom Field5 |
64a |
O |
User Defined field |
|
First Amount |
18,2 |
O |
The first debit amount if different from the regular amount. |
123.45 |
Last Amount |
18,2 |
O |
The last debit amount if different from the regular amount. The “Recurrence End Type” must be set to either ‘UntilDate’ or ‘UntilNumberOfPayments’ in order to specify a value for this amount. |
23.51. |
Regular Amount |
18,2 |
M |
The regular debit amount |
3.14 |
Gift Aid |
10a |
M |
Sets the “Gift Aid” flag on the Payer record |
TRUE or FALSE |
First Payment Date |
10a |
M |
Specifies the date on which the first collection will be made, must be input in a dd/mm/yyyy format |
21/04/2015 |
Ordinal |
3n |
M |
Specifies the day within the defined schedule that the collection will be made. Value will be applied relative to the chosen ‘Recurrence Type’ and ‘Frequency’ for the Payer |
For an annual schedule, the ordinal defines the day of the year on which the collection will be made. A value between 1 and 365 should be input. For a monthly schedule, the ordinal defines the day of the month on which the collection will be made. A value between 1 and 31 can be used, but it is recommended that a value of 27 or less is used to avoid potential issues with months of variable length. For a weekly schedule, the ordinal defines the day of the week on which the collection will be made. A value between 1 and 5 can be input, which specifies Monday-Friday respectively. |
Step |
2n |
O |
Works in conjunction with recurrence type to determine how often collections will be taken. Defaults to 1 if no other value is input. Step will not work with an annual plan, since the Direct Debit rules mean that no more than 13 months can elapse between collections before a mandate is closed automatically. |
e.g. depending on the specified collection recurrence type: 1 = a collection will be taken every month/week 2 = a collection will be taken every other month/week 3 = a collection will be taken every third month/week The chosen step and recurrence type will define the period of time that will elapse between regular collections. For example, a weekly schedule with a step of 4 and an ordinal of 2 will specify that regular collections will be taken on the first Tuesday that occurs 4 weeks after the first collection date, with subsequent collections taken every further 4 weeks on a Tuesday. You cannot specify a 4 week elapsed period, and set the collection date to be, say, on the 3rd Tuesday within that period. |
Recurrence Type |
30a |
M |
Frequency at which collections will be taken |
Weekly, Monthly, Yearly |
Recurrence End Type |
30a |
Defines the collection mandate type |
OneOff, UntilDate, UntilNumberOfPayments, Ongoing |
|
Until Date |
10a |
O |
If Recurrence End Type is ‘UntilDate’ then this holds the last acceptable payment date input in dd/mm/yyyy format |
31/10/2018 |
Total Payments |
3n |
O |
If Recurrence End Type is ‘UntilNumberOfPayments’ then this holds the number of payments |
24 |
Key
30a |
Up to 30 Alpha numeric characters |
11n |
Up to 11 digit number |
18,2 |
A decimal number with up to 18 numbers before the decimal point and 2 numbers after the decimal point (2 places of decimal) |
O |
Optional Field |
M |
Mandatory Field |