POST api/account/account

Create new trading account

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
NominatedBankAccounts	Nominated bank accounts. The list of funding nominated bank accounts for an account.	Collection of NominatedBankAccount	None.
CashAccounts	Cash accounts. The list of funding available bank accounts for an account.	Collection of BankAccount	None.
InternationalBankAccounts	The list of funding international bank accounts for an account.	Collection of InternationalBankAccount	None.
DirectEntryAccount	Direct Entry account	DirectEntryAccount	None.
ClientType	Client type	enClientType	Required
AdvisorID	Advisor ID	integer	None.
RegistrationType	Client registration type.	enRegistrationType	Required
BrokerRegistration	Broker registration details required for Broker Sponsored registration type	BrokerRegistration	None.
ThirdPartyRegistration	Third party registration details required for Third Party Sponsored registration type	ThirdPartyRegistrationDetails	None.
IssuerSponsoredRegistration	Issuer sponsored registration details	IssuerSponsoredRegistration	None.
ClientPersons	Person details	Collection of ClientPersonLink	None.
ClientCompanys	Company details	ClientCompanyDetails	None.
ClientTrust	Trust details	ClientTrustDetails	None.
ClientSuper	Superannuation details	ClientSuperDetails	None.
ClientMinor	Minor details	ClientMinorDetails	None.
CompanyRegisteredAddress	Company registered address	AddressDetails	None.
CompanyPostalAddress	Company postal address	AddressDetails	None.
ContractNoteEmails	Contract note emails	Collection of ContractNoteEmail	None.
ContractNoteAddresses	Contract note addresses	Collection of ContractNoteAddress	None.
BrokerageTemplateReference	Brokerage template external reference. Reference which maps to TPP Brokerage Template	string	None.
CustomData	Custom data. Can be used to insert things like PortfolioFrequency, StatementFrequency. Example PortfolioFrequency - Key: PortfolioFrequency Value: 7	Dictionary of string [key] and string [value]	None.
ExternalRef	External reference	string	None.
ApplicationMoney	Allow application money to be charged and collected on rights purchase by client	boolean	None.
HoldFundsInTrust	Holds funds in trust	boolean	None.
DirectDebitDailyLimit	Cap on direct debit request	decimal number	None.
DirectDebitLineByLineSettlement	Direct Debit Line By Line Settlement	boolean	None.
SettlementInstructions	Free text to include on an account : BO Instructions	string	None.
ClientName	Client Name	string	None.
GSTScheduleRef	GST Schedule Ref	string	None.
InstitutionalDetails	Institutional Details	InstitutionalDetails	None.
ClientGroups	Client groups. Can be used to group clients like DemographicValue, DemographicClass, AccountTypes. Example AccountType - 2184 [Account Type\|ASSET\|ASSET MANAGER]	Collection of integer	None.
InvestorType	Investor Type	enInvestorType	None.
ACHRegistration	ACH Registration details	ACHRegistration	None.
FATCACRS	Details of foreign tax residences for company and trust accounts	TIN	None.
LodgementReference	Direct debit entry reference value	string	String length: inclusive between 0 and 18
PostalAddress	Postal address for the account. This will be displayed on contract PDFs and other statements. If not provided, will use address on principal contact / custodian / company address	AddressDetails	None.

Request Formats

application/json, text/json

Sample:

