Manual
Extended Web Services
API Reference Guide
Version 6.16
Debitsuccess
Extended Web Services - API Reference Guide
Table of Contents
Overview ......................................................................................................................................................................... 3
Web Service Methods..................................................................................................................................................... 4
Cancel Account ........................................................................................................................................................... 4
Get Calls History For Date Range ................................................................................................................................ 5
Get Calls History By Account Id .................................................................................................................................. 7
Get Customer Account For Date Range ...................................................................................................................... 8
Get Customer Account By Account Id ...................................................................................................................... 12
Post Customer Account ............................................................................................................................................ 13
Post Customer Account For Existing Customer ........................................................................................................ 17
Update Client Details ................................................................................................................................................ 20
Update Client Address .............................................................................................................................................. 21
Update Client Email Address .................................................................................................................................... 22
Update Client Phone Number................................................................................................................................... 23
Adjust Account Total Value ...................................................................................................................................... 24
Adjust Next Payment Date ....................................................................................................................................... 25
Adjust Catchup Payment .......................................................................................................................................... 26
Stop Payment ........................................................................................................................................................... 27
Resume Payment ...................................................................................................................................................... 28
Suspend Account ...................................................................................................................................................... 29
Suspend Account For Number Of Payment Cycles ................................................................................................... 30
Suspend Account Between Dates ............................................................................................................................. 31
Change Payment Method ......................................................................................................................................... 32
Get Audit History By Account Id ............................................................................................................................... 33
Get Audit History For Date Range............................................................................................................................. 34
Get Payment History By Account Id.......................................................................................................................... 35
Get Payment History For Date Range ....................................................................................................................... 37
Get Overdue Status History For Date Range ............................................................................................................ 38
Initiate Refund .......................................................................................................................................................... 39
14/12/16
1 of 80
Debitsuccess
Extended Web Services - API Reference Guide
Create Schedule ........................................................................................................................................................ 40
Delete Pay Schedule ................................................................................................................................................. 42
Delete Penalty fee Schedule ..................................................................................................................................... 43
Adjust Account Fixed Term ....................................................................................................................................... 44
Adjust Payment In Advance ...................................................................................................................................... 45
Adjust Account Last Access ....................................................................................................................................... 46
Process Real Time Card Payment ............................................................................................................................. 47
Process Card Payment For Customer Account ......................................................................................................... 49
Process OneOff Card Payment For Customer Account............................................................................................. 50
Get Card Payment Status For Customer Account ..................................................................................................... 52
Payment Collected .................................................................................................................................................... 53
Adjust Account Start Date ........................................................................................................................................ 54
Adjust Account Payment Method ............................................................................................................................ 55
Adjust Account Next Payment Date ......................................................................................................................... 56
Adjust Account External Account Reference No ...................................................................................................... 57
Adjust Suspension End Date ..................................................................................................................................... 58
Get Facility Account Configuration ........................................................................................................................... 59
Adjust Account Append Notes .................................................................................................................................. 60
Get Payment Token .................................................................................................................................................. 61
Get Current Month Collections ................................................................................................................................ 64
States ............................................................................................................................................................................ 65
Error Codes ................................................................................................................................................................... 66
Example Code ............................................................................................................................................................... 73
Client Configuration File ............................................................................................................................................... 79
14/12/16
2 of 80
Debitsuccess
Extended Web Services - API Reference Guide
OVERVIEW
The purpose of this document is to explain the Extended Web Service methods and their expected parameters.
14/12/16
3 of 80
Debitsuccess
Extended Web Services - API Reference Guide
WEB SERVICE METHODS
CANCEL ACCOUNT
Description
This method allows Web Service users to cancel an existing account within the Debitsuccess billing system.
Request Message
Name
Data
Type
Length
Description
User
 Username
 Password
RequestInitiator
String
String
String
100
Required
Required
Optional
AccountReferenceNo
ExternalAccountReferenceNo
CancellationNote
String
String
String
15
50
30
Optional*
Optional*
Required
Provided by Debitsuccess
Provided by Debitsuccess
Optional – allows requesting user to be
logged
Debitsuccess account reference
External account reference
Reason for cancellation
*
At least one of the following parameters must be supplied: AccountReferenceNo,
ExternalAccountReferenceNo
Response Message
Name
Data Type
Description
DateCreated
Id
ResponseNotes ()
DateTime
String
Date/time message was processed
Unique ID for message
Collection of validation messages
 Code
 Note
 NoteType
Status
String
String
Enum
Enum
14/12/16
Error, Warning, Info
Failed, Succeed, Unknown
4 of 80
Debitsuccess
Extended Web Services - API Reference Guide
GET CALLS HISTORY FOR DATE RANGE
Description
This method allows clients to retrieve the Calls history from the Debitsuccess billing system based on the specified
parameters.
Request Message
Name
Data
Type
Length
Description
User
 Username
 Password
RequestInitiator
StartDate
EndDate
String
String
String
DateTime
DateTime
100
Required
Required
Optional
Required
Optional
Provided by Debitsuccess
Provided by Debitsuccess
Optional – allows requesting user to be logged
Start of the report period
End of the report period
Following is a list of the different combinations of parameters which can be used for this method:
1) Providing StartDate and EndDate parameters returns all the Calls history during the specified period for all
accounts
2) Providing the StartDate parameter returns all the Calls history from the specified date for all accounts
Response Message
Name
Data Type
Description
DateCreated
Id
ResponseNotes ()
DateTime
String
Date/time message was processed
Unique ID for message
Collection of validation messages
 Code
 Note
 NoteType
Status
String
String
Enum
Enum
Error, Warning, Info
Failed, Succeed, Unknown
AccountReferenceNo
String
Debitsuccess Reference
ExternalAccountReferenceNo
String
External account reference
CallNotes ()
 AccountReferenceNo
 ExternalAccountReferenceNo
 Notes
String
String
String
Debitsuccess Reference
External account reference
Call Notes
String
CA (Call Attempt)
CCI (CC Form In)
CE (Client Enquiry)
COM (Complaint)
CR (Cancellation Request)
CS (Customer Service )
CU (Catch Up Arranged)
DC (Detail Change)
DDI (DD Form In)
 Purpose
14/12/16
5 of 80
Debitsuccess
 CommunicationChannel
 DateCallMade
14/12/16
Extended Web Services - API Reference Guide
String
DateTime
FAC (Facility Enquiry)
FD (Final Credit Control Call)
FDC (Final Credit Control Call Cancelation)
FDD (Final Credit Control Call Deferral)
FIR (First Payment Reversal)
GTR (Guarantor Details Updated)
HLD (Hold Refer To Author)
LTR (Letter)
OD (Overdue Call)
OD1 (OD 1 Letter)
OD2 (OD 2 Letter)
OD3 (OD 3 Letter)
ODM (OD Call Spoke to Member)
ODP (OD Call Payment Made)
ODS (OD Call Payment Scheduled)
ODX (OD Call Left Message)
PAY (Payment)
PC (Payment Variation)
RDC (Reinstated from Debt Collection)
REE (Re Enrolment)
REF (Refund Request)
RTF (Reported To Facility)
RTM (Returned Mail)
RV (Review)
SDC (Debt Collection)
SUS (Suspension)
SYS (System Update)
TRN (Transfer)
WCL (Welcome Letter)
Channel
Call note date
6 of 80
Debitsuccess
Extended Web Services - API Reference Guide
GET CALLS HISTORY BY ACCOUNT ID
Description
This method allows clients to retrieve the Calls history from the Debitsuccess billing system based on the specified
parameters.
Request Message
Name
Data Type
Length
Description
User
 Username
 Password
RequestInitiator
String
String
String
100
Required
Required
Optional
AccountReferenceNo
ExternalAccountReferenceNo
String
String
15
50
Optional*
Optional*
Provided by Debitsuccess
Provided by Debitsuccess
Optional – allows requesting user to be
logged
Debitsuccess account reference
External account reference
*
At least one of the following parameters must be supplied: AccountReferenceNo,
ExternalAccountReferenceNo
Response Message
As per response message for GetCallHistoryForDateRange
14/12/16
7 of 80
Debitsuccess
Extended Web Services - API Reference Guide
GET CUSTOMER ACCOUNT FOR DATE RANGE
Description
This method allows clients to retrieve the details of accounts that have been loaded or updated within a specified
date range (based on the specified parameters).
Request Message
Name
Data
Type
Length
Description
User
 Username
 Password
RequestInitiator
StartDate
EndDate
String
String
String
DateTime
DateTime?
100
Required
Required
Optional
Required
Optional
Provided by Debitsuccess
Provided by Debitsuccess
Optional – allows requesting user to be logged
Start of the report period
End of the report period
Following is a list of the different combinations of parameters which can be used for this method:
1) Providing StartDate and EndDate parameters returns account details for all accounts that have had details
changed during the specified period.
2) Providing the StartDate parameter returns account details for all accounts that have had details changed
after the specified date.
Response Message
Name
Data Type
Description
DateCreated
Id
ResponseNotes ()
DateTime
String
Date/time message was processed
Unique ID for message
Collection of validation messages
 Code
 Note
 NoteType
Status
Accounts ()
String
String
Enum
Enum






Term
TermType
AccountCode
AccountNotes
AccountReferenceNo
ContractPrefix
int
Enum
String
String
String
String
 ExternalAccountReferenceNo
 NextBillingDate
String
DateTime?
 LastBillingDate
 OverdueStatus
DateTime?
int
14/12/16
Error, Warning, Info
Failed, Succeed, Unknown
Length of term
Months, Payments
Account code from contract
Free form notes field.
Debitsuccess Reference number
Provided by Debitsuccess (allows
customer accounts to be split into
different organisational groups if
required)
Your account identifier
Next date the account is due to be billed
on
Last date the account was billed on
0, 1, 2, 3 (0 = Not overdue, 3 = last stage
before being send to debt collection or
8 of 80
Debitsuccess
Extended Web Services - API Reference Guide
written off)
 OverdueAmount
 OverdueAmountWithoutFees
Decimal (10, 2)
Decimal (10, 2)
 FixedTerm
Boolean
 LastReversalReason
 CancelReason
String
String
 Suspended
Boolean
 SuspensionEndDate
DateTime
 PaymentsStopped
Boolean
 PaymentStopEndDate
DateTime
 CurrentInstalment
Decimal (10, 2)
 CurrentFrequency
Enum
 CatchUpAmount
Decimal (10, 2)
 CatchUpEndDate
true – payments have been stopped (the
amount owing will continue to accrue
while payments are stopped)
Date that the payment stop is due to end
Current instalment amount
Current payment frequency
Catch-up amount
End date for catch-up
DateTime
Payment in advance amount
 PaymentInAdvanceAmount
Decimal (10, 2)
 PaymentInAdvanceEndDate
DateTime




DateTime
DateTime
DateTime
DateTime
DateAccountStarted
DateAccountClosed
DateAccountLoaded
LastUpdatedDate
Overdue amount without Debitsuccess
establishment or penalty fees.
true – account will be closed at the end of
the minimum term
false – account will continue to bill after
minimum term
Reason for last payment failure
Reason account was closed
true – payments are suspended (the
amount owing will NOT continue to
accrue while payments are suspended)
Date that suspension is due to end
End date for payment in advance
 MinTermTotalValue
Decimal (10, 2)
 OutstandingBalance
Decimal (10, 2)
 OutstandingBalanceWithoutFees
Decimal (10, 2)
 AccountTemplate
 ProjectedFinishDate
Guid
DateTime
Date that the customer account or a
related record was last updated
Amount to be collected for the account
(in terms of recurring payments) before
the account is past its minimum term
For an open account this returns the
amount remaining for the account to pay
Outstanding balance without
Debitsuccess establishment or penalty
fees
OMG contract template unique-identifier
Calculated estimated time for the account
finish date. This field is being calculated
overnight.
 OneOffSchedules ()
14/12/16
9 of 80
Debitsuccess
o
o
o
o
StartDate
Installment
PaymentFrequency
Description
o ScheduleId
 RecurringSchedules ()
o StartDate
o EndDate
o Installment
o PaymentFrequency
o Description
o ScheduleId
 SuspensionSchedules ()
o StartDate
o EndDate
o Installment
o PaymentFrequency
o Description
o ScheduleId
 Customer
o CustomerDetail
 DateOfBirth
 Gender
 FirstName
 MiddleName
 LastName
 Title
o Contacts
 Phones ()
 PhoneNumberType
DateTime?
Decimal? (10, 2)
Enum
String
int
DateTime?
DateTime?
Decimal? (10, 2)
Enum
String
int
DateTime?
DateTime?
Decimal? (10, 2)
Enum
String
int
DateTime?
Enum
String
String
String
String
ContactDetails
Enum
 CountryCode
 StdCode
 Number
 Preferred
 Name
 Emails ()
Enum
String
String
Boolean
String
 EmailAddress
 Preferred
 Addresses ()
String
Boolean
 AddressType
14/12/16
Extended Web Services - API Reference Guide
Enum
OneOff
DS-DebtCallFee: Description**,
DS-EstablishmentFee: Description**,
DS-MiscellaneousFee: Description**,
DS-PenaltyFee: Description**,
DS-Service: Description**,
DS-TransferFee: Description**,
Description (for one-off fees alone)
Unique identifier
Weekly, Fortnightly, FourWeekly,
Monthly, BiMonthly, Quarterly
Unique identifier
OneOff, Weekly, Fortnightly, FourWeekly,
Monthly, BiMonthly, Quarterly
Unique identifier
Male, Female, Unknown
Home, Mobile, Work, Emergency,
Previous
NotSpecified, Aus, NZ, USA
Home, Business, Physical, Postal, Previous
10 of 80
Debitsuccess




