Skip to end of metadata
Go to start of metadata

Register PROD

Allows registration of a new organisation (single).

A valid Channel Code is required and can be obtained from ClickSuper.

(warning) Pre-Register Actions Required

Before calling the Register method, the user must be presented with the following web page:

PRODUCTION: https://clickstream.p.vu/register/initiate?channelCode=AAAAAA&abn=BBBBBBBBBBB&name=CCCCCC&uiHandling=D&returnUrl=EEEE

BETA: https://betastream.p.vu/register/initiate?channelCode=AAAAAA&abn=BBBBBBBBBBB&name=CCCCCC&uiHandling=D&returnUrl=EEEE

Where:

AAAAAA is the channel code

BBBBBBBBBBB is the ABN of the company to be registered and must match the ABN in the Register API method call

CCCCCC is the name of the company

D is an optional field which can be one of:

UI HandlingMeaning
0Default. Shows with a layout page and a success page
1Shows without a layout page (no styling) and shows a success page. Used for embedded into an existing webpage, not for a new window
2Shows with a layout page and will redirect to EEEE when successful
3Shows without a layout page (no styling) and will redirect to EEEE when successful. Used for embedded into an existing webpage, not for a new window

EEEE is the return url is successful (only used when D is 2 or 3

This page will display the PDS and pricing information which the user must accept before calling the Register method.

The user has 3 hours before they will need to re-accept the PDS.

Parameters

NameDescriptionTypeOptionalLengthValid Characters
Organisation.ChannelCodeChannel Code provided by ClickSuperstringN a-z A-Z 0-9
Organisation.ApplicationSystemSystem being registered in, set to "ClickSuper"enumN ClickSuper / PaymentAdviser
Organisation.ABNABN of the organisation being registeredstringN110-9
Organisation.CompanyNameBusiness name of the organisation being registeredstringN200 
Organisation.BranchNameOnly required if you have more than one bank account you wish to pay superannuation fromstringY15 
Organisation.NotificationEmailThe email account we notify about whether the file upload was a success or failurestringN250 
Organisation.ContributionResponseEmailThe email account we notify about Contribution Responses received from Super FundsstringN250 
Organisation.ReturnsEmailThe email account we notify about Returns received from Super FundsstringN250 
Organisation.AddressLine1Company address line 1stringY40 
Organisation.AddressLine2Company address line 2stringY40 
Organisation.SuburbCompany suburbstringY27 
Organisation.StateCompany statestringY3 
Organisation.PostcodeCompany postcodestringY40-9
Organisation.CountryCompany countrystringY50 
Organisation.EnableFileUploadDuplicationWarningEnable file duplication warning for uploads with the same amount in 24 hoursboolY  
Organisation.DebitIntervalNumber of days to delay the debit when auto-scheduling the paymentintY  
Organisation.AutoAcceptUiWhether to auto-accept uploads made via the UIboolY  
Organisation.AutoAcceptApiWhether to auto-accept uploads made via the APIboolY  
Organisation.AutoScheduleWhether to auto-schedule the paymentsboolY  
Organisation.CommencementDateDate when you'll be using the servicedateY  
BankAccount.AccountNameThe account we debit requests from and credit returns/refunds tostringN32 
BankAccount.BSBThe account we debit requests from and credit returns/refunds tostringN60-9
BankAccount.AccountNumberThe account we debit requests from and credit returns/refunds tostringN90-9
BillingBankAccount.AccountNameThe account we debit invoice payments fromstringY32 
BillingBankAccount.BSBThe account we debit invoice payments fromstringY60-9
BillingBankAccount.AccountNumberThe account we debit invoice payments fromstringY90-9
BillingContact.FirstNameThe invoice contact first namestringY40 
BillingContact.LastNameThe invoice contact last namestringY40 
BillingContact.EmailThe email account we send invoices tostringY250 
BillingContact.ContactNumberThe invoice contact phone numberstringY180-9
SystemAdministrator.FirstNameThe System Administrator First Name we notify of changes to the company registration/office holder detailsstringN40 
SystemAdministrator.LastNameThe System Administrator Last Name we notify of changes to the company registration/office holder detailsstringN40 
SystemAdministrator.EmailThe System Administrator Email Address we notify of changes to the company registration/office holder detailsstringN250 
SystemAdministrator.PasswordThe System Administrator Password we notify of changes to the company registration/office holder detailsstringN  
SystemAdministrator.ContactNumberThe System Administrator Contact Number we notify of changes to the company registration/office holder detailsstringN180-9
OfficeHolder.FirstNameThe Office Holder First Name as listed on the ASIC report per ABNstringY40 
OfficeHolder.LastNameThe Office Holder Last Name as listed on the ASIC report per ABNstringY40 
OfficeHolder.EmailThe Office Holder Email AddressstringY250 
OfficeHolder.ContactNumberThe Office Holder Contact NumberstringY180-9
OfficeHolder.AddressLine1The Office Holder Address Line 1stringY40 
OfficeHolder.AddressLine2The Office Holder Address Line 2stringY40 
OfficeHolder.SuburbThe Office Holder SuburbstringY27 
OfficeHolder.StateThe Office Holder StatestringY3 
OfficeHolder.PostcodeThe Office Holder PostcodestringY40-9
OfficeHolder.DateOfBirthThe Office Holder Date of BirthdateY  
DefaultFunds.DefaultFund.ABN The ABN of the Default fundstringY110-9
DefaultFunds.DefaultFund.USIThe USI of the Default fundstringY14A-Z 0-9
DefaultFunds.DefaultFund.NameThe Fund Name of the Default fundstringY200 

Response

See Standard Responses and Errors, in addition the following may be returned when successful:

Name

DescriptionTypeLength
ApiUsernameThe username for future API callsstring100
ApiPasswordThe password for future API callsstring100

Errors

NumberDescriptionResolution Action
ORG-IV-80006PDS not approvedThe user must accept the PDS before calling Register
ORG-IV-80016Organisation or Branch already existsThe requested ABN/Branch combination already exists
ORG-IV-80026Channel not foundThe provided channel was not correct

 

Example

TDB

 

  • No labels