Accounts
Download SpecGet User Accounts
Accessible to TPP
companies.
Retrieve the list of accounts available for a given user
ApiKey
tpp_user_id
string
required
page
integer
- Default
- 0
size
integer
- Default
- 50
Response
Successful Response
Not found
Empty response
Validation Error
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
ApiKey
tpp_user_id
string
required
description
string
external_key
string
name
string
required
Request
Response
Successful Response
Not found
Empty response
Validation Error
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
Accessible to TPP
companies.
Retrieve the details of an account.
ApiKey
tpp_user_id
string
required
tpp_user_account_id
string
required
Response
Successful Response
Not found
Empty response
Validation Error
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
ApiKey
tpp_user_id
string
required
tpp_user_account_id
string
required
description
string
external_key
string
name
string
required
Request
Response
Successful Response
Not found
Empty response
Validation Error
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
Accessible to TPP
companies.
Retrieve the latest available balance of an TPP user account.
ApiKey
tpp_user_account_id
string
required
Response
Successful Response
Not found
Empty response
Validation Error
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
List all the historical balances for a given account
ApiKey
tpp_user_account_id
string
required
page
integer
- Default
- 0
size
integer
- Default
- 50
Response
Successful Response
Not found
Empty response
Validation Error
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
Create a new balance entry for an account
ApiKey
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
Response
Successful Response
Not found
Empty response
Validation Error
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?