Extended Web Services - API Reference Guide
Street
Suburb
City
State
String
String
String
Enum
 Postcode
 Country
String
Enum
 Locality
 Preferred
String
Boolean
 Paymethod
o AccountNo
o ExpiryDate
o AccountHolder
o AccountType
o CreditCardType
String
DateTime
String
Enum
Enum
See table
NotSpecified, Australia, NewZealand,
UnitedStatesOfAmerica
Whether address is preferred (true or
false)
BankAccount, CreditCard
None, AmericanExpress, Mastercard, Visa
**These values will only be returned by separate calls GET CUSTOMER ACCOUNT WITH FEES FOR DATE RANGE and
GET CUSTOMER ACCOUNT WITH FEES BY ACCOUNT ID. The request and the rest of the response messages are exactly
the same as GET CUSTOMER ACCOUNT FOR DATE RANGE and GET CUSTOMER ACCOUNT BY ACCOUNT ID
respectively.
14/12/16
11 of 80
Debitsuccess
Extended Web Services - API Reference Guide
GET CUSTOMER ACCOUNT BY ACCOUNT ID
Description
This method allows clients to retrieve the account details from the Debitsuccess billing system based on the specified
parameters.
Request Message
Name
Data Type
Length
Description
User
 Username
 Password
RequestInitiator
String
String
String
100
Required
Required
Optional
AccountReferenceNo
ExternalAccountReferenceNo
String
String
15
50
Optional*
Optional*
Provided by Debitsuccess
Provided by Debitsuccess
Optional – allows requesting user to be
logged
Debitsuccess account reference
External account reference
*
At least one of the following parameters must be supplied: AccountReferenceNo,
ExternalAccountReferenceNo
Response Message
As per response message for GetCustomerAccountForDateRange
14/12/16
12 of 80
Debitsuccess
Extended Web Services - API Reference Guide
POST CUSTOMER ACCOUNT
Description
This method allows customer and account details to be loaded into the Debitsuccess system for billing
Request Message
Name
Data Type
Length
Description
User
 Username
 Password
RequestInitiator
String
String
String
100
Required
Required
Optional
ContractPrefix
String
6
Required
String
String
String
String
DateTime
Enum
40
40
40
10
Required
Optional
Optional
Optional
Maximum length 40 characters
Optional
Male, Female, Unknown
DateTime
Required
Term
TermType
AccountCode
Int
Enum
String
100
Required
Required
Optional
AccountNotes
String
10000
Optional
ExternalAccountReferenceNo
FixedTerm
String
Bool
50
Optional
Required
AccountCountry
Enum
Required
FixTotalValue
Bool
Required
Account Start Date (date establishment
fee will be taken if applicable)
Minimum term in months or payments
Months, Payments
Maximum 50 characters. Allowed
characters are a-zA-Z0-9_Free form notes field. Maximum length
10000 characters
Your account identifier
true – account will be closed at the end
of the minimum term
false – account will continue to bill after
minimum term
Australia, NeswZealand,
UnitedStatesOfAmerica
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 in the
TotalValue property
TotalValue
Decimal (10,
2)
Required if
FixTotalValue
is true
Customer Details
FirstName
MiddleName
LastName
Title
DateOfBirth
Gender
Account Details
DateAccountStarted
Provided by Debitsuccess
Provided by Debitsuccess
Optional – allows requesting user to be
logged
Provided by Debitsuccess (allows
customer accounts to be split into
different organisational groups if
required)
Maximum length 40 characters
Total value of recurring payments to be
collected for account,
For Term Value 'Payments', the value
14/12/16
13 of 80
Debitsuccess
Extended Web Services - API Reference Guide
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 the
term type is specified in ‘Months’ the
term starts on the account start date not
the recurring payments start date.
e.g. if the accounts 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
AccountTemplate
Guid
Optional
ProjectedFinishDate
Datetime
Payment Method Details
AccountNo
String
ExpiryDate
DateTime
AccountHolder
String
AccountType
CreditCardType
Enum
Enum
Required
Required
Payment Details
InitialOneOffScheduleStartDat
e
DateTime
Required if
One off
instalment > 0
Optional*
Date initial one-off payment should be
taken on
Optional
Optional description of one-off payment
Required if
Regular payment start date
InitialOneOffScheduleInstalm
ent
InitialOneOffScheduleDescript
ion
RecurringScheduleStartDate
14/12/16
Decimal (10,
2)
String
DateTime
35
Required
50
Required if
credit card
Required
50
Can be used to override the
establishment fee payer in case it is set
to client by default and should be waived
so that the facility pays the
establishment fee.
OMG contract template uniqueidentifier
Calculated estimated time for the
account finish date. This field is being
calculated overnight.
Bank account number (preceded by BSB
for Australia), Credit card number.
No spaces, dashes or any other nonalphanumeric character should be
entered into the AccountNo property.
Credit card expiry date
Name of account, card holder. Maximum
length 50 characters
BankAccount, CreditCard
None, AmericanExpress, Mastercard,
Visa
Amount of initial one-off payment
14 of 80
Debitsuccess
RecurringScheduleInstalment
RecurringScheduleFrequency
Extended Web Services - API Reference Guide
recurring
instalment > 0
Optional*
Decimal (10,
2)
Enum
Required if
recurring
instalment > 0
RecurringScheduleDescription
Address Details
PhysicalAddress
String
50
Optional
String
60
Optional****
PhysicalLocality
PhysicalSuburb
String
String
50
50
PhysicalCity
String
50
PhysicalState
State
PhysicalCountry
Enum
Optional*****
Required
(Australia)
Required (NZ,
USA)
Required
(Australia,
USA)
Required
PhysicalPostcode
BillingAddress
BillingLocality
BillingSuburb
String
String
String
String
10
60
50
50
BillingCity
String
50
BillingState
Enum
BillingCountry
Enum
BillingPostcode
String
10
Other Contact Details
EmailAddress
String
75
14/12/16
Required
Optional****
Optional*****
Required for
Australia if
Billing Address
line 1 is
supplied
Required for
NZ and
UnitedStatesO
fAmerica If
Billing Address
line 1 is
supplied
Required for
Australia and
UnitedStatesO
fAmerica if
Billing Address
line 1 is
supplied
Required if
Billing Address
line 1 is
supplied
Required if
Billing Address
line 1 is
supplied
Optional*****
Regular payment amount
Weekly, Fortnightly, FourWeekly,
Monthly, BiMonthly, Quarterly
(Note: OneOff frequency is part of the
enumeration but is not valid for a
recurring schedule)
Optional description of regular payment
Physical Address line 1. Maximum length
60 characters
Physical Address line 2
Maximum length 50 characters
Maximum length 50 characters
See table
NotSpecified, Australia, NewZealand,
UnitedStatesOfAmerica
Maximum length 10 characters
Billing Address line 1
Billing Address line 2
See table
NotSpecified, Australia, NewZealand,
UnitedStatesOfAmerica
Email Address. Maximum length 75
15 of 80
Debitsuccess
Extended Web Services - API Reference Guide
75
Optional**
Enum
String
10
Optional**
Optional**
BusinessNumber
String
75
Optional**
BusinessCountryCode
BusinessSTD
Enum
String
10
Optional**
Optional**
EmergencyNumber
EmergencyCountryCode
EmergencySTD
EmergencyName
MobileNumber
String
Enum
String
String
String
MobileCountryCode
MobileSTD
Enum
String
HomeNumber
String
HomeCountryCode
HomeSTD
*
75
10
50
75
Optional
Optional**
Optional
Optional***
Optional**
10
Optional**
Optional**
characters
Home phone number. Maximum length
75 characters
NotSpecified, Aus, NZ, USA
Home STD Code. Maximum length 4
characters
Business phone number. Maximum
length 75 characters
NotSpecified, Aus, NZ, USA
Business STD Code. Maximum length 4
characters
Emergency phone number
NotSpecified, Aus, NZ, USA
Emergency STD Code
Emergency contact name
Mobile phone number. Maximum length
75 characters
NotSpecified, Aus, NZ, USA
Mobile STD Code
At least one payment schedule (One off or recurring) must be supplied
**
At Least one contact detail (Home, Business or Mobile) must be supplied. Mobile is mandatory for Hong
Kong clients
***
Required if emergency number is supplied
****
At Least one address detail(Physical, Billing) must be supplied
*****
Mandatory for Hong Kong addresses
Note: If both address are provide the Billing address will be the preferred contact address
Response Message
Name
Data Type
Description
DateCreated
Id
AccountReferenceNo
ExternalAccountReferenceNo
ResponseNotes ()
DateTime
String
String
String
Date/time message was processed
Unique ID for message
Debitsuccess account reference
External account reference
Collection of validation messages



Status
String
String
Enum
Enum
Code
Note
NoteType
14/12/16
Error, Warning, Info
Failed, Succeed, Unknown
16 of 80
Debitsuccess
Extended Web Services - API Reference Guide
POST CUSTOMER ACCOUNT FOR EXISTING CUSTOMER
Description
This method allows customer account details to be loaded into the Debitsuccess system for billing using the same
customer details previously provided for an existing customer account. Please note the following restrictions:
-
Only the payment method for the current active schedule is copied.
Only the current physical and billing addresses are copied.
If present the billing address will be set as preferred.
Request Message
Name
Data
Type
Length
Description
User
 Username
 Password
RequestInitiator
String
String
String
100
Required
Required
Optional
AccountReferenceNo
ExternalAccountReferenceNo
ContractPrefix
String
String
String
15
50
6
Optional*
Optional*
Required
Account Details
DateAccountStarted
DateTime
Required
Term
TermType
AccountCode
Int
Enum
String
100
Required
Required
Optional
AccountNotes
String
10000
Optional
NewExternalAccountReferenceN
o
FixedTerm
String
50
Optional
Bool
Required
FixTotalValue
Bool
Required
TotalValue
Decimal
(10, 2)
Required if
FixTotalValue
is true
Provided by Debitsuccess
Provided by Debitsuccess
Optional – allows requesting user to be
logged
Debitsuccess account reference
External account reference
Provided by Debitsuccess (allows
customer accounts to be split into
different organisational groups if
required)
Account Start Date (date establishment
fee will be taken if applicable)
Minimum term in months or payments
Months, Payments
Maximum 50 characters. Allowed
characters are a-zA-Z0-9_Free form notes field. Maximum length
10000 characters
Your account identifier
true – account will be closed at the end
of the minimum term
false – account will continue to bill after
minimum term
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 in the
TotalValue property
Total value of recurring payments to be
collected for account,
For Term Value 'Payments', the value
14/12/16
17 of 80
Debitsuccess
Extended Web Services - API Reference Guide
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 accounts 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 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
Optional**
Date initial one-off payment should be
taken on
Optional
Required if
recurring
instalment >
0
Optional**
Optional description of one-off payment
Regular payment start date
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)
Optional description of regular payment
InitialOneOffScheduleInstalment
InitialOneOffScheduleDescription
RecurringScheduleStartDate
RecurringScheduleInstalment
Decimal
(10, 2)
String
DateTime
RecurringScheduleFrequency
Decimal
(10, 2)
Enum
RecurringScheduleDescription
String
50
50
Optional
Amount of initial one-off payment
Regular payment amount
*
At least one of the following parameters must be supplied: AccountReferenceNo,
ExternalAccountReferenceNo
**
14/12/16
At least one payment schedule (One off or recurring) must be supplied
18 of 80
Debitsuccess
Extended Web Services - API Reference Guide
Response Message
Name
Data Type
Description
DateCreated
Id
AccountReferenceNo
ExternalAccountReferenceNo
ResponseNotes ()
DateTime
String
String
String
Date/time message was processed
Unique ID for message
Debitsuccess account reference
External account reference
Collection of validation messages



Status
String
String
Enum
Enum
Code
Note
NoteType
14/12/16
Error, Warning, Info
Failed, Succeed, Unknown
19 of 80
Debitsuccess
Extended Web Services - API Reference Guide
UPDATE CLIENT DETAILS
Description
This method allows a customer’s name, date of birth and gender details to be updated
Request Message
Name
Data Type
Length
Description
User
 Username
 Password
RequestInitiator
String
String
String
100
Required
Required
Optional
AccountReferenceNo
ExternalAccountReferenceNo
CustomerDetail
 FirstName
 MiddleName
 LastName
 Title
 DateOfBirth
 Gender
String
String
15
50
Optional*
Optional*
String
String
String
String
DateTime
Enum
40
40
40
10
Optional**
Optional**
Optional**
Optional**
Optional**
Optional**
Provided by Debitsuccess
Provided by Debitsuccess
Optional – allows requesting user to
be logged
Debitsuccess account reference
External account reference
Maximum length 40 characters
Maximum length 40 characters
Male, Female, Unknown
*
At least one of the following parameters must be supplied: AccountReferenceNo,
ExternalAccountReferenceNo
**
If an empty string is passed the customer detail will be overridden but if a null is passed it will be ignored
Response Message
Name
Data Type
Description
DateCreated
Id
ResponseNotes ()
DateTime
String
Date/time message was processed
Unique ID for message
Collection of validation messages
 Code
 Note
 NoteType
Status
String
String
Enum
Enum
14/12/16
Error, Warning, Info
Failed, Succeed, Unknown
20 of 80
Debitsuccess
Extended Web Services - API Reference Guide
UPDATE CLIENT ADDRESS
Description
This method allows a customer’s address details to be updated. Any existing address of the specified type held by
Debitsuccess will be marked as AddressType = Previous and replaced by the address data supplied in this message.
Request Message
Name
Data
Type
Length
Description
User
 Username
 Password
RequestInitiator
String
String
String
100
Required
Required
Optional
AccountReferenceNo
ExternalAccountReferenceNo
NewAddress
 AddressType
 Street
 Suburb
 City
 State
 Country
