Accounts

Download Spec

Get User Accounts

get /users/{tpp_user_id}/accounts

Accessible to TPP companies.

Retrieve the list of accounts available for a given user

API Key ApiKey

X-API-Key found in header

tpp_user_id

string

required

page

integer

Default
0

size

integer

Default
50

Response

Examples Schema

Successful Response

{
  "items": [
    {
      "description": "string",
      "external_key": "string",
      "id": "string",
      "name": "string"
    }
  ],
  "page": null,
  "size": 123,
  "total": null
}

Not found

Empty response

Validation Error

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

items

array[object (TppUserAccount)]

required

TppUserAccount

object (TppUserAccount)

TppUserAccountRequest

description

string

external_key

string

id

string

required

name

string

required

page

integer

required

size

int

required

total

integer

required

No schema

detail

array[object (ValidationError)]

ValidationError

object (ValidationError)

loc

array[Any Of]

required

Any Of

string

int

msg

string

required

type

string

required

Create User Account

post /users/{tpp_user_id}/accounts

API Key ApiKey

X-API-Key found in header

tpp_user_id

string

required

description

string

external_key

string

name

string

required

Request

{
  "description": "string",
  "external_key": "string",
  "name": "string"
}

Response

Examples Schema

Successful Response

{
  "description": "string",
  "external_key": "string",
  "id": "string",
  "name": "string"
}

Not found

Empty response

Validation Error

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

description

string

external_key

string

id

string

required

name

string

required

No schema

detail

array[object (ValidationError)]

ValidationError

object (ValidationError)

loc

array[Any Of]

required

Any Of

string

int

msg

string

required

type

string

required

Get User Account

get /users/{tpp_user_id}/accounts/{tpp_user_account_id}

Accessible to TPP companies.

Retrieve the details of an account.

API Key ApiKey

X-API-Key found in header

tpp_user_id

string

required

tpp_user_account_id

string

required

Response

Examples Schema

Successful Response

{
  "description": "string",
  "external_key": "string",
  "id": "string",
  "name": "string"
}

Not found

Empty response

Validation Error

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

description

string

external_key

string

id

string

required

name

string

required

No schema

detail

array[object (ValidationError)]

ValidationError

object (ValidationError)

loc

array[Any Of]

required

Any Of

string

int

msg

string

required

type

string

required

Update User Account

post /users/{tpp_user_id}/accounts/{tpp_user_account_id}

API Key ApiKey

X-API-Key found in header

tpp_user_id

string

required

tpp_user_account_id

string

required

description

string

external_key

string

name

string

required

Request

{
  "description": "string",
  "external_key": "string",
  "name": "string"
}

Response

Examples Schema

Successful Response

{
  "description": "string",
  "external_key": "string",
  "id": "string",
  "name": "string"
}

Not found

Empty response

Validation Error

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

description

string

external_key

string

id

string

required

name

string

required

No schema

detail

array[object (ValidationError)]

ValidationError

object (ValidationError)

loc

array[Any Of]

required

Any Of

string

int

msg

string

required

type

string

required

Get Latest Account Balance

get /users/{tpp_user_id}/accounts/{tpp_user_account_id}/current_balance

Accessible to TPP companies.

Retrieve the latest available balance of an TPP user account.

API Key ApiKey

X-API-Key found in header

tpp_user_account_id

string

required

Response

Examples Schema

Successful Response

{
  "amount": 123,
  "currency": null,
  "id": "string"
}

Not found

Empty response

Validation Error

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

amount

int

required

currency

required

List of available currencies in ISO 4217 https://en.wikipedia.org/wiki/ISO_4217

id

string

required

No schema

detail

array[object (ValidationError)]

ValidationError

object (ValidationError)

loc

array[Any Of]

required

Any Of

string

int

msg

string

required

type

string

required

Get Account Balances

get /users/{tpp_user_id}/accounts/{tpp_user_account_id}/balances

List all the historical balances for a given account

API Key ApiKey

X-API-Key found in header

tpp_user_account_id

string

required

page

integer

Default
0

size

integer

Default
50

Response

Examples Schema

Successful Response

{
  "items": [
    {
      "amount": 123,
      "currency": null,
      "id": "string"
    }
  ],
  "page": null,
  "size": 123,
  "total": null
}

Not found

Empty response

Validation Error

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

items

array[object (TppUserAccountBalance)]

required

TppUserAccountBalance

object (TppUserAccountBalance)

TppUserAccountRequest

amount

int

required

currency

required

List of available currencies in ISO 4217 https://en.wikipedia.org/wiki/ISO_4217

id

string

required

page

integer

required

size

int

required

total

integer

required

No schema

detail

array[object (ValidationError)]

ValidationError

object (ValidationError)

loc

array[Any Of]

required

Any Of

string

int

msg

string

required

type

string

required

Create Account Balance

post /users/{tpp_user_id}/accounts/{tpp_user_account_id}/balances

Create a new balance entry for an account

API Key ApiKey

X-API-Key found in header

tpp_user_account_id

string

required

amount

int

required

currency

required

List of available currencies in ISO 4217 https://en.wikipedia.org/wiki/ISO_4217

Request

{
  "amount": 123,
  "currency": null
}

Response

Examples Schema

Successful Response

{
  "amount": 123,
  "currency": null,
  "id": "string"
}

Not found

Empty response

Validation Error

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

amount

int

required

currency

required

List of available currencies in ISO 4217 https://en.wikipedia.org/wiki/ISO_4217

id

string

required

No schema

detail

array[object (ValidationError)]

ValidationError

object (ValidationError)

loc

array[Any Of]

required

Any Of

string

int

msg

string

required

type

string

required

Was this page helpful?