Response

Property

Description

Format

Example

Sortcode

The payer's sortcode.

First 4 characters are masked out for security reasons.

6c

****12

AccountNumber

The payer's account number.

First 6 characters are masked out for security reasons.

8c

******34

AccountHoldersName

The full name of the payer as used by their bank

60c

Ms Jenny Smith

Status

The payer's current status

0 - Operational

1 - Suspended

2 - Alert

3 - Closed

Integer

1

PaymentPlan

See below

PayerMessageType

0 - Email

1 - Letter

Integer

M

Title

The new payer's title

0 Mr

1 Mrs

2 Miss

3 Ms

4 Mx

5 Dr

6 Other

Integer

M

Firstname

The payer's first name

30an

Jenny

Surname

The payer's last name.

30an

Smith

PayerReference

The payer's unique Direct Debit reference.  

JSMITH001

Address1

Line 1 of the payer's address.

30an

123 Fake Street

Address2

Line 2 of the payer's address.

30an

Newville

Address3

Line 3 of the payer's address.

30an

Newtown

Address4

Line 4 of the payer's address.

30an

Newshire

Postcode

Line 5 of the payer's address.

30an

NW1 2YU

Email

Postcode of the payer's address.

254an

jenny.smith@businessfactory.com

Tel1

The payer's primary telephone contact number

30an

01234 567 890

Tel2

The payer's secondary telephone contact number

30an

Mobile

The payer's mobile telephone

30an

CustomField1

64an

CustomField2

64an

CustomField3

64an

CustomField4

64an

CustomField5

64an

Property

Description

Format

Example

FirstAmount

If the first collection has a different amount than the remaining collection schedule then it is shown here.

Decimal

123.45

LastAmount

If the collection schedule has a finite number of collections and the last collection is to have a different amount than the preceding collections then it is shown here.

Decimal

1.23

RegularAmount

The amount of each direct debit collection.

Decimal

12.34

GiftAid

true is the payer's collections are being collection under the gift aid scheme.

String  

true or false

true

FirstPaymentDate

The date of the first collection of the plan.

10c

dd/mm/yyyy

21/10/2017

Ordinal

In a weekly schedule the ordinal is the weekday number that the collections will occur on:

1 Monday, 2 Tuesday, etc.

In a monthly schedule the ordinal is the month day that the collection will occur on:

2 is 2nd of the month, 15 is 15th of the month, etc

In an annual schedule the ordinal is the day of the year that the schedule will occur on.  Leap years are taken into account:

1 is the 1st of Jan,  237 is 25th August for a non-leap year.

In all cases weekends and banks holidays are taken into account.

Integer

18

Step

Determines how often a schedule is run.  For example in a monthly schedule with a step of 1, collections will occur every month.

If the step was changed to 3 then the collections would occur every 3 months.

Integer

14

RecurrenceType

0 Weekly

1 Monthly

2 Annual

Integer

1

RecurrenceEndType

0 One Off

1 Until date

2 Until number of payments

3 Ongoing

Integer

1

UntilDate

If the schedule's RecurrenceEndType is set to 1 (Until date) the date must be included here.  

10c

dd/mm/yyyy

21/10/2017

TotalPayments

If the schedule's RecurrenceEndType is set to 2 (Until number of payments) the number of collections is included here.  

Integer

12