String
String
15
50
Optional*
Optional*
Enum
String
String
String
Enum
Enum
Provided by Debitsuccess
Provided by Debitsuccess
Optional – allows requesting user to be
logged
Debitsuccess account reference
External account reference
Physical/Postal
50
50
50
 Postcode
 Preferred
String
Boolean
 Locality
String
10
Maximum length 50 characters
Maximum length 50 characters
See table
Australia, NewZealand,
UnitedStatesOfAmerica
Maximum length 10 characters
Customer’s preferred address (true or
false)
*
At least one of the following parameters must be supplied: AccountReferenceNo,
ExternalAccountReferenceNo
Response Message
Name
Data Type
Description
DateCreated
Id
ResponseNotes ()
DateTime
String
Date/time message was processed
Unique ID for message
Collection of validation messages
 Code
 Note
 NoteType
Status
String
String
Enum
Enum
14/12/16
Error, Warning, Info
Failed, Succeed, Unknown
21 of 80
Debitsuccess
Extended Web Services - API Reference Guide
UPDATE CLIENT EMAIL ADDRESS
Description
This method allows a customer’s email address to be updated
Request Message
Name
Data
Type
Length
Description
User
 Username
 Password
RequestInitiator
String
String
String
AccountReferenceNo
ExternalAccountReferenceNo
EmailAddress
 Preferred
 EmailAddress
String
String
Email
Boolean
String
100
Required
Required
Optional
15
50
Optional*
Optional*
Provided by Debitsuccess
Provided by Debitsuccess
Optional – allows requesting user to be
logged
Debitsuccess account reference
External account reference
75
*
At least one of the following parameters must be supplied: AccountReferenceNo,
ExternalAccountReferenceNo
Response Message
Name
Data Type
Description
DateCreated
Id
ResponseNotes ()
DateTime
String
Date/time message was processed
Unique ID for message
Collection of validation messages



Status
String
String
Enum
Enum
Code
Note
NoteType
14/12/16
Error, Warning, Info
Failed, Succeed, Unknown
22 of 80
Debitsuccess
Extended Web Services - API Reference Guide
UPDATE CLIENT PHONE NUMBER
Description
This method allows customer’s phone number to be updated. Any existing phone number of the specified type held
by Debitsuccess will be marked as Phone Number Type = Previous and replaced by the phone number data supplied in
this message.
Request Message
Name
Data Type
Length
Description
User
 Username
 Password
RequestInitiator
String
String
String
100
Required
Required
Optional
AccountReferenceNo
ExternalAccountReferenceNo
PhoneNumber
String
String
15
50
Optional*
Optional*
Provided by Debitsuccess
Provided by Debitsuccess
Optional – allows requesting user
to be logged
Debitsuccess account reference
External account reference
Required
Home, Mobile, Work, Emergency





PhoneNumberType
CountryCode
STDCode
Number
Name
 Preferred
Enum
Enum
String
String
String
4
75
40
Required
Boolean
Maximum length 4 characters
Maximum length 75 characters
Required for emergency phone
type
Customer’s preferred phone
number (true or false)
*
At least one of the following parameters must be supplied: AccountReferenceNo,
ExternalAccountReferenceNo
Response Message
Name
Data Type
Description
DateCreated
Id
ResponseNotes ()
DateTime
String
Date/time message was processed
Unique ID for message
Collection of validation messages
 Code
 Note
 NoteType
Status
String
String
Enum
Enum
14/12/16
Error, Warning, Info
Failed, Succeed, Unknown
23 of 80
Debitsuccess
Extended Web Services - API Reference Guide
ADJUST ACCOUNT TOTAL VALUE
Description
Adjust the Total Value of the Account in the Debitsuccess Billing System. If the Account is not Set to Term, it will be
Set to Term as a result of this method call.
Request Message
Name
Data Type
Length
Description
User
 Username
 Password
RequestInitiator
String
String
String
AccountReferenceNo
ExternalAccountReferenceNo
CurrentTotalValue
NewTotalValue
String
String
Decimal (10, 2)
Decimal (10, 2)
100
15
50
Required
Required
Optional
Optional*
Optional*
Required
Required
Provided by Debitsuccess
Provided by Debitsuccess
Optional – allows requesting user to be
logged
Debitsuccess account reference
External account reference
Current total value of the account
New total value of the account
*
At least one of the following parameters must be supplied: AccountReferenceNo,
ExternalAccountReferenceNo
Response Message
Name
Data Type
Description
DateCreated
Id
ResponseNotes ()
DateTime
String
Date/time message was processed
Unique ID for message
Collection of validation messages
 Code
 Note
 NoteType
Status
String
String
Enum
Enum
14/12/16
Error, Warning, Info
Failed, Succeed, Unknown
24 of 80
Debitsuccess
Extended Web Services - API Reference Guide
ADJUST NEXT PAYMENT DATE
**
Not Currently Implemented **
Description
This web service method allows the Next Billing Date to be altered within the Debitsuccess Billing System. This will
override any existing Payment Schedule in terms of the next date of Payment. Payments owing will continue to accrue
based on payment schedules irrespective of a change to the Next Billing Date.
Request Message
Name
Data Type
Length
Description
User
 Username
 Password
RequestInitiator
String
String
String
AccountReferenceNo
ExternalAccountReferenceNo
NewNextPaymentDate
String
String
DateTime
100
15
50
Required
Required
Optional
Optional*
Optional*
Required
Provided by Debitsuccess
Provided by Debitsuccess
Optional – allows requesting user to be
logged
Debitsuccess account reference
External account reference
New date of next payment. Date must
be greater than the current date.
*
At least one of the following parameters must be supplied: AccountReferenceNo,
ExternalAccountReferenceNo
Response Message
Name
Data Type
Description
DateCreated
Id
ResponseNotes ()
DateTime
String
Date/time message was processed
Unique ID for message
Collection of validation messages
 Code
 Note
 NoteType
Status
String
String
Enum
Enum
14/12/16
Error, Warning, Info
Failed, Succeed, Unknown
25 of 80
Debitsuccess
Extended Web Services - API Reference Guide
ADJUST CATCHUP PAYMENT
**
Not Currently Implemented **
Description
Adjust Catchup amount at Debitsuccess.
A catch-up is used if an account is overdue and an additional amount is to be collected along with the regular
instalment.
Request Message
Name
Data Type
Length
Description
User
 Username
 Password
RequestInitiator
String
String
String
AccountReferenceNo
ExternalAccountReferenceNo
CatchUpAmount
CatchUpEndDate
String
String
Decimal (10, 2)
DateTime
100
15
50
Required
Required
Optional
Optional*
Optional*
Required
Provided by Debitsuccess
Provided by Debitsuccess
Optional – allows requesting user
to be logged
Debitsuccess account reference
External account reference
*
At least one of the following parameters must be supplied: AccountReferenceNo,
ExternalAccountReferenceNo
Response Message
Name
Data Type
Description
DateCreated
Id
ResponseNotes ()
DateTime
String
Date/time message was processed
Unique ID for message
Collection of validation messages
 Code
 Note
 NoteType
Status
String
String
Enum
Enum
14/12/16
Error, Warning, Info
Failed, Succeed, Unknown
26 of 80
Debitsuccess
Extended Web Services - API Reference Guide
STOP PAYMENT
Description
Stop a customer’s payments for a period of time. Payments owing will continue to accrue based on payment
schedules irrespective of a stop in customer’s payments. In order to halt the accumulation of payments owing a
suspension should be used (See Suspend Account For Payment Cycles and Suspend Account Between Dates).
The StopCreditControlLetters property controls whether overdue letters will be sent to the customer for the period
that payments are stopped.
Request Message
Name
Data Type
Length
Description
User
 Username
 Password
RequestInitiator
String
String
String
AccountReferenceNo
ExternalAccountReferenceNo
StopPaymentsUntil
String
String
DateTime
StopCreditControlLetters
Boolean
100
15
50
Required
Required
Optional
Optional*
Optional*
Optional
Required
Provided by Debitsuccess
Provided by Debitsuccess
Optional – allows requesting user to be
logged
Debitsuccess account reference
External account reference
Date after which payments should
resume for the customer
false – Overdue letters will be sent to
the customer if the account becomes
overdue
true – Overdue letters will not be sent
to the customer if the account
becomes overdue
*
At least one of the following parameters must be supplied: AccountReferenceNo,
ExternalAccountReferenceNo
Response Message
Name
Data Type
Description
DateCreated
Id
ResponseNotes ()
DateTime
String
Date/time message was processed
Unique ID for message
Collection of validation messages
 Code
 Note
 NoteType
Status
String
String
Enum
Enum
14/12/16
Error, Warning, Info
Failed, Succeed, Unknown
27 of 80
Debitsuccess
Extended Web Services - API Reference Guide
RESUME PAYMENT
Description
Resumes a customer’s payments after a previous StopPayment.
Request Message
Name
Data
Type
Length
Description
User
 Username
 Password
RequestInitiator
String
String
String
100
Required
Required
Optional
AccountReferenceNo
ExternalAccountReferenceNo
String
String
15
50
Optional*
Optional*
Provided by Debitsuccess
Provided by Debitsuccess
Optional – allows requesting user to be
logged
Debitsuccess account reference
External account reference
*
At least one of the following parameters must be supplied: AccountReferenceNo,
ExternalAccountReferenceNo
Response Message
Name
Data Type
Description
DateCreated
Id
ResponseNotes ()
DateTime
String
Date/time message was processed
Unique ID for message
Collection of validation messages
 Code
 Note
 NoteType
Status
String
String
Enum
Enum
14/12/16
Error, Warning, Info
Failed, Succeed, Unknown
28 of 80
Debitsuccess
Extended Web Services - API Reference Guide
SUSPEND ACCOUNT
**
Deprecated, see SUSPEND ACCOUNT FOR NUMBER OF PAYMENT CYCLES **
Description
This method allows a customer’s payments to be suspended for a number of payment cycles after a given date.
Request Message
Name
Data Type
Length
Description
User
 Username
 Password
RequestInitiator
String
String
String
AccountReferenceNo
ExternalAccountReferenceNo
MinimumEffectiveDate
String
String
DateTime
NumberOfPaymentCycles
Integer
Required
SuspensionFee
Decimal (10,
2)
Enum
Required
SuspensionFeeFrequency
100
15
50
Required
Required
Optional
Optional*
Optional*
Required
Required if
suspension
fee > 0
Provided by Debitsuccess
Provided by Debitsuccess
Optional – allows requesting user to
be logged
Debitsuccess account reference
External account reference
The date after which (on the next
payment cycle) that the suspension
will start
The number of payment cycles to
suspend payments for
Amount to charge for the suspension
How often the fee should be charged
during the suspension.
OneOff, Weekly, Fortnightly,
FourWeekly, Monthly, BiMonthly,
Quarterly
*
At least one of the following parameters must be supplied: AccountReferenceNo,
ExternalAccountReferenceNo
Response Message
Name
Data Type
Description
DateCreated
Id
ResponseNotes ()
DateTime
String
Date/time message was processed
Unique ID for message
Collection of validation messages
 Code
 Note
 NoteType
Status
String
String
Enum
Enum
14/12/16
Error, Warning, Info
Failed, Succeed, Unknown
29 of 80
Debitsuccess
Extended Web Services - API Reference Guide
SUSPEND ACCOUNT FOR NUMBER OF PAYMENT CYCLES
Description
This method allows a customer’s payments to be suspended for a number of payment cycles after a given date.
Request Message
Name
Data Type
Length
Description
User
 Username
 Password
RequestInitiator
String
String
String
AccountReferenceNo
ExternalAccountReferenceNo
MinimumEffectiveDate
String
String
DateTime
NumberOfPaymentCycles
Integer
Required
SuspensionFee
Decimal (10,
2)
Enum
Required
SuspensionFeeFrequency
100
15
50
Required
Required
Optional
Optional*
Optional*
Required
Required if
suspension
fee > 0
Provided by Debitsuccess
Provided by Debitsuccess
Optional – allows requesting user to
be logged
Debitsuccess account reference
External account reference
The date after which (on the next
payment cycle) that the suspension
will start
The number of payment cycles to
suspend payments for
Amount to charge for the
suspension
How often the fee should be
charged during the suspension.
OneOff, Weekly, Fortnightly,
FourWeekly, Monthly, BiMonthly,
Quarterly
*
At least one of the following parameters must be supplied: AccountReferenceNo,
ExternalAccountReferenceNo
Response Message
Name
Data Type
Description
DateCreated
Id
ResponseNotes ()
DateTime
String
Date/time message was processed
Unique ID for message
Collection of validation messages
 Code
 Note
 NoteType
Status
String
String
Enum
Enum
14/12/16
Error, Warning, Info
Failed, Succeed, Unknown
30 of 80
Debitsuccess
Extended Web Services - API Reference Guide
SUSPEND ACCOUNT BETWEEN DATES
Description
This method allows a customer’s payments to be suspended between two dates. If no end date is set then an open
ended suspension will be created.
Request Message
Name
Data Type
Length
User
 Username
 Password
RequestInitiator
String
String
String
AccountReferenceNo
ExternalAccountReferenceNo
StartDate
String
String
DateTime
EndDate
DateTime
Optional
SuspensionFee
SuspensionFeeFrequency
Decimal (10, 2)
Enum
Required
Required
if
suspensio
n fee > 0
100
15
50
Description
Required
Required
Optional
Optional*
Optional*
Required
Provided by Debitsuccess
Provided by Debitsuccess
Optional – allows requesting user to be
logged
Debitsuccess account reference
External account reference
The date on which the suspension shall
start**
The date on which the suspension shall
end.
Amount to charge for the suspension
How often the fee should be charged
during the suspension.
OneOff, Weekly, Fortnightly,
FourWeekly, Monthly, BiMonthly,
Quarterly
*
At least one of the following parameters must be supplied: AccountReferenceNo,
ExternalAccountReferenceNo
**
The start date cannot be before today. If the suspension is set to start today and billing has already
commenced the account may go into credit.
Response Message
Name
Data Type
Description
DateCreated
Id
ResponseNotes ()
DateTime
String
Date/time message was processed
Unique ID for message
Collection of validation messages
 Code
 Note
 NoteType
