PostCustomerAccount

Usage

Allows customer and account details to be loaded into the Debitsuccess system for billing. This call can also be used to create B2B (business) type accounts.

Notes:

If the parameters in the Customer Details section are passed without MiddleName, LastName, and Title, the account will be considered as a Business account. Use the FirstName parameter for the name of the business.
If an account is created using PostCustomerAccount to start on a non-working day, the customer will be billed on the next working day.

Parameters

Name	Data Type	Length		Description
Name	Data Type	Length		Description
User
· Username	String		Required	Provided by Debitsuccess
· Password	String		Required	Provided by Debitsuccess
RequestInitiator	String	100	Optional	Optional – allows requesting user to be logged
ContractPrefix	String	6	Required	Provided by Debitsuccess (allows customer accounts to be split into different organisational groups if required)
Customer Details
FirstName	String	40	Required	Maximum length 40 characters
MiddleName	String	40	Optional
LastName	String	40	Optional	Maximum length 40 characters
Title	String	10	Optional
DateOfBirth	DateTime
Gender	Enum		Optional	Male, Female, Unknown
Account Details
DateAccountStarted	DateTime		Required	Account Start Date (date establishment fee will be taken if applicable)
Term	Int		Required	Minimum term in months or payments
TermType	Enum		Required	Months, Payments
AccountCode	String	50	Optional	Maximum 50 characters. Allowed characters are a-zA-Z0-9_-
AccountNotes	String	10000	Optional	Free form notes field. Maximum length of 10000 characters
ExternalAccountReferenceNo	String	50	Optional	Your account identifier
FixedTerm	Bool		Required	true – account will be closed at the end of the minimum term false – account will continue to bill after the minimum term
AccountCountry	Enum		Required	Australia, NewZealand, UnitedStatesOfAmerica
FixTotalValue	Bool		Required	false – the total value of the account will be calculated based on the value of the recurring schedule and the term true – the total value of the account will be set to the value passed in the TotalValue property
TotalValue	Decimal (10, 2)		Required if FixTotalValue is true	Total value of recurring payments to be collected for account, For Term Value 'Payments', the value cannot exceed the number of payments in the term ^* the instalment and must be greater than (the number of payments in the term-1) ^* the instalment For Term Value 'Months', the value cannot exceed the number of payments in the term * the instalment and must be greater than 1 * the instalment. If 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 account's term is 12 payments and the weekly recurring schedule has an instalment of $100 then 1100 <Total value <= 1200 e.g. if the account term is 2 months and the weekly recurring schedule has an instalment of $100 then 100 < Total value <= 900
WaiveEstFee	Bool		Optional	Can be used to override the establishment fee payer in case it is set to client by default and should be waived so that the facility pays the establishment fee.
AccountTemplate	Guid		Optional	OMG contract template unique-identifier
Payment Method Details
AccountNo	String	35	Required	Bank account number (preceded by BSB for Australia), Credit card number. No spaces, dashes or any other non-alphanumeric character should be entered into the AccountNo property.
ExpiryDate	DateTime		Required if credit card	Credit card expiry date
AccountHolder	String	50	Required	Name of account, card holder. Maximum length of 50 characters
AccountType	Enum		Required	BankAccount, CreditCard
CreditCardType	Enum		Required	None, AmericanExpress, Mastercard, Visa
Payment Details
InitialOneOffScheduleStartDate	DateTime		Required if One off instalment > 0	Date initial one-off payment should be taken on. The account can be billed on the day of submission as long as the call is made before the Debitsuccess cut-off time. If the day of submission is provided after the cut-off time, this date will be set to the next available working date.
InitialOneOffScheduleInstalment	Decimal (10, 2)		Optional^*	Amount of initial one-off payment
InitialOneOffScheduleDescription	String	50	Optional	Optional description of the one-off payment
InitialScheduleExternalIdentifier	Varchar	50	Optional	Use this if you require an additional reference number to be associated with the schedule itself. For example: If you wish to test that all schedules are unique and are generating your own reference number.
RecurringScheduleStartDate	DateTime		Required if recurring instalment > 0	Regular payment start date
RecurringScheduleInstalment	Decimal (10, 2)		Optional^*	Regular payment amount
RecurringScheduleFrequency	Enum		Required if recurring instalment > 0	Weekly, Fortnightly, FourWeekly, Monthly, BiMonthly, Quarterly (Note: OneOff frequency is part of the enumeration but is not valid for a recurring schedule)
RecurringScheduleDescription	String	50	Optional	Optional description of regular payment
RecurringScheduleExternalIdentifier				Use this if you require an additional reference number to be associated with the schedule itself. For example: If you wish to test that all schedules are unique and are generating your own reference number.
Address Details
PhysicalAddress	String	60	Optional^****	Physical Address line 1. Maximum length of 60 characters
PhysicalLocality	String	50	Optional^*****	Physical Address line 2
PhysicalSuburb	String	50	Required (Australia)	Maximum length of 50 characters
PhysicalCity	String	50	Required (NZ, USA)	Maximum length of 50 characters
PhysicalState	State		Required (Australia, USA)	State Codes
PhysicalCountry	Enum		Required	NotSpecified, Australia, NewZealand, UnitedStatesOfAmerica
PhysicalPostcode	String	10	Required	Maximum length of 10 characters
BillingAddress	String	60	Optional^****	Billing Address line 1
BillingLocality	String	50	Optional^*****	Billing Address line 2
BillingSuburb	String	50	Required for Australia if Billing Address line 1 is supplied
BillingCity	String	50	Required for NZ and UnitedStatesOfAmerica If Billing Address line 1 is supplied
BillingState	Enum		Required for Australia and UnitedStatesOfAmerica if Billing Address line 1 is supplied	State Codes
BillingCountry	Enum		Required if Billing Address line 1 is supplied	NotSpecified, Australia, NewZealand, UnitedStatesOfAmerica
BillingPostcode	String	10	Required if Billing Address line 1 is supplied
Other Contact Details
EmailAddress	String	75	Required	Email Address. Maximum length of 75 characters
HomeNumber	String	75	Optional^**	Home phone number. Maximum length of 75 characters. Allowed characters: `alphanumeric # + - ( ) * _ [space] , ; : . /`
HomeCountryCode	Enum		Optional^**	NotSpecified, Aus, NZ, USA
HomeSTD	String	10	Optional^**	Home STD Code. Maximum length of 4 characters
BusinessNumber	String	75	Optional^**	Business phone number. Maximum length 75 characters. Allowed characters: `alphanumeric # + - ( ) * _ [space] , ; : . /`
BusinessCountryCode	Enum		Optional^**	NotSpecified, Aus, NZ, USA
BusinessSTD	String	10	Optional^**	Business STD Code. Maximum length of 4 characters
EmergencyNumber	String	75	Optional	Emergency phone number. Allowed characters: `alphanumeric # + - ( ) * _ [space] , ; : . /`
EmergencyCountryCode	Enum		Optional^**	NotSpecified, Aus, NZ, USA
EmergencySTD	String	10	Optional	Emergency STD Code
EmergencyName	String	50	Optional^***	Emergency contact name
MobileNumber	String	75	Optional^**	Mobile phone number. Maximum length of 75 characters. Allowed characters: `alphanumeric # + - ( ) * _ [space] , ; : . /`
MobileCountryCode	Enum		Optional^**	NotSpecified, Aus, NZ, USA
MobileSTD	String	10	Optional^**	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. If multiple contacts are provided, the priority for the preferred contact is below:}

