Create new account

POST 
/accounts

Create a new Account representation of an existing bank account.

Request

application/json

Body

required

Account details

account

object

required

oneOf

account.SharedSavingsPostRequest

type stringrequired

Possible values: [SharedSavings]

externalId string

Optional, external reference for this account. When provided, this field will help in preventing duplicate accounts.

userId stringrequired

balanceCents account.BalanceCents (integer)

Default value: 0

The total worth of all assets, in cents or the smallest currency subunit.

account.PerformancePostRequest

type stringrequired

Possible values: [Performance]

externalId string

(Optional) external reference for this account.

userId stringrequired

balanceCents account.BalanceCents (integer)

Default value: 0

The total worth of all assets, in cents or the smallest currency subunit.

liquidBalanceCents account.LiquidBalanceCents (integer)

Default value: 0

The amount of liquid cash available for withdrawal or internal transfer, in cents or the smallest currency subunit.

performanceCents account.PerformanceCents (integer)

Default value: 0

The value gained since valuationFrom, in cents or the smallest currency subunit.

performancePercent account.PerformancePercent (number)

Default value: 0

The relative value gained since valuationFrom, in percent.

totalAcquisitionCostCents account.TotalAcquisitionCostCents (integer)

Default value: 0

The total acquisition cost of the assets on the account, in cents or the smallest currency subunit.

valuationFrom RFC3339

The date time performance indicators are calculated from.

valuationAt RFC3339

Default value: Time of last update

The date time of market valuation for the assets on the account.

Responses

200

The created Account representation.

application/json

Schema

Schema

account

object

oneOf

account.SharedSavings

type stringrequired

Possible values: [SharedSavings]

id uuidrequired

externalId string

Optional, external reference for this account.

user

object

required

type stringrequired

id stringrequired

externalId string

balanceCents account.BalanceCents (integer)

Default value: 0

The total worth of all assets, in cents or the smallest currency subunit.

account.Performance

type stringrequired

Possible values: [Performance]

id uuidrequired

externalId string

Optional, external reference for this account.

user

object

required

type stringrequired

id stringrequired

externalId string

balanceCents account.BalanceCents (integer)

Default value: 0

The total worth of all assets, in cents or the smallest currency subunit.

liquidBalanceCents account.LiquidBalanceCents (integer)

Default value: 0

The amount of liquid cash available for withdrawal or internal transfer, in cents or the smallest currency subunit.

performanceCents account.PerformanceCents (integer)

Default value: 0

The value gained since valuationFrom, in cents or the smallest currency subunit.

performancePercent account.PerformancePercent (number)

Default value: 0

The relative value gained since valuationFrom, in percent.

totalAcquisitionCostCents account.TotalAcquisitionCostCents (integer)

Default value: 0

The total acquisition cost of the assets on the account, in cents or the smallest currency subunit.

valuationFrom RFC3339

The date time performance indicators are calculated from.

valuationAt RFC3339

Default value: Time of last update

The date time of market valuation for the assets on the account.

Example (from schema)

{
  "account": {
    "type": "SharedSavings",
    "id": "7edd1904-2e55-463a-a359-458d7832af7e",
    "externalId": "GB77BARC20201530093459",
    "user": {
      "type": "user",
      "id": "31566c16-c5c4-4ea2-9ec9-4708a2edec2e",
      "externalId": "10002345"
    },
    "balanceCents": 123456
  }
}

400

Bad request.

application/json

Schema

Schema

errors

object[]

required

Array [

field stringrequired

errors string[]required

]

Example (from schema)

{
  "errors": [
    {
      "field": "string",
      "errors": [
        "string"
      ]
    }
  ]
}

Example

{
  "errors": [
    {
      "field": "account.type",
      "errors": [
        "is invalid. Allowed values are `SharedSavings` | `Performance`."
      ]
    },
    {
      "field": "account.balanceCents",
      "errors": [
        "can't be negative"
      ]
    },
    {
      "field": "account.liquidBalanceCents",
      "errors": [
        "can't be negative"
      ]
    }
  ]
}

409

Conflict.

application/json

Schema

Schema

errors

object[]

required

Array [

field stringrequired

errors string[]required

]

Example (from schema)

{
  "errors": [
    {
      "field": "string",
      "errors": [
        "string"
      ]
    }
  ]
}

Example

{
  "errors": [
    {
      "field": "account.userId",
      "errors": [
        "has already been taken."
      ]
    }
  ]
}

Loading...