Status
String
String
Enum
Enum
14/12/16
Error, Warning, Info
Failed, Succeed, Unknown
31 of 80
Debitsuccess
Extended Web Services - API Reference Guide
CHANGE PAYMENT METHOD
**
Deprecated, see AdjustAccountPaymentMethod **
Description
Change the Method Of Payment within the Debitsuccess Billing System by providing either new Bank Account or
Credit Card Details.
Request Message
Name
Data Type
Length
Description
User
 Username
 Password
RequestInitiator
String
String
String
100
Required
Required
Optional
AccountReferenceNo
ExternalAccountReferenceNo
NewPaymethod
 AccountNo
String
String
15
50
Optional*
Optional*
String
35
Required
50
Required
for credit
cards
Required
 ExpiryDate
DateTime
 AccountHolder
 AccountType
 CreditCardType
String
Enum
Enum
Provided by Debitsuccess
Provided by Debitsuccess
Optional – allows requesting user to be
logged
Debitsuccess account reference
External account reference
Bank account number or credit card
number
Maximum length 50 characters
BankAccount, CreditCard
None, AmericanExpress, Mastercard,
Visa
*
At least one of the following parameters must be supplied: AccountReferenceNo,
ExternalAccountReferenceNo
Response Message
Name
Data Type
Description
DateCreated
Id
ResponseNotes ()
DateTime
String
Date/time message was processed
Unique ID for message
Collection of validation messages
 Code
 Note
 NoteType
Status
String
String
Enum
Enum
14/12/16
Error, Warning, Info
Failed, Succeed, Unknown
32 of 80
Debitsuccess
Extended Web Services - API Reference Guide
GET AUDIT HISTORY BY ACCOUNT ID
**
Not Currently Implemented **
Description
This method retrieves all audit records for a specific account
Request Message
Name
Data
Type
Length
Description
User
 Username
 Password
RequestInitiator
String
String
String
100
Required
Required
Optional
AccountReferenceNo
ExternalAccountReferenceNo
String
String
15
50
Optional*
Optional*
Provided by Debitsuccess
Provided by Debitsuccess
Optional – allows requesting user to be
logged
Debitsuccess account reference
External account reference
*
At least one of the following parameters must be supplied: AccountReferenceNo,
ExternalAccountReferenceNo
Response Message
Name
Data Type
Description
DateCreated
Id
ResponseNotes ()
DateTime
String
Date/time message was processed
Unique ID for message
Collection of validation messages
 Code
 Note
 NoteType
Status
Audit Notes ()
 AccountReferenceNo
String
String
Enum
Enum
Collection
String
 ExternalAccountReferenceNo
String
 DateCreated
 Description
DateTime
String
14/12/16
Error, Warning, Info
Failed, Succeed, Unknown
Date of change
Description of change
33 of 80
Debitsuccess
Extended Web Services - API Reference Guide
GET AUDIT HISTORY FOR DATE RANGE
**
Not Currently Implemented **
Description
This method retrieves all audit records within a specified date range for the current user
Request Message
Name
Data Type
Length
Description
User
 Username
 Password
RequestInitiator
StartDate
EndDate
String
String
String
DateTime
DateTime
100
Required
Required
Optional
Required
Required
Provided by Debitsuccess
Provided by Debitsuccess
Optional – allows requesting user to be logged
Response Message
As per response message for GetAuditTrailByAccountID above
14/12/16
34 of 80
Debitsuccess
Extended Web Services - API Reference Guide
GET PAYMENT HISTORY BY ACCOUNT ID
Description
This method returns a list of payments related to the specified customer account ID
Request Message
Name
Data
Type
Length
Description
User
 Username
 Password
RequestInitiator
String
String
String
100
Required
Required
Optional
AccountReferenceNo
ExternalAccountReferenceNo
String
String
15
50
Optional*
Optional*
Provided by Debitsuccess
Provided by Debitsuccess
Optional – allows requesting user to be
logged
Debitsuccess account reference
External account reference
*
At least one of the following parameters must be supplied: AccountReferenceNo,
ExternalAccountReferenceNo
Response Message
Name
Data Type
Description
DateCreated
Id
ResponseNotes ()
DateTime
String
Date/time message was processed
Unique ID for message
Collection of validation messages
 Code
 Note
 NoteType
Status
Payments ()
String
String
Enum
Enum
Collection
String
String
Integer
DateTime
Decimal (10, 2)
String
Enum







AccountReferenceNo
ExternalAccountReferenceNo
BatchNumber
PaymentDate
PaymentAmount
Description
PaymentErrorCode
 PaymentCode
14/12/16
Enum
Error, Warning, Info
Failed, Succeed, Unknown
Description of payment
NoAuthority,
AccountClosed,
InsufficientFunds,
AuthorityStopped,
NoError,
InvalidAccount,
Declined,
CardExpired,
RestrictedCard,
LostOrStolenCard
Payment,
DebtCollectionPayment,
PaidAtBusiness,
OneOffPayment,
AccountTransfer,
35 of 80
Debitsuccess
Extended Web Services - API Reference Guide
 PaymentType
Enum
 PaymentId
 ExternalTransactionIdentifier
 ReversedPaymentId
Integer
String
Integer
Refund,
SuspensionFee,
CancellationFee
DebtCallFee**
EstablishmentFee**
MiscellaneousFee**
PenaltyFee**
Service**
TransferFee**
DirectDebit,
AutomaticPayment,
CreditCard,
BankImport,
Cash,
Cheque,
DebtCollection,
DirectCredit,
MoneyOrder,
PaidtoFacility,
TelephoneBanking,
Transfer,
Suspense,
EFTPOS,
ManualReceipting,
ReAllocation,
CreditCardOther,
CreditUnion
Unique identifier for the payment
A unique identifier for the transaction
Unique identifier for reversed payment
** These are Debitsuccess Fees and these values will only be returned by separate calls GET PAYMENT HISTORY WITH
FEES FOR DATE RANGE and GET PAYMENT HISTORY WITH FEES BY ACCOUNT ID. The request and the rest of the
response messages are exactly the same as GET PAYMENT HISTORY FOR DATE RANGE and GET PAYMENT HISTORY BY
ACCOUNT ID respectively.
14/12/16
36 of 80
Debitsuccess
Extended Web Services - API Reference Guide
GET PAYMENT HISTORY FOR DATE RANGE
Description
This method returns a list of payments between a specified date range for the current user
Request Message
Name
Data Type
Length
Description
User
 Username
 Password
RequestInitiator
String
String
String
StartDate
EndDate
DateTime
DateTime
100
Required
Required
Optional
Provided by Debitsuccess
Provided by Debitsuccess
Optional – allows requesting user to be
logged
Required
Required
Response Message
As per response message for GetPaymentHistoryByAccountID above
14/12/16
37 of 80
Debitsuccess
Extended Web Services - API Reference Guide
GET OVERDUE STATUS HISTORY FOR DATE RANGE
Description
Retrieve the details of overdue status or amount changes from the Debitsuccess billing system based within the
specified date range of one week.
Request Message
Name
User
 Username
 Password
RequestInitiator
StartDate
EndDate
Data Type
String
String
String
DateTime
DateTime?
Length
100
Description
Required
Required
Optional
Required
Optional
Provided by Debitsuccess
Provided by Debitsuccess
Optional – allows requesting user to be logged
Start of the report period
End of the report period
Response Message
Name
DateCreated
Id
ResponseNotes ()
 Code
 Note
 NoteType
Status
Data Type
Description
DateTime
String
Date/time message was processed
Unique ID for message
Collection of validation messages
String
String
Enum
Enum
Error, Warning, Info
Failed, Succeed, Unknown
OverdueStatusChanges ()

AccountReferenceNo
String
Debitsuccess Reference number

ExternalAccountReferenceNo
String
Your account identifier

FromOverdueStatus
Int
Previous Overdue Status value

FromOverdueStatusChangeDate
DateTime
Date that overdue status changed last

FromOverdueAmount
Decimal (10, 2)
Previous Overdue Amount

ToOverdueStatus
Int
New Overdue Status value

ToOverdueStatusChangeDate
DateTime
Date that overdue status changed

ToOverdueAmount
Decimal (10, 2)
Overdue Amount at time of overdue status
change
14/12/16
38 of 80
Debitsuccess
Extended Web Services - API Reference Guide
INITIATE REFUND
Description
Initiate a refund request for processing by Debitsuccess. An Order Number and Amount To Refund will be supplied as
parameters. The Amount to refund can be any value up to the total amount collected by Debitsuccess to date. There
will be a service fee charged for the refund.
Request Message
Name
Data Type
Length
Description
User
 Username
 Password
RequestInitiator
String
String
String
AccountReferenceNo
ExternalAccountReferenceNo
Amount
String
String
Decimal (10,
2)
String
Description
15
50
Optional*
Optional*
Required
Provided by Debitsuccess
Provided by Debitsuccess
Optional – allows requesting user to be
logged
Debitsuccess account reference
External account reference
Amount to refund
4000
Required
Reason for refund
100
Required
Required
Optional
*
At least one of the following parameters must be supplied: AccountReferenceNo,
ExternalAccountReferenceNo
Response Message
Name
Data Type
Description
DateCreated
Id
ResponseNotes ()
 Code
 Note
 NoteType
Status
RefundRequestNumber
DateTime
String
Date/time message was processed
Unique ID for message
Collection of validation messages
14/12/16
String
String
Enum
Enum
Integer
Error, Warning, Info
Failed, Succeed, Unknown
39 of 80
Debitsuccess
Extended Web Services - API Reference Guide
CREATE SCHEDULE
Description
Create a new recurring or one-off payment schedule for a customer
Request Message
Name
Data Type
Length
Description
User
 Username
 Password
RequestInitiator
String
String
String
100
Required
Required
Optional
AccountReferenceNo
ExternalAccountReferenceNo
NewPaySchedule
String
String
15
50
Optional*
Optional*
 Installment
Decimal (10, 2)
 PaymentFrequency
Enum
Required
 MinimumEffectiveDate
DateTime
Required
 Description
 EndDate
String
DateTime
Required
Must be >= $1
50
Optional
Optional
DeleteFutureSchedules
Boolean
Required
AdjustFutureSchedules
Boolean
Required
OverrideBillingCycleAlignment
Boolean
Optional
PreviousScheduleEndDate
DateTime
Required
14/12/16
Provided by Debitsuccess
Provided by Debitsuccess
Optional – allows requesting user to be
logged
Debitsuccess account reference
External account reference
OneOff, Weekly, Fortnightly, FourWeekly,
Monthly, BiMonthly, Quarterly
Not allowed: NotSpecified
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.
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.
true = this schedule replaces any later
schedules. Must be false for one-off
schedules.
**
Not Currently Implemented **
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.
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.
Use this to manually set the end date of the
40 of 80
Debitsuccess
Extended Web Services - API Reference Guide
**
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
schedule start date.
Previous schedule end date must be
provided when creating a schedule that will
not be aligned with the new schedule.
*
At least one of the following parameters must be supplied: AccountReferenceNo,
ExternalAccountReferenceNo
**
PreviousScheduleEndDate is required when OverrideBillingCycleAlignment is true.
Response Message
Name
Data Type
Description
DateCreated
Id
ResponseNotes ()
DateTime
String
Date/time message was processed
Unique ID for message
Collection of validation messages
 Code
 Note
 NoteType
Status
NewScheduleId
String
String
Enum
Enum
String*
*
14/12/16
Error, Warning, Info
Failed, Succeed, Unknown
Identifier for the new schedule.
Value will be integer.
41 of 80
Debitsuccess
Extended Web Services - API Reference Guide
DELETE PAY SCHEDULE
Description
Delete an existing future payment schedule.
Request Message
Name
Data
Type
Length
Description
User
 Username
 Password
RequestInitiator
String
String
String
AccountReferenceNo
ExternalAccountReferenceNo
PayScheduleId
String
String
Integer
100
15
50
Required
Required
Optional
Optional*
Optional*
Required
Provided by Debitsuccess
Provided by Debitsuccess
Optional – allows requesting user to be
logged
Debitsuccess account reference
External account reference
Schedule to delete
*
At least one of the following parameters must be supplied: AccountReferenceNo,
ExternalAccountReferenceNo
Response Message
Name
Data Type
Description
DateCreated
Id
ResponseNotes ()
DateTime
String
Date/time message was processed
Unique ID for message
Collection of validation messages
 Code
 Note
 NoteType
Status
String
String
Enum
Enum
14/12/16
Error, Warning, Info
Failed, Succeed, Unknown
42 of 80
Debitsuccess
Extended Web Services - API Reference Guide
DELETE PENALTY FEE SCHEDULE
Description
This method allows deletion of an unpaid penalty fee schedule on a customer’s account.
Request Message
Name
Data
Type
Length
Description
User
 Username
 Password
RequestInitiator
String
String
String
AccountReferenceNo
ExternalAccountReferenceNo
PayScheduleId
String
String
Integer
100
15
50
Required
Required
Optional
Optional*
Optional*
Required
Provided by Debitsuccess
Provided by Debitsuccess
Optional – allows requesting user to be
logged
Debitsuccess account reference
External account reference
ScheduleId** to delete
*
At least one of the following parameters must be supplied: AccountReferenceNo,
ExternalAccountReferenceNo
**
Obtained from Get Customer Account For Date Range or Get Customer Account By Account ID messages
Response Message
Name
Data Type
Description
DateCreated
Id
ResponseNotes ()
DateTime
String
Date/time message was processed
Unique ID for message
Collection of validation messages
 Code
 Note
 NoteType
