/api/network/v1/enterprises/{enterpriseId}/clients/balances
This API call allows clients to get trading and allocated balances at BitGo for any connected trading partner. The trading balances are live data. The data under networkBalances are not the live balances at the partner, the live balances should be viewed on the partner's platform. networkBalances will only update as a result of allocations, deallocations, and settlement.
Error scenarios:
400: Invalid Request Error
Occurs when the request parameters are invalid or malformed
Examples: Invalid UUID format for enterpriseId, invalid filter parameters, invalid pagination parameters, invalid connection or partner IDs
401: Authentication Error
Occurs when the request is not authorized
Examples: Caller is not a member of the enterprise.
403: Permission Denied Error
Occurs when the authenticated client doesn't have necessary permissions
Examples: Client doesn't have permission to view balances. Enterprise does not have OES license.
404: Not Found Error
Occurs when the specified enterprise or resources cannot be found
Examples: Enterprise doesn't exist.
500: Internal Server Error
Occurs when there's an unexpected server error processing the request
Examples: Database connection issues, transient network errors,
enterpriseId
stringRequired>= 1 characters
pageNumber
string<integer>
pageSize
stringconnectionIds
array[string]partnerIds
array[string]clientId
string required balances
dictionary<string, object> required
object networkBalances
dictionary<string, object> required
object error
string required error
string required error
string required error
string required