Cash Balances
Download SpecAll cash balance related paths
Retrieve an account group's cash balance
Retrieve an account group's cash balance
account_group_id
string
uuid
required
Account group unique identifier.
upvest-client-id
string
uuid
required
Tenant Client ID
- Example
- "ebabcf4d-61c3-4942-875c-e265a7c2d062"
authorization
string
^Bearer [a-zA-Z0-9\-\._~+/]*=*
required
Bearer (access) token from the OAuth flow with correct scopes. https://datatracker.ietf.org/doc/html/rfc6750
- Example
- "Bearer c2VjcmV0Cg=="
signature
string
required
https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header
signature-input
string
required
https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he
upvest-api-version
string
Upvest API version (Note: Do not include quotation marks)
- Default
- "1"
- Enum
-
- 1
- Example
- "1"
oauth-client-credentials
Required Scopes:
positions:read Retrieve an account group's cash balance
All Scopes
-
account_liquidations:admin· Trigger/read/cancel accounts liquidations -
account_liquidations:read· Read accounts liquidations -
account_returns:read· Read accounts returns -
accounts:admin· Create/update/delete accounts and account groups -
accounts:read· Read accounts and account groups -
checks:admin· Create checks -
checks:read· Read checks -
credit_fundings:read· Credit Fundings read operations -
fees:admin· Create and read fee operations -
fees:read· Read fee operations -
files:read· Read files metadata -
instruments:read· Read instruments -
mandates:admin· Create/update/delete mandates -
mandates:read· Read mandates -
orders:admin· Create/update/delete orders -
orders:read· Read orders -
payments:admin· Payins and withdrawal operations -
payments:read· Payins and withdrawal read operations -
portfolios:admin· Modify portfolios -
portfolios:read· Read portfolios -
positions:read· Read positions -
prices:read· Read instrument prices, -
reference_accounts:admin· Create/update/delete reference accounts -
reference_accounts:read· Read reference accounts -
reports:admin· Create reports -
reports:read· Read reports -
savings_plans:admin· Create/read savings plans -
savings_plans:read· Read savings plans -
securities_transfers:admin· Securities Transfers operations -
securities_transfers:read· Securities Transfers read transfers -
taxes:admin· Modify tax residencies and tax exemptions -
taxes:read· Read tax residencies -
tests:admin· Testing related operations -
topups:admin· Top-ups operations -
topups:read· Top-ups read operations -
transactions:read· Read cash and securities transactions -
users:admin· Create/update/delete users -
users:read· Read users -
valuations:read· Read valuations -
virtual_cash_balances:admin· Virtual cash balances -
webhooks:admin· Create/update/delete webhooks -
webhooks:read· Read webhooks
- Flow Type:
- client_credentials
- Token URL:
- https://sandbox.upvest.co/auth/token
Response
Response
{
"account_group_id": "d0fc0305-97b7-4e3b-bddf-66d3c434898c",
"currency": "EUR",
"balance": "100",
"locked_for_trading": "10",
"pending_settlement": "10",
"available_for_withdrawal": "80",
"available_for_trading": "80"
}{
"account_group_id": "d0fc0305-97b7-4e3b-bddf-66d3c434898c",
"currency": "EUR",
"balance": "1000",
"locked_for_trading": "1000",
"pending_settlement": "0",
"available_for_withdrawal": "0",
"available_for_trading": "0"
}{
"account_group_id": "d0fc0305-97b7-4e3b-bddf-66d3c434898c",
"currency": "EUR",
"balance": "0",
"locked_for_trading": "0",
"pending_settlement": "0",
"available_for_withdrawal": "0",
"available_for_trading": "0"
}{
"account_group_id": "d0fc0305-97b7-4e3b-bddf-66d3c434898c",
"currency": "EUR",
"balance": "828.75",
"locked_for_trading": "0",
"pending_settlement": "828.75",
"available_for_withdrawal": "0",
"available_for_trading": "828.75"
}{
"account_group_id": "d0fc0305-97b7-4e3b-bddf-66d3c434898c",
"currency": "EUR",
"balance": "200",
"locked_for_trading": "0",
"pending_settlement": "0",
"available_for_withdrawal": "200",
"available_for_trading": "0"
}Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Unauthorized. The caller has not been authenticated.
{
"status": 401,
"type": "unauthorized"
}Forbidden. The caller has been authenticated but is not allowed to take the requested action.
{
"status": 403,
"type": "forbidden"
}Not Found. The requested resource could not be found.
{
"status": 404,
"type": "not_found"
}Not Found. The requested resource could not be found.
{
"status": 404,
"type": "not_found"
}Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.
{
"status": 429,
"type": "too_many_requests"
}Internal Server Error. The service encountered an unexpected error.
{
"status": 500,
"type": "internal_server_error"
}Service Unavailable. The service handling for this request cannot be reached at this time.
{
"status": 503,
"type": "method_not_allowed"
}Gateway Timeout. The service gateway has reached its internal timeout.
{
"status": 504,
"type": "gateway_timeout"
}type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
required
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
required
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
required
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
required
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
required
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
required
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
required
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
required
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
account_group_id
string
uuid
required
Account group unique identifier.
currency
string
required
Alphabetic three-letter ISO 4217 currency code.
- EUR - Euro
- Default
- "EUR"
- Enum
-
- EUR
balance
string
^-?[0-9]{0,63}(\.[0-9]{1,27})?$
required
locked_for_trading
string
^[0-9]{0,63}(\.[0-9]{1,27})?$
required
pending_settlement
string
^[0-9]{0,63}(\.[0-9]{1,27})?$
required
available_for_withdrawal
string
^-?[0-9]{0,63}(\.[0-9]{1,27})?$
required
available_for_trading
string
^-?[0-9]{0,63}(\.[0-9]{1,27})?$
required
upvest-request-id
string
uuid
required
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Cash Balance events
id
string
uuid
required
Event unique identifier
created_at
string
date-time
required
Date and time when the event was created. RFC 3339-5, ISO8601 UTC
type
string
required
Event type
- Default
- "CASH_BALANCE.UPDATED"
- Enum
-
- CASH_BALANCE.UPDATED
object
object (object)
required
account_group_id
string
uuid
required
Account group unique identifier.
currency
string
required
Alphabetic three-letter ISO 4217 currency code.
- EUR - Euro
- Default
- "EUR"
- Enum
-
- EUR
balance
string
^-?[0-9]{0,63}(\.[0-9]{1,27})?$
required
locked_for_trading
string
^[0-9]{0,63}(\.[0-9]{1,27})?$
required
pending_settlement
string
^[0-9]{0,63}(\.[0-9]{1,27})?$
required
available_for_withdrawal
string
^-?[0-9]{0,63}(\.[0-9]{1,27})?$
required
available_for_trading
string
^-?[0-9]{0,63}(\.[0-9]{1,27})?$
required
webhook_id
string
uuid
required
Webhook unique identifier.
Request
{
"id": "8962b496-8d42-4560-bfab-10490dd1a724",
"created_at": "2021-07-21T14:10:00.00Z",
"type": "CASH_BALANCE.UPDATED",
"object": {
"account_group_id": "d0fc0305-97b7-4e3b-bddf-66d3c434898c",
"currency": "EUR",
"balance": "100",
"locked_for_trading": "10",
"pending_settlement": "10",
"available_for_withdrawal": "80",
"available_for_trading": "80"
},
"webhook_id": "9df39835-be87-4243-9018-f2500b39cee6"
}{
"id": "a59c81ee-7770-4f6b-9ebe-8c268b78beb4",
"created_at": "2021-07-22T14:12:00.00Z",
"type": "CASH_BALANCE.UPDATED",
"object": {
"account_group_id": "d0fc0305-97b7-4e3b-bddf-66d3c434898c",
"currency": "EUR",
"balance": "200",
"locked_for_trading": "0",
"pending_settlement": "0",
"available_for_withdrawal": "0",
"available_for_trading": "0"
},
"webhook_id": "9df39835-be87-4243-9018-f2500b39cee6"
}{
"id": "8c049f77-dc72-489d-8f5f-3871db782252",
"created_at": "2021-07-21T14:11:00.00Z",
"type": "CASH_BALANCE.UPDATED",
"object": {
"account_group_id": "d0fc0305-97b7-4e3b-bddf-66d3c434898c",
"currency": "EUR",
"balance": "0",
"locked_for_trading": "0",
"pending_settlement": "0",
"available_for_withdrawal": "0",
"available_for_trading": "0"
},
"webhook_id": "9df39835-be87-4243-9018-f2500b39cee6"
}Response
Request has been processed successfully.
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
Was this page helpful?