Status
String
String
Enum
Enum
Error, Warning, Info
Failed, Succeed, Unknown
NOTE: The deleted fees will be charged back to the facility.
14/12/16
43 of 80
Debitsuccess
Extended Web Services - API Reference Guide
ADJUST ACCOUNT FIXED TERM
**
Not Currently Implemented **
Description
Change a customer’s account to fixed term from on-going. Once this change is made the account will be closed when
the total balance is collected.
Request Message
Name
Data
Type
Length
Description
User
 Username
 Password
RequestInitiator
AccountReferenceNo
ExternalAccountReferenceNo
String
String
String
String
String
100
15
50
Required
Required
Optional
Optional*
Optional*
Provided by Debitsuccess
Provided by Debitsuccess
Optional – allows requesting user to be logged
Debitsuccess account reference
External account reference
*
At least one of the following parameters must be supplied: AccountReferenceNo,
ExternalAccountReferenceNo
Response Message
Name
Data Type
Description
DateCreated
Id
ResponseNotes ()
DateTime
String
Date/time message was processed
Unique ID for message
Collection of validation messages
 Code
 Note
 NoteType
Status
String
String
Enum
Enum
14/12/16
Error, Warning, Info
Failed, Succeed, Unknown
44 of 80
Debitsuccess
Extended Web Services - API Reference Guide
ADJUST PAYMENT IN ADVANCE
**
Not Currently Implemented **
Description
Increase the amount a customer is paying and set the account to term (if it isn’t already) so that amount owed is paid
off sooner.
Request Message
Name
Data Type
Length
Description
User
 Username
 Password
RequestInitiator
String
String
String
AccountReferenceNo
ExternalAccountReferenceNo
IncreasedPaymentAmount
String
String
Decimal (10,
2)
DateTime
EndDate
100
15
50
Required
Required
Optional
Optional*
Optional*
Required
Provided by Debitsuccess
Provided by Debitsuccess
Optional – allows requesting user to
be logged
Debitsuccess account reference
External account reference
Date that payments should go back
to normal
*
At least one of the following parameters must be supplied: AccountReferenceNo,
ExternalAccountReferenceNo
Response Message
Name
Data Type
Description
DateCreated
Id
ResponseNotes ()
DateTime
String
Date/time message was processed
Unique ID for message
Collection of validation messages
 Code
 Note
 NoteType
Status
String
String
Enum
Enum
14/12/16
Error, Warning, Info
Failed, Succeed, Unknown
45 of 80
Debitsuccess
Extended Web Services - API Reference Guide
ADJUST ACCOUNT LAST ACCESS
Description
Record the date/time a customer last used your services (e.g. last accessed your online materials, attended a class or
visited your gym)
The main purpose of recording this information is to make it visible to call centre staff at Debitsuccess which can be
useful when dealing with a customer, especially in a credit control situation.
Request Message
Name
Data
Type
Length
Description
User
 Username
 Password
RequestInitiator
String
String
String
AccountReferenceNo
ExternalAccountReferenceNo
LastAccess
String
String
DateTime
100
15
50
Required
Required
Optional
Optional*
Optional*
Required
Provided by Debitsuccess
Provided by Debitsuccess
Optional – allows requesting user to
be logged
Debitsuccess account reference
External account reference
Date that customer last accessed your
services
*
At least one of the following parameters must be supplied: AccountReferenceNo,
ExternalAccountReferenceNo
Response Message
Name
Data Type
Description
DateCreated
Id
ResponseNotes ()
DateTime
String
Date/time message was processed
Unique ID for message
Collection of validation messages
 Code
 Note
 NoteType
Status
String
String
Enum
Enum
14/12/16
Error, Warning, Info
Failed, Succeed, Unknown
46 of 80
Debitsuccess
Extended Web Services - API Reference Guide
PROCESS REAL TIME CARD PAYMENT
This method attempts to process credit/debit card payment for the identified customer using the provided card
details. You can choose whether you want to create a one-off schedule for that payment or not. If a one-off schedule
creation is not opted for, then a successful payment collection will get assigned to the outstanding balance of the
customer’s account otherwise a new one-off schedule is created.
You also have the option to use a card stored on the customer’s account or make a payment using a different card. By
stored card we refer to the active pay method on the account and not just any card number stored on the account.
Note: this message should be used in conjunction with message GetCardPaymentStatusForCustomerAccount
Request message:
Name
User
 Username
 Password
RequestInitiator
AccountReferenceNo
ExternalAccountReferenceNo
UseStoredCardDetails
CreateOneoffCharge
Data Type
String
String
String
String
String
Boolean
Length
100
15
50
Boolean
AccountHolder
Amount
CVC
CardNumber
CreditCardType
String
Decimal(10,2)
String
String
Enum
ExpiryDate
Notes
DateTime
String
Description
Required
Required
Optional
Optional*
Optional*
Required
Required
50
4
35
Optional**
Required
Optional**
Optional**
Optional**
Optional**
Optional***
Provided by Debitsuccess
Provided by Debitsuccess
Optional – allows requesting user
to be logged
Debitsuccess Reference number
Your account identifier
false - if the customer's card details
including CVC is available with you
true - if the active, preferred card
details on the customer's account
needs to be used
true - DS will process a payment
and create a one-off schedule for
the same
false - PayNow will take a payment
and allocate it to account balance
Card holder name
Amount to pay
Card verification/security code
Credit/Debit card number
Credit/debit card type
AmericanExpress, Mastercard, Visa
Card expiry date
Any notes to be recorded against
the payment
* At least one of the following parameters must be supplied: AccountReferenceNo, ExternalAccountReferenceNo
** Required if CardPresentTransaction is set to true
*** Required if CreateOneoffCharge is set to true
14/12/16
47 of 80
Debitsuccess
Extended Web Services - API Reference Guide
Response message:
Name
Data Type
Description
DateCreated
Id
ResponseNotes ()
Code
Note
NoteType
Status
DateTime
String
Date/time message was processed
Unique ID for message
Collection of validation messages
String
String
Enum
Enum
Error, Warning, Info
Failed, Succeed, Unknown
Enum
NotSubmitted, Processing, ServiceBusy
ProcessRealTimeCardPayment()
TransactionStatus
14/12/16
48 of 80
Debitsuccess
Extended Web Services - API Reference Guide
PROCESS CARD PAYMENT FOR CUSTOMER ACCOUNT
**
Deprecated, see PROCESS REAL TIME CARD PAYMENT **
Description
Attempts to process credit/debit card payment for the identified customer using the provided card details. If
successful, the payment collected will get assigned to the outstanding balance of the customer’s account.
Note: this message should be used in conjunction with message GetCardPaymentStatusForCustomerAccount
Request Message
Name
Data Type
Length
Description
User
 Username
 Password
RequestInitiator
String
String
String
100
Required
Required
Optional
AccountReferenceNo
ExternalAccountReferenceNo
ExternalTransactionIdentifier
String
String
String
15
50
50
Optional*
Optional*
Required
AccountHolder
String
50
Required
Amount
CVC
Decimal (10,
2)
String
CardNumber
CreditCardType
String
Enum
ExpiryDate
Notes
DateTime
String
Required
Provided by Debitsuccess
Provided by Debitsuccess
Optional – allows requesting user to
be logged
Debitsuccess account reference
External account reference
A unique reference for the transaction
(for the requesting user)
Card account holder name. Maximum
length 50 characters
Amount to debit from the card
4
Required
Card verification/security code
35
Required
Required
Credit/debit card number
Credit/debit card type
AmericanExpress, Mastercard, Visa
Card expiry date
Any notes to be recorded against the
payment
40
Required
Optional
*
At least one of the following parameters must be supplied: AccountReferenceNo,
ExternalAccountReferenceNo
Response Message
Name
Data Type
Description
DateCreated
Id
ResponseNotes ()
DateTime
String
Date/time message was processed
Unique ID for message
Collection of validation messages
 Code
 Note
 NoteType
Status
TransactionStatus
String
String
Enum
Enum
Enum
14/12/16
Error, Warning, Info
Failed, Succeed, Unknown
NotSubmitted, Processing, ServiceBusy
49 of 80
Debitsuccess
Extended Web Services - API Reference Guide
PROCESS ONEOFF CARD PAYMENT FOR CUSTOMER ACCOUNT
**
Deprecated, see PROCESS REAL TIME CARD PAYMENT **
Description
Attempts to process credit/debit card payment for the identified customer using the provided card details and creates
a one-off schedule. This method will create a one-off schedule and associate all the amount paid to the new one-off
schedule if the payment has been successful.
This method will be useful if you are collecting a new charge for the account. For instance, if the customer purchases
an additional product then you can use this method.
Note: this message should be used in conjunction with message GetCardPaymentStatusForCustomerAccount
Request Message
Name
Data Type
Length
Description
User
 Username
 Password
RequestInitiator
String
String
String
100
Required
Required
Optional
AccountReferenceNo
ExternalAccountReferenceNo
ExternalTransactionIdentifier
String
String
String
15
50
50
Optional*
Optional*
Required
AccountHolder
String
50
Required
Amount
CVC
Decimal
(10,2)
String
CardNumber
CreditCardType
String
Enum
ExpiryDate
Notes
DateTime
String
Required
Provided by Debitsuccess
Provided by Debitsuccess
Optional – allows requesting user to
be logged
Debitsuccess account reference
External account reference
A unique reference for the transaction
(for the requesting user)
Card account holder name. Maximum
length 50 characters
Amount to debit from the card
4
Required
Card verification/security code
35
Required
Required
Credit/debit card number
Credit/debit card type
AmericanExpress, Mastercard, Visa
Card expiry date
Any notes to be recorded against the
payment
40
Required
Optional
*
At least one of the following parameters must be supplied: AccountReferenceNo,
ExternalAccountReferenceNo
14/12/16
50 of 80
Debitsuccess
Extended Web Services - API Reference Guide
Response Message
Name
Data Type
Description
DateCreated
Id
ResponseNotes ()
DateTime
String
Date/time message was processed
Unique ID for message
Collection of validation messages
 Code
 Note
 NoteType
Status
TransactionStatus
String
String
Enum
Enum
Enum
14/12/16
Error, Warning, Info
Failed, Succeed, Unknown
NotSubmitted, Processing, ServiceBusy
51 of 80
Debitsuccess
Extended Web Services - API Reference Guide
GET CARD PAYMENT STATUS FOR CUSTOMER ACCOUNT
Description
Returns the status of a card payment request previously submitted through the
ProcessCardPaymentForCustomerAccount
Request Message
Name
Data
Type
Length
Description
User
 Username
 Password
RequestInitiator
String
String
String
100
Required
Required
Optional
AccountReferenceNo
ExternalAccountReferenceNo
ExternalTransactionIdentifier
String
String
String
15
50
50
Optional*
Optional*
Required
Provided by Debitsuccess
Provided by Debitsuccess
Optional – allows requesting user to be
logged
Debitsuccess account reference
External account reference
A unique reference for the transaction
(for the requesting user)
*
At least one of the following parameters must be supplied: AccountReferenceNo,
ExternalAccountReferenceNo
Response Message
Name
Data Type
Description
DateCreated
Id
ResponseNotes ()
DateTime
String
Date/time message was processed
Unique ID for message
Collection of validation messages
 Code
 Note
 NoteType
Status
TransactionStatus
String
String
Enum
Enum
Enum
14/12/16
Error, Warning, Info
Failed, Succeed, Unknown
Processing, StatusRequired, Declined, Authorised,
Requires3ds
52 of 80
Debitsuccess
Extended Web Services - API Reference Guide
PAYMENT COLLECTED
Description
Records against the account a payment or refund that was processed directly by you e.g. cash paid at gym.
Request Message
Name
Data Type
Length
Description
User
 Username
 Password
RequestInitiator
String
String
String
AccountReferenceNo
ExternalAccountReferenceNo
Amount
15
50
DateOfPayment
String
String
Decimal (10,
2)
DateTime
Description
String
65535
Optional
ExternalTransactionIdentifier
String
50
Required
100
Required
Required
Optional
Optional*
Optional*
Required
Required
Provided by Debitsuccess
Provided by Debitsuccess
Optional – allows requesting user
to be logged
Debitsuccess account reference
External account reference
Amount of payment – pass
negative for a refund
Date/time the payment was
collected
A description of what the
transaction is for
A unique identifier for the
transaction
*
At least one of the following parameters must be supplied: AccountReferenceNo,
ExternalAccountReferenceNo
Response Message
Name
Data Type
Description
DateCreated
Id
ResponseNotes ()
DateTime
String
Date/time message was processed
Unique ID for message
Collection of validation messages
 Code
 Note
 NoteType
Status
String
String
Enum
Enum
14/12/16
Error, Warning, Info
Failed, Succeed, Unknown
53 of 80
Debitsuccess
Extended Web Services - API Reference Guide
ADJUST ACCOUNT START DATE
Description
Change the start date of an account. This cannot be called for an account that has already started.
Request Message
Name
Data
Type
Length
Description
User
 Username
 Password
RequestInitiator
String
String
String
AccountReferenceNo
ExternalAccountReferenceNo
NewStartDate
String
String
DateTime
100
15
50
Required
Required
Optional
Optional*
Optional*
Required
Provided by Debitsuccess
Provided by Debitsuccess
Optional – allows requesting user to
be logged
Debitsuccess account reference
External account reference
Date that the account should start
*
At least one of the following parameters must be supplied: AccountReferenceNo,
ExternalAccountReferenceNo
Response Message
Name
Data Type
Description
DateCreated
Id
ResponseNotes ()
DateTime
String
Date/time message was processed
Unique ID for message
Collection of validation messages
 Code
 Note
 NoteType
