/users/{tpp_user_id}/accounts
Accessible to TPP
companies.
Retrieve the list of accounts available for a given user
page
int
size
int
Successful Response
{
"items": [
{
"name": "string",
"description": "string",
"external_key": "string",
"id": "string"
}
],
"total": 123,
"page": 123,
"size": 123
}
/users/{tpp_user_id}/accounts
name
string
required
description
string
external_key
string
{
"name": "string",
"description": "string",
"external_key": "string"
}
Successful Response
{
"name": "string",
"description": "string",
"external_key": "string",
"id": "string"
}
/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
Successful Response
{
"name": "string",
"description": "string",
"external_key": "string",
"id": "string"
}
/users/{tpp_user_id}/accounts/{tpp_user_account_id}
name
string
required
description
string
external_key
string
{
"name": "string",
"description": "string",
"external_key": "string"
}
Successful Response
{
"name": "string",
"description": "string",
"external_key": "string",
"id": "string"
}
/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
Successful Response
{
"amount": 123,
"currency": null,
"id": "string"
}
/users/{tpp_user_id}/accounts/{tpp_user_account_id}/balances
List all the historical balances for a given account
page
int
size
int
Successful Response
{
"items": [
{
"amount": 123,
"currency": null,
"id": "string"
}
],
"total": 123,
"page": 123,
"size": 123
}
/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
{
"amount": 123,
"currency": null
}
Successful Response
{
"amount": 123,
"currency": null,
"id": "string"
}
Was this page helpful?