Request

POST

  /api/Payer/CreatePayer

Creates a new DDMS Payer in a PayGate DDMS Group

Property

Description

Format

Mandatory / Optional

Username

The username of the PayGate account that the API is running under

M

Password

The password of the PayGate account that the API is running under

M

ApiKey

The API key for the PayGate DDMS group that the payer will be added to

256an

M

Title

The new payer's title

0 Mr

1 Mrs

2 Miss

3 Ms

4 Mx

5 Dr

6 Other

n

M

Firstname

The new payer's First Name

30an

M

Surname

The new payer's Surname

30an

M

PayerReference

The new Payers Unique Direct Debit Reference.  

10an

Minimum of 6 alphanumerical capitalised characters

Maximum of 10 characters in length,

Can only contain BACS approved chars

M

Tel1

The payer's primary telephone contact number

O

Tel2

The payer's secondary telephone contact number

O

Mobile

The payer's mobile telephone contact number

O

Address1

The first line of the payer's home address

M

Address2

O

Address3

O

Address4

O

Postcode

The postcode of the payer's home address

M

Email

The payer's email address

C

AccountHoldersName

The name of the payer as used by the bank.

Usually  [title] [firstname] [lastname]

E.g. Ms Sally Smith

M

Sortcode

The sortcode of the payer UK domestic bank account

6n

M

AccountNumber

The account number of the payer's UK domestic bank account

8n

M

CustomField1

Various custom fields for collecting and storing bespoke payer details for later use.

O

CustomField2

O

CustomField3

O

CustomField4

O

CustomField5

O

FirstAmount

If the first collection is to have a different amount than the remaining collection schedule then it can be set here.  If left blank RegularAmount will be used

A decimal amount (in UK pounds)

E.g.   123.45

O

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 can be set here.  If left blank RegularAmount will be used

A decimal amount (in UK pounds)

E.g.   123.45

O

RegularAmount

The amount of each direct debit collection.

A decimal amount (in UK pounds)

E.g.   123.45

M

GiftAid

Allows the payer to flag the collection as occurring under the gift aid scheme.

true or false

O

FirstPaymentDate

Normally the first collection date will be determined by the schedule and will be the first possible collection date given the AUDDIS advanced notice period.

You can override the first collection date by adding a date into this field.

9c    (dd/mm/yyyy)

O

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.

n

M

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.

n

M

RecurrenceType

0 Weekly

1 Monthly

2 Annual

n

M

RecurrenceEndType

0 One Off

1 Until date

2 Until number of payments

3 Ongoing

n

M

UntilDate

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

9c    (dd/mm/yyyy)

C

M is RecurrenceEndType = 1

TotalPayments

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

n

C

M if RecurrenceEndType = 2