Status
String
String
Enum
Enum
14/12/16
Error, Warning, Info
Failed, Succeed, Unknown
54 of 80
Debitsuccess
Extended Web Services - API Reference Guide
ADJUST ACCOUNT PAYMENT METHOD
Description
Change the Method of Payment within the Debitsuccess Billing System by providing either new Bank Account or
Credit Card Details.
Request Message
Name
Data
Type
Length
Description
User
 Username
 Password
RequestInitiator
String
String
String
100
Required
Required
Optional
AccountReferenceNo
ExternalAccountReferenceNo
NewPayMethod
 AccountNo
 ExpiryDate
 AccountHolder
String
String
15
50
Optional*
Optional*
String
DateTime
String
35
Required
Optional**
Required
 AccountType
 CreditCardType
50
Enum
Enum
Required
Required
Provided by Debitsuccess
Provided by Debitsuccess
Optional – allows requesting user to
be logged
Debitsuccess account reference
External account reference
Bank account or credit card number
Expiry date of credit card
Bank account or credt card holder
name. Maximum length 50 characters
BankAccount, CreditCard
None, AmericanExpress, Mastercard,
Visa
*
At least one of the following parameters must be supplied: AccountReferenceNo,
ExternalAccountReferenceNo
**
Expiry date is required for credit cards
Response Message
Name
Data Type
Description
DateCreated
Id
ResponseNotes ()
DateTime
String
Date/time message was processed
Unique ID for message
Collection of validation messages
 Code
 Note
 NoteType
Status
String
String
Enum
Enum
14/12/16
Error, Warning, Info
Failed, Succeed, Unknown
55 of 80
Debitsuccess
Extended Web Services - API Reference Guide
ADJUST ACCOUNT NEXT PAYMENT DATE
Description
This web service method allows the Next Billing Date to be altered within the Debitsuccess Billing System. This will
override any existing Payment Schedule in terms of the next date of Payment. Payments owing will continue to accrue
based on payment schedules irrespective of a change to the Next Billing Date.
The next payment date must be within 1 week if it’s a weekly schedule and within 2 weeks for any other schedule
frequency.
Request Message
Name
Data Type
Length
Description
User
 Username
 Password
RequestInitiator
String
String
String
AccountReferenceNo
ExternalAccountReferenceNo
NextPaymentDate
String
String
DateTime
100
15
50
Required
Required
Optional
Optional*
Optional*
Required
Provided by Debitsuccess
Provided by Debitsuccess
Optional – allows requesting user to be
logged
Debitsuccess account reference
External account reference
New date of next payment. Date must
be greater than the current date
and/or account start date.
*
At least one of the following parameters must be supplied: AccountReferenceNo,
ExternalAccountReferenceNo
Response Message
Name
Data Type
Description
DateCreated
Id
ResponseNotes ()
DateTime
String
Date/time message was processed
Unique ID for message
Collection of validation messages
 Code
 Note
 NoteType
Status
String
String
Enum
Enum
14/12/16
Error, Warning, Info
Failed, Succeed, Unknown
56 of 80
Debitsuccess
Extended Web Services - API Reference Guide
ADJUST ACCOUNT EXTERNAL ACCOUNT REFERENCE NO
Description
Change the external account reference number for a given account. This cannot be null, empty strings or white space.
Request Message
Name
Data
Type
Length
Description
User
 Username
 Password
RequestInitiator
String
String
String
100
Required
Required
Optional
AccountReferenceNo
ExternalAccountReferenceNo
NewExternalAccountReferenceNo
String
String
String
15
50
50
Optional*
Optional*
Required
Provided by Debitsuccess
Provided by Debitsuccess
Optional – allows requesting user to
be logged
Debitsuccess account reference
External account reference
New external account reference
*
At least one of the following parameters must be supplied: AccountReferenceNo,
ExternalAccountReferenceNo
Response Message
Name
Data Type
Description
DateCreated
Id
ResponseNotes ()
DateTime
String
Date/time message was processed
Unique ID for message
Collection of validation messages
 Code
 Note
 NoteType
Status
String
String
Enum
Enum
14/12/16
Error, Warning, Info
Failed, Succeed, Unknown
57 of 80
Debitsuccess
Extended Web Services - API Reference Guide
ADJUST SUSPENSION END DATE
Description
Change the end date of an existing suspension to any date after the suspension start date when equal or larger than
today. If no value for the new end date is given, the suspension will change to an open ended suspension.
Request Message
Name
Data
Type
Length
Description
User
 Username
 Password
RequestInitiator
String
String
String
AccountReferenceNo
ExternalAccountReferenceNo
PayScheduleId
NewEndDate
String
String
Integer
DateTime
100
15
50
Required
Required
Optional
Optional*
Optional*
Required
Optional
Provided by Debitsuccess
Provided by Debitsuccess
Optional – allows requesting user to
be logged
Debitsuccess account reference
External account reference
Schedule Id of suspension
New end date of suspension
*
At least one of the following parameters must be supplied: AccountReferenceNo,
ExternalAccountReferenceNo
Response Message
Name
Data Type
Description
DateCreated
Id
ResponseNotes ()
DateTime
String
Date/time message was processed
Unique ID for message
Collection of validation messages
 Code
 Note
 NoteType
Status
String
String
Enum
Enum
14/12/16
Error, Warning, Info
Failed, Succeed, Unknown
58 of 80
Debitsuccess
Extended Web Services - API Reference Guide
GET FACILITY ACCOUNT CONFIGURATION
Description
Returns the fees and other settings for a given contract/facility account.
Request Message
Name
Data
Type
Length
Description
User
 Username
 Password
RequestInitiator
String
String
String
100
Required
Required
Optional
ContractPrefix
String
6
Required
Provided by Debitsuccess
Provided by Debitsuccess
Optional – allows requesting user to be
logged
Provided by Debitsuccess
Response Message
Name
Data Type
Description
DateCreated
Id
ResponseNotes ()
DateTime
String
Date/time message was processed
Unique ID for message
Collection of validation messages
 Code
 Note
 NoteType
