Accounts

Get User Accounts

get /users/{tpp_user_id}/accounts

Accessible to TPP companies.

Retrieve the list of accounts available for a given user

page

int

Default: 0

size

int

Default: 50

Response

ExamplesSchema

Successful Response

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

Create User Account

post /users/{tpp_user_id}/accounts

name

string

required

description

string

external_key

string

Request

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

Response

ExamplesSchema

Successful Response

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

Get User Account

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

Accessible to TPP companies.

Retrieve the details of an account.

tpp_user_id

string

required

tpp_user_account_id

string

required

Response

ExamplesSchema

Successful Response

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

Update User Account

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

name

string

required

description

string

external_key

string

Request

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

Response

ExamplesSchema

Successful Response

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

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.

tpp_user_account_id

string

required

Response

ExamplesSchema

Successful Response

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

Get Account Balances

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

List all the historical balances for a given account

page

int

Default: 0

size

int

Default: 50

Response

ExamplesSchema

Successful Response

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

Create Account Balance

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

Create a new balance entry for an account

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

ExamplesSchema

Successful Response

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