Accounts

get/users/{tpp_user_id}/accounts

Get User Accounts

Accessible to TPP companies.

Retrieve the list of accounts available for a given user

pageint

Default: 0

sizeint

Default: 50

Responses

Response examples

Successful Response

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

post/users/{tpp_user_id}/accounts

Create User Account

namestring

required

descriptionstring

external_keystring

Responses

Request examples

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

Response examples

Successful Response

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

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

Get User Account

Accessible to TPP companies.

Retrieve the details of an account.

tpp_user_idstring

required

tpp_user_account_idstring

required

Responses

Response examples

Successful Response

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

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

Update User Account

namestring

required

descriptionstring

external_keystring

Responses

Request examples

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

Response examples

Successful Response

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

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

Get Latest Account Balance

Accessible to TPP companies.

Retrieve the latest available balance of an TPP user account.

tpp_user_account_idstring

required

Responses

Response examples

Successful Response

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

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

Get Account Balances

List all the historical balances for a given account

pageint

Default: 0

sizeint

Default: 50

Responses

Response examples

Successful Response

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

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

Create Account Balance

Create a new balance entry for an account

amountint

required

currency

required

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

Responses

Request examples

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

Response examples

Successful Response

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