Status
EstablishmentFeePayer
String
String
Enum
Enum
Enum
EstablishmentFeeAmount
EstablishmentFeePercent
DDCommissionType
Decimal (10, 2)
Decimal (10, 2)
Enum
DDCommissionRate
Decimal (10, 2)
CCCommissionType
Enum
CCCommissionRate
Decimal (10, 2)
COCommissionType
Enum
COCommissionRate
Decimal (10, 2)
14/12/16
Error, Warning, Info
Failed, Succeed, Unknown
Defines who pays the establishment fee:
1 Client pays
2 Facility pays
3 No establishment fee
Total amount of establishment fee
Percentage of establishment fee for facility
Defines if charged with a specific amount or
percentage per debit payment:
1 Fix amount per payment
2 Percentage of payment
Either fixed amount or percentage of debit payment
(depending on DDCommissionType)
Defines if charged with a specific amount or
percentage per credit card payment (MasterCard,
Visa, :
1 Fix amount per payment
2 Percentage of payment
Either fixed amount or percentage of credit card
payment (depending on CCCommissionType)
Defines if charged with a specific amount or
percentage per other credit card (Amex) payment:
1 Fix amount per payment
2 Percentage of payment
Either fixed amount or percentage of credit card
other payment (depending on COCommissionType)
59 of 80
Debitsuccess
Extended Web Services - API Reference Guide
ADJUST ACCOUNT APPEND NOTES
Description
This method allows clients to append notes to accounts within the Debitsuccess billing system.
The notes are actually prepended to the existing notes and are stored with markers in JSON format indicating the
start and end of the new note. The date that the note was amended is also recorded.
Example
/*
Title: This is the title
Date: 2015-05-01 11:00
Donec in venenatis tellus. Donec eu pharetra turpis. Donec pretium mollis tempus. Etiam ullamcorper aliquam erat,
sit amet dapibus justo efficitur a. Maecenas vel nulla ut nulla sollicitudin tempor. Ut erat nisi, bibendum mollis sapien
vitae, auctor facilisis sapien. Vivamus dictum est sed lorem sodales mollis. Sed lectus mi, lobortis eget pretium ut,
semper at magna. Nullam at neque sed nulla luctus interdum. Nulla facilisi. Aenean accumsan elit at quam aliquam,
egestas sollicitudin lectus vestibulum. Sed luctus odio at tellus dapibus, sed efficitur odio gravida.
*/
Request Message
Name
Data
Type
Length
Description
User
 Username
 Password
RequestInitiator
String
String
String
100
Required
Required
Optional
AccountReferenceNo
ExternalAccountReferenceNo
NoteTitle
Notes
String
String
String
String
15
50
100
10000
Optional*
Optional*
Optional*
Required
Provided by Debitsuccess
Provided by Debitsuccess
Optional – allows requesting user to be
logged
Debitsuccess account reference
External account reference
Optional title for note
Notes to be added to existing account notes
*
At least one of the following parameters must be supplied: AccountReferenceNo,
ExternalAccountReferenceNo
Response Message
Name
Data Type
Description
DateCreated
Id
ResponseNotes ()
 Code
 Note
 NoteType
Status
DateTime
String
Date/time message was processed
Unique ID for message
Collection of validation messages
14/12/16
String
String
Enum
Enum
Error, Warning, Info
Failed, Succeed, Unknown
60 of 80
Debitsuccess
Extended Web Services - API Reference Guide
GET PAYMENT TOKEN
Description
This method allows you to retrieve a token and a URL which allows you to redirect the customer to a form to either
capture new payment details (bank account or credit card) or process a real-time payment.
At the end of the operation, the user will be redirected to the call back URL provided in the request message and the
status of the operation will be returned as a URL parameter.
The token has a lifespan of 10 minutes. This will mean that the customer needs to access the payment form URL
within 10 minutes of the token being issued.
The token is for a one-time usage. Once the operation has started (link is clicked), it cannot be reused.
Note: We recommend that this message should be used in conjunction with message
GetCardPaymentStatusForCustomerAccount for confirmation of payment.
Request Message


Name
Data Type
User
Username
Password
RequestInitiator
AccountReferenceNo
ExternalAccountReferenceNo
PayMethodType
String
String
String
String
String
Enum
Description
Required
Required
Optional
Optional*
Optional*
Required
Provided by Debitsuccess
Provided by Debitsuccess
Optional – allows requesting user to be logged
Debitsuccess Reference number
Your account identifier
CreditCard - allows user to save CC details
BankAccount - allows user to save bank account
details
Amount
RequestType
CreateOneOffCharge
Decimal(10,2)
Enum
Boolean
PaymentNote
String
CallbackURL
String
Optional**
Required
Required
Optional
***
Required
Both - Allows user to save either bank account
or CC details
Amount to pay
RealTimePayment - Allows token to be used for
making a real time payment using CC and/or
save payment details
UpdatePaymentDetail - Allows token to be used
for adding payment details
true – If a payment is successful, a one-off
schedule will be created for the Amount
false – If the payment is successful, Amount will
be allocated to account balance
Any notes to be recorded against the payment
The URL the customer needs to be redirected to
after the operation
* At least one of the following parameters must be supplied: AccountReferenceNo, ExternalAccountReferenceNo
** Required if the request type is real time payment
*** Required if CreateOneoffCharge is set to true
14/12/16
61 of 80
Debitsuccess
Extended Web Services - API Reference Guide
Response message:
Name
Data
Type
Description
Maximum Length
DateCreated
DateTime
Id
ResponseNotes ()
String
Date/time message was
processed
Unique ID for message
Collection of validation
messages
 Code
 Note
 NoteType
Status
String
String
Enum
Enum
Error, Warning, Info
Failed, Succeed, Unknown
Token
String
Auto-generated token
8 characters
WebhookToken
String
Auto-generated webhook
token
8 characters
Datetime
String
Expiry date of token
URL where customer can
make payment or update
payment details. It will
have the token appended
GetPaymentToken()
ValidTo
PaymentFormURL
For each facility you can provide a Webhook URL which, after approval, we will store in our database. We will post the
transaction details to this Webhook URL once as a JSON object. The transaction details are the same as what we send
back for CallbackURL - the WebhookToken, AccountReferenceNo, ExternalAccountReferenceNo, Status and Message.
We recommend that you store the WebhookToken we provide in the response securely to authenticate the
information received through the WebhookURL is from Debitsuccess.
14/12/16
62 of 80
Debitsuccess
Extended Web Services - API Reference Guide
When a customer is redirected to the call back URL, the following response fields will be appended in the URL.
Scenario
Response Fields
Payment declined
Token,
AccountReferenceNo,
ExternalAccountReferenceNo,
Status,
Message
Payment successful
Payment failed
Account validation
failed
Token,
AccountReferenceNo,
ExternalAccountReferenceNo,
Status,
Message (blank)
Load of payment
details successful
Load of payment
details failed
Token expired
14/12/16
Token,
AccountReferenceNo (blank),
ExternalAccountReferenceNo
(blank),
Status,
Message (blank)
Status
Description
Example
http://www.debitsuccess.com/?Statu
s=Declined&amp;Token=QyqqjL0G&a
mp;AccountReferenceNo=TST488723
Declined
5&amp;ExternalAccountReferenceNo
=BMWHSHS888300&amp;Message=
DO%20NOT%20HONOUR
http://www.debitsuccess.com/?Statu
s=Success&amp;Token=TGhZfWjb&a
Success
mp;AccountReferenceNo=TST488860
8&amp;ExternalAccountReferenceNo
=BMWHSHS888300&amp;Message=
http://www.debitsuccess.com/?Statu
s=Error&amp;Token=56vNqgkE&amp;
Error
AccountReferenceNo=TST4888608&a
mp;ExternalAccountReferenceNo=BM
WHSHS888300&amp;Message=
http://www.debitsuccess.com/?Statu
s=AccountIsNotValid&amp;Token=YxL
J87En&amp;AccountReferenceNo=TS
AccountIsNotValid
T4888608&amp;ExternalAccountRefe
renceNo=BMWHSHS888300&amp;M
essage=
http://www.debitsuccess.com/?Statu
s=Success&amp;Token=4x2Mz9bG&a
Success
mp;AccountReferenceNo=TST488860
8&amp;ExternalAccountReferenceNo
=BMWHSHS888300&amp;Message=
http://www.debitsuccess.com/?Statu
s=Failure&amp;Token=3yFZiMrJ&amp
Failure
;AccountReferenceNo=TST4888608&
amp;ExternalAccountReferenceNo=B
MWHSHS888300&amp;Message=
TokenExpired
http://www.debitsuccess.com/?Statu
s=TokenExired&amp;Token=AsYMNsT
f&amp;AccountReferenceNo=&amp;E
xternalAccountReferenceNo=&amp;
Message=
63 of 80
Debitsuccess
Extended Web Services - API Reference Guide
GET CURRENT MONTH COLLECTIONS
Description
This method allows to retrieve the current month collections on a month-to-date basis based on individual facility
accounts.
Request Message
Name
Data Type
Length
Description
User

Username
String
Required
Provided by Debitsuccess

Password
String
Required
Provided by Debitsuccess
RequestInitiator
String
Optional
Optional – allows requesting user to be logged
100
Response message
Name
Data Type
Description
DateCreated
DateTime
Date/time message was processed
Id
String
Unique ID for message
ResponseNotes ()
Collection of validation messages
·
Code
String
·
Note
String
·
NoteType
Enum
Error, Warning, Info
Enum
Failed, Succeed, Unknown
FacilityName
String
Name of the facility
ContractPrefix
String
FacilityAccountDescription
String
CurrentMonthCollections
Decimal (10,2)
Status
GetCurrentMonthCollections()
14/12/16
The total collections for this month inclusive of
tax
64 of 80
Debitsuccess
Extended Web Services - API Reference Guide
STATES
For USA:
Alabama
Alaska
Arizona
Arkansas
California
Colorado
Connecticut
DistrictOfColumbia
Delaware
Florida
Georgia
Hawaii
Idaho
Illinois
Indiana
Iowa
Kansas
Kentucky
Louisiana
Maine
Maryland
Massachusetts
Michigan
Minnesota
Mississippi
Missouri
Montana
Nebraska
Nevada
NewHampshire
NewJersey
NewMexico
NewYork
NorthCarolina
NorthDakota
Ohio
Oklahoma
Oregan
Pennsylvania
RhodeIsland
SouthCarolina
SouthDakota
Tennessee
Texas
Utah
Vermont
Virginia
Washington
WestVirginia
Wisconsin
Wyoming
For Australia:








AustralianCapitalTerritory
NewSouthWales
NorthernTerritory
Queensland
SouthAustralia
Tasmania
Victoria
WesternAustralia
14/12/16
65 of 80
Debitsuccess
Extended Web Services - API Reference Guide
ERROR CODES
Code
Description
01
The server is not available
02
Invalid credentials provided
04
Account already exists (Duplicate accounts)
05
Request Time out
06
Unknown exception occurred during processing of this message
07
Multiple accounts found with this criteria
08
There is no record found with this criteria
09
Failed to complete the process
10
Account is not active
11
This option is currently not supported
100
SOAP message validation error
Missing value
12001
Missing ContractPrefix value
12002
Missing client first name
12003
Missing address parameter. Must provide either PhysicalAddress or BillingAddress or
both
12004
Missing or invalid PhysicalPostcode parameter
12005
Invalid Account.StartDate.The date must be in the future
12006
Missing PhysicalCity parameter
12007
Missing PhysicalSuburb parameter
12008
Missing or invalid BillingPostcode parameter
12009
Missing BillingCity parameter
12010
Missing BillingSuburb parameter
12011
Either Home, mobile or work phone number should be supplied
12012
Missing Schedule Instalment
12013
Missing AccountNo parameter
12014
Missing AccountHolder parameter
12015
Missing New PaySchedule request object
14/12/16
66 of 80
Debitsuccess
Extended Web Services - API Reference Guide
12016
Missing required reference number. Must provide either ExternalAccountReferenceNo
or AccountReferenceNo or both.
12017
Missing Description
12021
Missing PhysicalState parameter
12022
Missing BillingState parameter
12023
Missing phone number parameter
12024
Missing City parameter
12025
Missing Suburb parameter
12026
Missing or invalid Postcode parameter
12027
Missing Street parameter
12028
Missing State parameter
12029
Missing NewPaymethod parameter
12030
Missing NewExternalAccountReferenceNo parameter
12031
Missing NextPaymentDate parameter
12032
Missing PhysicalLocality parameter
12033
Missing BillingLocality parameter
12034
Missing Locality parameter
12035
Missing MobileNumber parameter
12036
Notes must not be empty
Invalid value
13001
Invalid Contract Prefix
13002
Invalid invoice/schedule start date
13003
Invalid Recurring schedule frequency
13004
Invalid value for Account’s Term
13005
Invalid credit card number
13006
Invalid ExpiryDate
13007
Invalid bank account number
13008
Invalid request. Cannot set AdjustFutureSchedules to true as the method or operation
is not implemented yet.
13009
Invalid MinimumEffectiveDate.The date must be in the future.
13010
Invalid request. Adjust & Delete future schedules cannot both be set to true.
14/12/16
67 of 80
Debitsuccess
Extended Web Services - API Reference Guide
13011
Invalid date. The StopPaymentsUntil date must be in the future
13012
Invalid Amount value
13013
Invalid account - Internal validation error, please contact Debitsuccess quoting the
message reference ID for more information
13014
Invalid Email Address
13015
Invalid account country – country differs from expected value
13016
Invalid address type
13017
Invalid Prefered – ClubWare cannot be set as preferred
13018
Invalid CVC number.
13019
AccountHolder cannot exceed 50 characters.
13020
Total value can only be fixed if the account is for a fixed term
13021
Total Value exceeds the maximum value based on the term, instalment and frequency
13022
Total Value is less than the minimum value based on the term, instalment and
frequency
13023
Date of birth is not valid
13024
Invalid Emergency Phone – Emergency name is required
13025
Invalid Home Phone STD
13026
Invalid Business Phone STD
13027
Invalid Emergency Phone STD
13028
Invalid Mobile Phone STD
13029
Invalid Phone STD
13030
Supplied current total value differs from held total value
13031
New total value may not be more than the current total value
13032
New total value may not be less than the amount already paid
13040
Refund amount exceeds amount that has been paid
13050
Future schedules exist and must be either adjusted or deleted
13051
Schedule end date is invalid for a recurring schedule with no subsequent schedules
14/12/16
68 of 80
Debitsuccess
Extended Web Services - API Reference Guide
13052
Schedule end date is invalid for a one-off schedule
13053
Adjust and delete future schedules are invalid when adding a one-off schedule
13054
Schedule end date must be on or after today
13055
Schedule end date must be before the next schedule start date
13056
Schedule end date cannot be before its start date
13057
Schedule end date must be provided when creating a schedule that will not be aligned
with the current schedules
13058
Schedule frequency ‘NotSpecified’ is not allowed.
13059
Installment must be $1 or more.
13060
Transaction identifier is not unique
13061
Card payment amount must be greater than or equal to $1 and less than your
configured maximum value
13062
Payment Notes cannot exceed 40 characters
13063
Transaction identifier is not valid
13064
3d secure authorisation response is required
13065
CVC number is required
13066
A transaction is being processed for this identifier
13067
Transaction identifier cannot be empty
13068
Diner cards are not supported
13070
Amount cannot be more than the outstanding balance.
13071
Date of payment required.
13072
Amount is more than the outstanding balance.
13080
Last Access date/time invalid – cannot be in the future or less than minimum value
13090
Start date must not be after end date
13091
New suspension overlaps with an existing suspension
13092
No payment schedule for suspension found
13093
Start date must not be in the past
14/12/16
69 of 80
Debitsuccess
Extended Web Services - API Reference Guide
13094
Frequency must be NotSpecified or OneOff when fee is 0.00
13095
Frequency must not be NotSpecified when fee is not 0.00
13096
Fee must not be smaller than 0.00
13097
Number of payment cycles must be at least 1
13100
New start date must not be in the past
13102
The new start date must not be more than 1 year in the future
13104
Account is already active
13110
Specified account cannot be copied
13120
NextPaymentDate must not be today or in the past
13121
NextPaymentDate must not be more than 7 days later than current payment date
13122
NextPaymentDate must not be more than 14 days later than current payment date
13123
NextPaymentDate must not be before the account start date
13131
PaySchedule for given PayScheduleId not found
13132
PaySchedule already started
13133
Cannot delete the only scheduled payment of the account.
13134
Cannot delete schedules of class Miscellaneous.
13135
Cannot delete scheduled payment with a gap between previous scheduled payment
13136
Cannot delete active scheduled payment with no subsequent scheduled payment
13141
Suspension for given PayScheduleId not found
13142
Suspension already finished
13143
Adjusted suspension is overlapping with existing one
13144
New suspension end date must not be before suspension start date
13145
New suspension end date must not be in the past
13150
No contract found for given contract prefix
13151
Multiple contracts found for given contract prefix
14/12/16
70 of 80
Debitsuccess
Extended Web Services - API Reference Guide
13152
Contract prefix must not be null, empty or white space
13170
No payment method found for the account. Please add one and try again
13200
Title field cannot be more than 10 characters long
13201
Account code field cannot be more than 50 characters long
13202
Account field contains unallowed characters
13300
Invalid BillingState - please refer to the API documentations for valid values
13301
Invalid PhysicalState - please refer to the API documentations for valid values
13302
Invalid State - please refer to the API documentations for valid values
Warnings
14001
StopPayment has already been set to true.
14002
The account is due to bill today and may still get billed if the payment processing is in
progress.
14003
Account should currently be DD Stopped (StopPayment should be true).
14004
The next billing date for the account has been set to the new schedule start date.
14005
Customer is a minor. Guarantor information should be provided to Debitsuccess.
14010
Suspension is not aligned with payment schedule and will result in pro rata payments
14011
Suspension end date is after the payment schedule finish date
14020
DateTime field contains time part, but the time is ignored by message.
14021
Decimal field contains more than 2 decimal points that were ignored by message
14022
Invalid amount
14030
WaiveEstFee is set, but facility pays admin fee. Waive flag ignored.
14031
WaiveEstFee is set, but facility has no admin fee. Waive flag ignored.
14032
Invalid date range – start date and end date must be within 7 days
14033
Invalid start date – start date must be less than end date
14/12/16
71 of 80
Debitsuccess
Extended Web Services - API Reference Guide
14034
RequestType is required
14035
PayMethodType is required
14036
Amount is required when RequestType is RealTimePayment
14037
Amount must be greater than one
14038
Real time payments can only be processed for Credit Cards. Please ensure
PayMethodType is CreditCard when RequestType is RealTimePayment
14039
Missing required CallBackUrl
14040
CallBackUrl cannot exceed 256 characters
14041
PaymentNote is required if CreateOneOffCharge is true
14042
PaymentNote cannot exceed 40 characters
14043
Invalid CallBackUrl - Ensure URL is correctly formatted. Example:
https://www.debitsuccess.com
14044
The Amount provided is more than the maximum amount allowed to pay for this
account. Please ensure amount is between <replaced with minimum amount> and
<replaced with amount allowed to pay>
14045
Amount cannot be more than the outstanding balance when account is set to fixed
term
14046
Invalid PaySchedule – you can only delete penalty fee schedule
14047
Cannot delete Penalty Fee that have already started
14051
No active payment method found for the account
14052
Real time payment cannot be processed for this account because the stored payment
method is not a credit card
14053
Card details should not be supplied when UseStoredCreditCard is true
14/12/16
72 of 80
Debitsuccess
Extended Web Services - API Reference Guide
Example Code
Following is an example of creating a RequestAccountCancellation, RequestRetrieveCallsByDateRange,
RequestRetrieveCallsByAccountID and RequestPostCustomerAccount objects in C#:
var requestAccountCancellation = new RequestAccountCancellation
{
User = new User
{
Username = @"ProvideUserNameByDS",
Password = @"ProvidedPasswordByDS"
},
RequestInitiator = @"UserWhoInitiateThisRequest",
AccountReferenceNo = @"DebitsuccessAccRef",
ExternalAccountReferenceNo = @"ExternalAccRef",
CancellationNote = @"Reason for cancellation",
Id = @"Message idenitifier"
};
var requestRetrieveCalls = new RequestRetrieveCallsByDateRange
{
User = new User
{
Username = @"ProvideUserNameByDS",
Password = @"ProvidedPasswordByDS"
},
RequestInitiator = @"UserWhoInitiateThisRequest",
StartDate = Convert.DateTime(@"Report Start date"),
EndDate = Convert.DateTime(@"Report to end date"),
Id = @"message idenitifier"
};
var requestRetrieveCallsForAccount = new RequestRetrieveCallsByAccountID
{
User = new User
{
Username = @"ProvideUserNameByDS",
Password = @"ProvidedPasswordByDS"
},
RequestInitiator = @"UserWhoInitiateThisRequest",
AccountReferenceNo = @"DebitsuccessAccRef",
ExternalAccountReferenceNo = @"ExternalAccRef",
Id = @"message idenitifier"
};
Please note the url end points are examples only please refer to the email with the credentials
sent through. This will contain the proper end points for testing.
For production end points please contact the account managers to arrange the creation and url
information when required.
14/12/16
73 of 80
Debitsuccess
Extended Web Services - API Reference Guide
var request = new RequestPostCustomerAccount();
request.User = request.User = new User() { Username = UserName.Text, Password =
Password.Text };
request.RequestInitiator = RequestInitiator.Text;
request.AccountCountry = (Country)System.Enum.Parse(typeof(Country),
AccountCountry.SelectedItem.ToString());
request.AccountHolder = AccountHolder.Text;
request.AccountNo = AccountNumber.Text;
request.AccountNotes = AccountNotes.Text;
request.AccountType = (AccountType)System.Enum.Parse(typeof(AccountType),
AccountType.SelectedItem.ToString());
request.RecurringScheduleDescription = RecurringDescription.Text;
request.RecurringScheduleFrequency = (Frequency)System.Enum.Parse(typeof(Frequency),
RecurringFrequency.SelectedItem.ToString());
request.RecurringScheduleInstalment = Convert.ToDecimal(RecurringInstalment.Text);
request.RecurringScheduleStartDate = RecurringStartDate.Value;
request.BillingAddress = BillingLine1.Text;
request.BillingCity = BillingCity.Text;
request.BillingCountry = (Country)System.Enum.Parse(typeof(Country),
BillingCountry.SelectedItem.ToString());
request.BillingPostcode = BillingPostcode.Text;
request.BillingState = (State)System.Enum.Parse(typeof(State),
BillingState.SelectedItem.ToString());
request.BillingSuburb = BillingSuburb.Text;
request.BusinessNumber = BusinessNumber.Text;
request.BusinessSTD = BusinessSTD.Text;
request.ContractPrefix = ContractPrefix.Text;
request.CreditCardType = (CreditCardType)System.Enum.Parse(typeof(CreditCardType),
CCType.SelectedItem.ToString());
request.DateOfBirth = DOB.Value;
request.EmailAddress = EmailAddress.Text;
request.EmergencyName = EmergencyName.Text;
request.EmergencyNumber = EmergencyNumber.Text;
request.EmergencySTD = EmergencySTD.Text;
request.ExpiryDate = ExpiryDate.Value;
request.ExternalAccountReferenceNo = ExtRef.Text;
request.FirstName = FirstName.Text;
request.FixedTerm = FixedTerm.Checked;
request.HomeNumber = HomeNumber.Text;
request.HomeSTD = HomeSTD.Text;
request.InitialOneOffScheduleDescription = OneOffDescription.Text;
request.InitialOneOffScheduleInstalment = Convert.ToDecimal(OneOffInstalment.Text);
request.InitialOneOffScheduleStartDate = OneOffStartDate.Value;
request.LastName = LastName.Text;
request.MiddleName = MiddleName.Text;
request.MobileNumber = MobileNumber.Text;
request.MobileSTD = MobileSTD.Text;
request.PhysicalAddress = PhysicalLine1.Text;
request.PhysicalCity = PhysicalCity.Text;
request.PhysicalCountry = (Country)System.Enum.Parse(typeof(Country),
PhysicalCountry.SelectedItem.ToString());
request.PhysicalPostcode = PhysicalPostcode.Text;
request.PhysicalState = (State)System.Enum.Parse(typeof(State),
PhysicalState.SelectedItem.ToString());
request.PhysicalSuburb = PhysicalSuburb.Text;
request.Gender = (Gender)System.Enum.Parse(typeof(Gender),
Gender.SelectedItem.ToString());
request.DateAccountStarted = AccountStartDate.Value;
request.Term = Convert.ToInt16(Term.Text);
request.TermType = (TermType)System.Enum.Parse(typeof(TermType),
TermType.SelectedItem.ToString());
request.Title = Title.Text;
request.FixTotalValue = FixedTotalValue.Checked;
request.TotalValue = Convert.ToDecimal(TotalValue.Text);
14/12/16
74 of 80
Debitsuccess
Extended Web Services - API Reference Guide
var client = new DSServicesClient("WSHttpBinding_DSServices");
var response = client.PostCustomerAccount(request);
Following is an example of creating a RequestAccountCancellation, RequestRetrieveCallsByDateRange,
RequestRetrieveCallsByAccountID and RequestPostCustomerAccount objects in PHP:
<?php
class User
{
public $Username;
public $Password;
}
class RequestAccountCancellation
{
public $Id;
public $User;
public $RequestInitiator;
public $AccountReferenceNo;
public $ExternalAccountReferenceNo;
public $CancellationNote;
}
class RequestRetrieveCallsByDateRange
{
public $Id;
public $User;
public $RequestInitiator;
public $StartDate;
public $EndDate;
}
class RequestRetrieveCallsByAccountID
{
public $Id;
public $User;
public $RequestInitiator;
public $AccountReferenceNo;
public $ExternalAccountReferenceNo;
}
class RequestPostCustomerAccount
{
public $Id;
public $User;
public $RequestInitiator;
public $AccountCountry;
public $AccountHolder;
public $AccountNo;
public $AccountNotes;
public $AccountType;
public $RecurringScheduleDescription;
public $RecurringScheduleFrequency;
public $RecurringScheduleInstalment;
public $RecurringScheduleStartDate;
public $BillingAddress;
public $BillingCity;
14/12/16
75 of 80
Debitsuccess
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
Extended Web Services - API Reference Guide
$BillingCountry;
$BillingPostcode;
$BillingState;
$BillingSuburb;
$BusinessNumber;
$BusinessSTD;
$ContractPrefix;
$CreditCardType;
$DateOfBirth;
$EmailAddress;
$EmergencyName;
$EmergencyNumber;
$EmergencySTD;
$ExpiryDate;
$ExternalAccountReferenceNo;
$FirstName;
$FixedTerm;
$HomeNumber;
$HomeSTD;
$InitialOneOffScheduleDescription;
$InitialOneOffScheduleInstalment;
$InitialOneOffScheduleStartDate;
$LastName;
$MiddleName;
$MobileNumber;
$MobileSTD;
$PhysicalAddress;
$PhysicalCity;
$PhysicalCountry;
$PhysicalPostcode;
$PhysicalState;
$PhysicalSuburb;
$Gender;
$DateAccountStarted;
$Term;
$TermType;
$Title;
$FixTotalValue;
$TotalValue;
}
$endpoint = 'https://testservices.debitsuccess.com/DSWebService/DSServices.svc?wsdl';
$user = new User();
$user->Username = "ProvideUserNameByDS";
$user->Password ="ProvidedPasswordByDS";
$request = new RequestAccountCancellation();
$request->Id = "Message idenitifier";
$request->User = $user;
$request->RequestInitiator = "UserWhoInitiateThisRequest";
$request->AccountReferenceNo = "DebitsuccessAccRef";
$request->ExternalAccountReferenceNo = "ExternalAccRef";
$request->CancellationNote = "Reason for cancellation";
try
{
$client = new SoapClient($endpoint);
14/12/16
76 of 80
Debitsuccess
Extended Web Services - API Reference Guide
$response = $client->CancelAccount(array("request"=>$request));
echo "<pre>";
print_r($response);
echo "</pre>";
}
catch (Exception $e)
{
print 'Caught exception: '.
}
$e->getMessage(). '\n';
//==============================================================================
$request = new RequestRetrieveCallsByDateRange();
$request->Id = "message idenitifier";
$request->User = $user;
$request->RequestInitiator = "UserWhoInitiateThisRequest";
$request->StartDate = "2012-01-01"; // date formatted YYYY-MM-DD
$request->EndDate = "2012-02-01"; // date formatted YYYY-MM-DD
try
{
$client = new SoapClient($endpoint);
$response = $client->GetCallsHistoryForDateRange(array("request"=>$request));
echo "<pre>";
print_r($response);
echo "</pre>";
}
catch (Exception $e)
{
print 'Caught exception: '.
}
$e->getMessage(). '\n';
//==============================================================================
$request = new RequestRetrieveCallsByAccountID();
$request->Id = "message idenitifier";
$request->User = $user;
$request->RequestInitiator = "UserWhoInitiateThisRequest";
$request->AccountReferenceNo = "DebitsuccessAccRef";
$request->ExternalAccountReferenceNo = "ExternalAccRef";
try
{
$client = new SoapClient($endpoint);
$response = $client->GetCallsHistoryByAccountID(array("request"=>$request));
echo "<pre>";
print_r($response);
echo "</pre>";
}
catch (Exception $e)
{
print 'Caught exception: '.
}
14/12/16
$e->getMessage(). '\n';
77 of 80
Debitsuccess
Extended Web Services - API Reference Guide
//==============================================================================
$request = new RequestPostCustomerAccount();
$request->User = $user;
$request->RequestInitiator = "UserWhoInitiateThisRequest";
$request->AccountCountry = "NewZealand"; // NewZealand / Australia /
UnitedStaetsOfAmerica
$request->AccountHolder = "AccountHolderName";
$request->AccountNo = "AccountNumber";
$request->AccountNotes = "AccountNotes";
$request->AccountType = "BankAccount"; // BankAccount or CreditCard
$request->RecurringScheduleDescription = "RecurringDescription";
$request->RecurringScheduleFrequency = "Weekly"; // Weekly, Fortnightly, FourWeekly,
Monthly, BiMonthly or Quarterly
$request->RecurringScheduleInstalment = 10.00;
$request->RecurringScheduleStartDate = "2012-01-02"; // date formatted YYYY-MM-DD
$request->BillingAddress = "BillingLine1";
$request->BillingCity = "BillingCity";
$request->BillingCountry = "NewZealand"; // NewZealand / Australia /
UnitedStaetsOfAmerica
$request->BillingPostcode = "BillingPostcode";
$request->BillingState = "NotSpecified"; // See table
$request->BillingSuburb = "BillingSuburb";
$request->BusinessNumber = "BusinessNumber";
$request->BusinessSTD = "BusinessSTD";
$request->ContractPrefix = "ContractPrefix";
$request->CreditCardType = "CreditCardType";
$request->DateOfBirth = "1912-01-01"; // date formatted YYYY-MM-DD
$request->EmailAddress = "EmailAddress";
$request->EmergencyName = "EmergencyName";
$request->EmergencyNumber = "EmergencyNumber";
$request->EmergencySTD = "EmergencySTD";
$request->ExpiryDate = "2012-11-01"; // date formatted YYYY-MM-DD
$request->ExternalAccountReferenceNo = "ExternalAccountReferenceNo";
$request->FirstName = "FirstName";
$request->FixedTerm = false; // true/false
$request->HomeNumber = "HomeNumber";
$request->HomeSTD = "HomeSTD";
$request->InitialOneOffScheduleDescription = "OneOffDescription";
$request->InitialOneOffScheduleInstalment = 25.00;
$request->InitialOneOffScheduleStartDate = "OneOffStartDate";
$request->LastName = "LastName";
$request->MiddleName = "MiddleName";
$request->MobileNumber = "MobileNumber";
$request->MobileSTD = "MobileSTD";
$request->PhysicalAddress = "PhysicalLine1";
$request->PhysicalCity = "PhysicalCity";
$request->PhysicalCountry = "NewZealand"; // NewZealand / Australia /
UnitedStaetsOfAmerica
$request->PhysicalPostcode = "PhysicalPostcode";
$request->PhysicalState = "NotSpecified"; // See table
$request->PhysicalSuburb = "PhysicalSuburb";
$request->Gender = "Female"; // Unknown, Female or Male
$request->DateAccountStarted = "2012-01-01"; // date formatted YYYY-MM-DD
$request->Term = 10;
$request->TermType = "Months"; // Months or Payments
$request->Title = "Title";
$request->FixTotalValue = false; // true/false
14/12/16
78 of 80
Debitsuccess
Extended Web Services - API Reference Guide
$request->TotalValue = 0.00; // only relevant when FixTotalValue is true
try
{
$client = new SoapClient($endpoint);
$response = $client->PostCustomerAccount(array("request"=>$request));
echo "<pre>";
print_r($response);
echo "</pre>";
}
catch (Exception $e)
{
print 'Caught exception: '.
}
$e->getMessage(). '\n';
?>
Client Configuration File
Following is an example of the Debitsuccess web services client configuration file in .net C#:
<system.serviceModel>
<bindings>
<wsHttpBinding>
<binding name="WSHttpBinding_DSServices" closeTimeout="00:01:00"
openTimeout="00:01:00" receiveTimeout="00:10:00" sendTimeout="00:01:00"
bypassProxyOnLocal="false" transactionFlow="false"
hostNameComparisonMode="StrongWildcard"
maxBufferPoolSize="2147483647" maxReceivedMessageSize="2147483647"
messageEncoding="Mtom" textEncoding="utf-8" useDefaultWebProxy="true"
allowCookies="false">
<readerQuotas maxDepth="2147483647" maxStringContentLength="2147483647"
maxArrayLength="2147483647"
maxBytesPerRead="2147483647" maxNameTableCharCount="2147483647" />
<reliableSession ordered="true" inactivityTimeout="00:10:00"
enabled="false" />
<security mode="None">
<transport clientCredentialType="Windows" proxyCredentialType="None"
realm="" />
<message clientCredentialType="Windows" negotiateServiceCredential="true"
/>
</security>
</binding>
</wsHttpBinding>
</bindings>
<client>
<endpoint address="https://testservices.debitsuccess.com/DSWebService/DSServices.svc"
binding="wsHttpBinding" bindingConfiguration="WSHttpBinding_DSServices"
contract="DSServices.DSServices" name="WSHttpBinding_DSServices" />
</client>
</system.serviceModel>
14/12/16
79 of 80