POST api/account/create

Create account for groupId provided Processes this account API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

None.

Body Parameters

The set client sub account data contract supplied with the request.

SetClientSubAccountDataContract
NameDescriptionTypeAdditional information
Name

The name value.

string

None.

AccountNumber

The account number value.

string

None.

SortCode

The sort code value.

string

None.

BIC

The bic value.

string

None.

IBAN

The iban value.

string

None.

CountryCode

The country code value.

string

None.

BankType

The bank type value.

string

None.

GroupId

The unique identifier of the related group resource.

integer

None.

IsMemo

Indicates whether this item is memo.

boolean

None.

IsLandlord

Indicates whether this item is landlord.

boolean

None.

IsTenant

Indicates whether this item is tenant.

boolean

None.

IsCompany

Indicates whether this item is company.

boolean

None.

UpdateRoleTypes

Indicates whether update role types is true.

boolean

None.

Id

The unique identifier of this resource.

integer

None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:
{
  "Name": "sample string 1",
  "AccountNumber": "sample string 2",
  "SortCode": "sample string 3",
  "BIC": "sample string 4",
  "IBAN": "sample string 5",
  "CountryCode": "sample string 6",
  "BankType": "sample string 7",
  "GroupId": 1,
  "IsMemo": true,
  "IsLandlord": true,
  "IsTenant": true,
  "IsCompany": true,
  "UpdateRoleTypes": true,
  "Id": 10
}

Response Information

Resource Description

The response returned after the operation completes.

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.