_Type	_{Priority (1 = highest priority)}
_MobileNumber	₁
_HomeNumber	₂
_WorkNumber	₃
_{EmergencyNumber}	₄

_{*** Required if the emergency number is supplied}

_{**** At Least one address detail (Physical, Billing) must be supplied}

_{***** Mandatory for Hong Kong addresses}

_{Note: If both addresses are provided, the Billing address will be the preferred contact address}

Response

Name	Data Type	Description
DateCreated	DateTime	Date/time message was processed
Id	String	Unique ID for the message
AccountReferenceNo	String	Debitsuccess account reference
ExternalAccountReferenceNo	String	External account reference
ResponseNotes ()		Collection of validation messages
Code	String
Note	String
NoteType	Enum	Error, Warning, Info
Status	Enum	Failed, Succeed, Unknown

Error Messages

Type	Error Code	Error Message
Error	11	Timeout/Deadlock Error - Please retry
Warning	14020	DateTime field '{0}' contains time part, but the time is ignored by message.
Warning	14021	Decimal field '{0}' contains more than 2 decimal points that were ignored by message.
Error	14115	The selected payment method is not supported by this business.
Error	13068	Diner cards are not supported.
Error	12002	Missing client first name
Error	13014	Invalid Email Address
Error	12011	Either Home, mobile or work phone number should be supplied
Error	12035	Missing MobileNumber parameter
Error	13200	Title field cannot be more than 10 characters long.
Error	13201	Account code field cannot be more than 50 characters long.
Error	13202	Account code field contains unallowed characters.
Error	13203	<Field name> field cannot be more than <maxlength> characters.
Error	13204	<Field name> field contains unallowed characters.
Error	13023	Date of birth is not valid
Warning	14005	Customer is a minor. Guarantor information should be provided to Debitsuccess.
Error	13024	Invalid Emergency Phone - Emergency name is required
Error	13025	Invalid Home Phone STD
Error	13028	Invalid Mobile Phone STD
Error	13026	Invalid Business Phone STD
Error	13027	Invalid Emergency Phone STD
Error	12003	Missing address parameter. Must provide either PhysicalAddress or BillingAddress or both.
Error	12004	Missing or invalid PhysicalPostcode parameter
Error	13301	Invalid PhysicalState - please refer to the API documentations for valid values.
Error	12006	Missing PhysicalCity parameter
Error	12007	Missing PhysicalSuburb parameter
Error	12032	Missing PhysicalLocality parameter
Error	12021	Missing PhysicalState parameter
Error	12008	Missing or invalid BillingPostcode parameter
Error	13300	Invalid BillingState - please refer to the API documentations for valid values.
Error	12009	Missing BillingCity parameter
Error	12010	Missing BillingSuburb parameter
Error	12033	Missing BillingLocality parameter
Error	12022	Missing BillingState parameter
Error	14205	Invalid Home Phone Invalid Business Phone Invalid Emergency Phone Invalid Mobile Phone

Related Pages

Page:

Create a customer account for an ongoing gym membership

On this page:

REST API

POST Customer

POST Account

POST Account Payment

POST Schedule (Recurring) ~ optional

POST Schedule (One-off) ~ optional