{
  "NominatedBankAccounts": [
    {
      "AccountName": "Account Name",
      "Bsb": "013986",
      "AccountNumber": "12345678",
      "AllowBuyFunding": true,
      "AllowSellFunding": true,
      "IsBuyFundingDefault": true,
      "IsSellFundingDefault": true,
      "IsETOFundingDefault": true,
      "IsDividendDefault": true
    }
  ],
  "CashAccounts": [
    {
      "AccountName": "Account Name",
      "Bsb": "182740",
      "AccountNumber": "12345678",
      "AllowBuyFunding": true,
      "AllowSellFunding": true,
      "IsBuyFundingDefault": true,
      "IsSellFundingDefault": true,
      "IsETOFundingDefault": true,
      "IsDividendDefault": false
    }
  ],
  "InternationalBankAccounts": [
    {
      "AccountNumber": "DE1234XXYYZZ9999999",
      "InternationalBankAccountID": 0,
      "InternationalBankName": "Intl Bank Name",
      "InternationalBankAddress": {
        "Address1": "Intl Bank Address 1",
        "Address2": "Intl Bank Address 2",
        "Address3": "Intl Bank Address 3",
        "Address4": "",
        "Suburb": "",
        "State": "",
        "Postcode": "12445",
        "Country": "GERMANY"
      },
      "BeneficiaryName": "Beneficiary Name",
      "BeneficiaryAddress": {
        "Address1": "Beneficiary Address 1",
        "Address2": "Beneficiary Address 2",
        "Address3": "Beneficiary Address 3",
        "Address4": "",
        "Suburb": "",
        "State": "",
        "Postcode": "12445",
        "Country": "GERMANY"
      },
      "CountryCode": "DEU",
      "SWIFTCode": "",
      "CurrencyCode": "EUR",
      "FeesBorneBy": 1,
      "AllowBuyFunding": false,
      "AllowSellFunding": false,
      "IsBuyFundingDefault": false,
      "IsSellFundingDefault": false,
      "IsDividendDefault": false,
      "IsETODefault": false,
      "IsFundsTransferDefault": true
    }
  ],
  "DirectEntryAccount": {
    "AccountName": null,
    "Bsb": null,
    "AccountNumber": null,
    "AllowBuyFunding": true,
    "AllowSellFunding": true,
    "IsBuyFundingDefault": true,
    "IsSellFundingDefault": true,
    "IsETOFundingDefault": false,
    "IsDividendDefault": false
  },
  "ClientType": 1,
  "AdvisorID": 10000,
  "RegistrationType": 1,
  "BrokerRegistration": {
    "RegistrationAddress": {
      "RegAddress1": "Mr John Smith",
      "RegAddress2": "79 COLLINGWOOD STREET",
      "RegAddress3": "OSBORNE PARK WA",
      "RegAddress4": "",
      "RegAddress5": "",
      "RegAddress6": "6017"
    },
    "HINTransfer": {
      "BrokerID": "123",
      "HIN": "12345678"
    },
    "SendBankAdvice": null,
    "ResidencyIndicatorType": 1
  },
  "ThirdPartyRegistration": {
    "PID": 1234,
    "FacilityID": "11111",
    "ContactName": "Third Party Test",
    "ContactNumber": "0112345778"
  },
  "IssuerSponsoredRegistration": {
    "RegistrationAddress": {
      "RegAddress1": "Mr John Smith",
      "RegAddress2": "79 COLLINGWOOD STREET",
      "RegAddress3": "OSBORNE PARK WA",
      "RegAddress4": "",
      "RegAddress5": "",
      "RegAddress6": "                     6017"
    }
  },
  "ClientPersons": [
    {
      "PersonID": 10001,
      "AccessType": 1,
      "IsPrincipal": true,
      "OwnershipType": 1,
      "ClientRelationshipTypes": [
        1,
        3
      ],
      "CompanyRelationshipTypes": [
        2,
        1
      ]
    }
  ],
  "ClientCompanys": {
    "CompanyName": "CLEARING PTE LTD",
    "TFN": "862793498",
    "ABN": "50673789893",
    "ACN": "120964034"
  },
  "ClientTrust": {
    "TrustType": 1,
    "Designation": "CLEAR TRUST ACCOUNT",
    "CompanyName": "CLEARING PTE LTD",
    "TFN": "862793498",
    "ABN": "50673789893",
    "ACN": "120964034"
  },
  "ClientSuper": {
    "SuperType": 1,
    "Designation": "CLEAR SUPERANNUATION FUND",
    "CompanyName": "CLEARING PTE LTD",
    "TFN": "862793498",
    "ABN": "50673789893",
    "ACN": "120964034"
  },
  "ClientMinor": {
    "MinorType": 1,
    "Designation": "CLEAR MINOR ACCOUNT",
    "CompanyName": "CLEARING PTE LTD",
    "TFN": "862793498",
    "ABN": "50673789893",
    "ACN": "120964034",
    "Salutation": 1,
    "FirstName": "John",
    "LastName": "Smith",
    "DOB": "1980-01-01T00:00:00"
  },
  "CompanyRegisteredAddress": {
    "Address1": "CLEARING PTE LTD,",
    "Address2": "LEVEL 20",
    "Address3": "GOVERNOR PHILIP TOWER",
    "Address4": "1 FARRER PLACE",
    "Suburb": "SYDNEY",
    "State": "NSW",
    "Postcode": "2000",
    "Country": "AUSTRALIA"
  },
  "CompanyPostalAddress": {
    "Address1": "CLEARING PTE LTD,",
    "Address2": "LEVEL 20",
    "Address3": "GOVERNOR PHILIP TOWER",
    "Address4": "1 FARRER PLACE",
    "Suburb": "SYDNEY",
    "State": "NSW",
    "Postcode": "2000",
    "Country": "AUSTRALIA"
  },
  "ContractNoteEmails": [
    {
      "EmailAddress": "testemail@testemail.com"
    }
  ],
  "ContractNoteAddresses": [
    {
      "Salutation": 1,
      "Firstname": "John",
      "Middlename": "David",
      "Lastname": "Smith",
      "PostalAddress": {
        "Address1": "TPP PTY LTD,",
        "Address2": "LEVEL 20",
        "Address3": "GOVERNOR PHILIP TOWER",
        "Address4": "1 FARRER PLACE",
        "Suburb": "SYDNEY",
        "State": "NSW",
        "Postcode": "2000",
        "Country": "AUSTRALIA"
      }
    }
  ],
  "BrokerageTemplateReference": "BPBRO",
  "CustomData": {
    "PortfolioFrequency": "1",
    "StatementFrequency": "1",
    "FundingSource": "ADB"
  },
  "ExternalRef": "BP101",
  "ApplicationMoney": false,
  "HoldFundsInTrust": false,
  "DirectDebitDailyLimit": null,
  "DirectDebitLineByLineSettlement": true,
  "SettlementInstructions": null,
  "ClientName": "CLEARING PTE LTD",
  "GSTScheduleRef": null,
  "InstitutionalDetails": null,
  "ClientGroups": [
    2184,
    2185
  ],
  "InvestorType": 1,
  "ACHRegistration": {
    "AccID": "ACH100500"
  },
  "FATCACRS": {
    "FATCACountryDetails": [
      {
        "Country": "MYS",
        "TIN": null,
        "TINExemption": 1
      },
      {
        "Country": "HKG",
        "TIN": "456789",
        "TINExemption": null
      }
    ],
    "TaxStatus": 3,
    "GIIN": "789101",
    "FATCACRSStatus": 1
  },
  "LodgementReference": "BP1000",
  "PostalAddress": {
    "Address1": "123 DOWN STREET",
    "Address2": "WILLOW LANE",
    "Address3": "",
    "Address4": "",
    "Suburb": "LOWTOWN",
    "State": "WA",
    "Postcode": "12445",
    "Country": "AUSTRALIA"
  }
}

