PostCustomerAccountForExistingCustomer

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

ContractPrefix

String

6

Required

Provided by Debitsuccess (allows customer accounts to be split into different organisational groups if required)

Account Details

DateAccountStarted

DateTime

Required

Account Start Date (date establishment fee will be taken if applicable)

Must be formatted as YYYY-MM-DD

Term

Int

Required

Minimum term in months or payments

TermType

Enum

Required

Months, Payments

AccountCode

String

50

Optional

Maximum 50 characters. Allowed characters are a-zA-Z0-9_-

AccountNotes

String

10000

Optional

Free form notes field. The maximum length of 10000 characters

NewExternalAccountReferenceNo

String

50

Optional

Your account identifier

FixedTerm

Bool

Required

true – account will be closed at the end of the minimum term

false – account will continue to bill after the minimum term

FixTotalValue

Bool

Required

false – the total value of the account will be calculated based on the value of the recurring schedule and the term

true – the total value of the account will be set to the value passed in the TotalValue property

TotalValue

Decimal (10, 2)

Required if FixTotalValue is true

Total value of recurring payments to be collected for an account,

For Term Value 'Payments', the value cannot exceed the number of payments in the term ^* the instalment and must be greater than (the number of payments in the term-1) ^* the instalment

For Term Value 'Months', the value cannot exceed the number of payments in the term * the instalment and must be greater than 1 * the instalment. If term type is specified as ‘Months’, the term starts on the account start date, not the recurring payments start date.

e.g. if the account's term is 12 payments and the weekly recurring schedule has an instalment of $100 then 1100 <Total value <= 1200

e.g. if the account term is 2 months and the weekly recurring schedule has an instalment of $100 then 100 < Total value <= 900

WaiveEstFee

Bool

Optional

Can be used to override the establishment fee payer in case it is set to the client by default and should be waived so that the facility pays the establishment fee.

Payment Details

InitialOneOffScheduleStartDate

DateTime

Required if One off instalment > 0

Date initial one-off payment should be taken on

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

InitialOneOffScheduleInstalment

Decimal (10, 2)

Optional^**

Amount of initial one-off payment

InitialOneOffScheduleDescription

String

50

Optional

Optional description of the one-off payment

InitialScheduleExternalIdentifier

Varchar

50

Optional

Use this if you require an additional reference number to be associated with the schedule itself.

For example: If you wish to test that all schedules are unique and are generating your own reference number.

RecurringScheduleStartDate

DateTime

Required if recurring instalment > 0

Regular payment start date

Must be formatted as YYYY-MM-DD

RecurringScheduleInstalment

Decimal (10, 2)

Optional^**

Regular payment amount

RecurringScheduleFrequency

Enum

Required if recurring instalment > 0

Weekly, Fortnightly, FourWeekly, Monthly, BiMonthly, Quarterly

(Note: OneOff frequency is part of the enumeration but is not valid for a recurring schedule)

RecurringScheduleDescription

String

50

Optional

Optional description of regular payment

RecurringScheduleExternalIdentifier

Varchar

50

Optional

Use this if you require an additional reference number to be associated with the schedule itself.

For example: If you wish to test that all schedules are unique and are generating your own reference number.

DateCreated

DateTime

Date/time message was processed

Id

String

Unique ID for the message

AccountReferenceNo

String

Debitsuccess account reference

ExternalAccountReferenceNo

String

External account reference

ResponseNotes ()

Collection of validation messages

• Code

String

• Note

String

• NoteType

Enum

Error, Warning, Info

Status

Enum

Failed, Succeed, Unknown

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

13170

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

Error

14108

AccountReferenceNo cannot be from an add on facility account.

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

13201

Account code field cannot be more than 50 characters long.

Error

13202

Account code field contains unallowed characters.

Error

13203

<Field name> field cannot be more than <maxlength> characters.

Error

13204

<Field name> field contains unallowed characters.