CreateSchedule

User

• Username

String

Required

Provided by Debitsuccess

• Password

String

Required

Provided by Debitsuccess

RequestInitiator

String

100

Optional

Optional – allows requesting user to be logged

AccountReferenceNo

String

15

Optional^*

Debitsuccess account reference

ExternalAccountReferenceNo

String

50

Optional^*

External account reference

NewPaySchedule

• Installment

Decimal (10, 2)

Required

Must be >= $1

• PaymentFrequency

Enum

Required

OneOff, Weekly, Fortnightly, FourWeekly, Monthly, BiMonthly, Quarterly
Not allowed: NotSpecified

• MinimumEffectiveDate

DateTime

Required

The minimum start date for the schedule. Unless OverrideBillingCycleAlignment = true (see below) the actual start date will be set to the first date after that aligns with the current schedule e.g. if the current schedule bills weekly on Monday and the minimum effective date is a Tuesday the start date will be set to the following Monday. The minimum schedule start date must be in the future.

If the PaymentFrequency is set to OneOff then the account can be billed on the day of submission as long as the call is made before the Debitsuccess cut-off time. If the day of submission is provided after the cut-off time, this date will be set to the next available working date.

Must be formatted as yyyy-MM-dd

• Description

String

50

Optional

• EndDate

DateTime

Optional

The date that the schedule should finish. Exclude this element from the request to specify a continuous schedule. Must not be set when no future schedules exist or if DeleteFutureSchedules = true.

Must be formatted as yyyy-MM-dd

• ExternalScheduleIdentifier

Varchar

50

Optional

External pay schedule reference

DeleteFutureSchedules

Boolean

Required

true = this schedule replaces any later schedules. Must be false for one-off schedules.

AdjustFutureSchedules

Boolean

Required

true = If this is a change to the frequency of payments, apply this change to any later schedules for the customer. Must be false for one-off schedules.

OverrideBillingCycleAlignment

Boolean

Optional

true = Overrides default behaviour and sets the start date of the new payment schedule to be the minimum effective date. PreviousScheduleEndDate is required with this option.

PreviousScheduleEndDate

DateTime

Required^**

Use this to manually set the end date of the schedule immediately prior to the one being added. If this is null the end date of the previous schedule will be set to a day before the new schedule is due to start. The previous schedule end date must be today or in the future and prior to the scheduled start date.

Previous schedule end date must be provided when creating a schedule that will not be aligned with the new schedule.

Must be formatted as yyyy-MM-dd

DateCreated

DateTime

Date/time message was processed

Id

String

Unique ID for the message

ResponseNotes ()

Collection of validation messages

• Code

String

• Note

String

• NoteType

Enum

Error, Warning, Info

Status

Enum

Failed, Succeed, Unknown

NewScheduleId

String^*

Identifier for the new schedule.

ExternalScheduleIdentifier

String

External pay schedule reference

Error

12015

Missing New PaySchedule request object

Error

13008

Invalid request. Cannot set AdjustFutureSchedules to true as the method or operation is not implemented yet.

Error

13010

Invalid request. Adjust & Delete future schedules cannot both be set to true.

Error

13051

Schedule end date is invalid for a recurring schedule with no subsequent schedules

Error

13052

Schedule end date is invalid for a one-off schedule

Error

13053

Adjust and delete future schedules are invalid when adding a one-off schedule

Error

13057

Previous schedule end date must be provided when creating a schedule that will not be aligned with the current schedules

Warning

14020

DateTime field '{0}' contains time part, but the time is ignored by message.

Warning

14021

Decimal field '{0}' contains more than 2 decimal points that were ignored by message.

Error

13055

Schedule end date must be before the next schedule start date

Error

13059

Installment must be $1 or more.

Error

13058

Schedule frequency 'NotSpecified' is not allowed.

Error

02

Invalid user credentials

Error

12016

Missing required reference number. Must provide either ExternalAccountReferenceNo or AccountReferenceNo or both.

Error

08

There is no record found with this criteria

Error

10

Account is not active

Error

11

Timeout/Deadlock Error - Please retry

Error

07

Multiple accounts found with this criteria

Error

13002

Invalid invoice/schedule start date

Error

14084

Cannot create this type of Schedule on a closed account.

Error

13009

Invalid MinimumEffectiveDate.The date must be in the future.

Error

13054

Schedule end date must be on or after today

Error

14090

The ExternalScheduleIdentifier field has a character length limit of 50.

Error

14139

The Description field has a character length limit of 50.

Error

14111

New payment schedules cannot be created as the account is currently set to StopPayments{0}.

Warning

14112

This account is currently set to StopPayments{0}. Unless this is removed prior to the schedule start date, the payment will not be attempted.

Warning

14063

New Schedule start date is today and the request is after the Cut off time, so the next bill date is set to next working date.

Error

13170

No payment method found for the account. Please add one and try again.

Error

14098

The ScheduleExternalIdentifier {0} is not unique and has been used for a Schedule previously. Please retry with a different ScheduleExternalIdentifier

Warning

14004

The next billing date for the account has been set to the new schedule start date.

Info

00

Success

Error

13008

Invalid request. Cannot set AdjustFutureSchedules to true as the method or operation is not implemented yet.

POST Schedule (Recurring)

OR

POST Schedule (One-off)