application/xml

Sample:

An exception has occurred while using the formatter 'System.Net.Http.Formatting.XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: Enum value '1' is invalid for type 'TPP.Utilities.enPersonSalutation' and cannot be serialized. Ensure that the necessary enum values are present and are marked with EnumMemberAttribute attribute if the type has DataContractAttribute attribute.

text/xml

Sample:

An exception has occurred while using the formatter 'System.Net.Http.Formatting.XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: Enum value '1' is invalid for type 'TPP.Utilities.enPersonSalutation' and cannot be serialized. Ensure that the necessary enum values are present and are marked with EnumMemberAttribute attribute if the type has DataContractAttribute attribute.

Response Information

Resource Description

AccountCreationResult

Name	Description	Type	Additional information
ClientID	An identifier of new created client	integer	None.
ClientName	Name of newly created client	string	None.

Response Formats

application/json, text/json

Sample:

{
  "ClientID": 100500,
  "ClientName": "John Depp"
}

application/xml, text/xml

Sample:

<AccountCreationResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.Contracts.Services.Account">
  <ClientID>100500</ClientID>
  <ClientName>John Depp</ClientName>
</AccountCreationResult>

Error Response Information

Resource Description

string

Error Response Formats

application/json, text/json

Sample:

"sample string 1"

application/xml, text/xml

Sample:

<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>