Ctrl+K

List partner balances

get/api/network/v1/enterprises/{enterpriseId}/partners/balances

Lists all your OES balances. For use only by OES partners.

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

  • 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 partner doesn't have necessary permissions

  • Examples: Partner doesn't have permission to view balances. Enterprise does not have OES license.

  • 404: Not Found Error

  • Occurs when the specified enterprise cannot be found

  • Examples: Enterprise ID doesn't exist or doesn't belong to the partner

  • 500: Internal Server Error

  • Occurs when there's an unexpected server error processing the request

  • Examples: Database connection issues, transient network errors.

Path Parameters

  • enterpriseIdstringRequired
    The enterprise identifier of the partner. This identifies the partner enterprise making the API request.
    Min length: >= 1 characters

Query Parameters

  • pageNumberstring<integer>
    The page number (integer) you wish to fetch. When provided, the API will skip pageSize * pageNumber records. Page numbers are zero-based, so the first page is 0. If not provided, defaults to 0.
  • pageSizestring<integer>
    The page size (integer) you wish to fetch. When provided, the API will return at most pageSize records per page. If not provided, a default page size defined by the server will be used.
  • partnerIdsarray[string]
    Optional array of partner IDs to filter by. If provided: - Only balances for partners with these IDs will be returned. - Only connections to these partners will be included. - Useful when a partner has multiple partner entities and wants to filter results. If omitted, results will include data for all partners the requester has access to.
  • clientIdsarray[string]
    Optional array of client IDs to filter by. If provided: - Only balances for clients with these IDs will be returned. - Useful for filtering results to specific client relationships. If omitted, results will include data for all clients connected to the partner.
  • connectionIdsarray[string]
    Optional array of connection IDs to filter by. If provided: - Only balances for connections with these specific IDs will be returned. - Useful for querying balances for specific connections. If omitted, results will include data for all connections subject to other filters.
  • partnersConnectionIdsarray[string]
    Optional array of partner connection IDs to filter by. If provided: - Only balances for connections with these partner-specific IDs will be returned. - These are the IDs that partners use in their own systems to identify connections. - Useful when partners want to look up balances using their own identifiers. If omitted, results will include data for all connections subject to other filters.
    Min length: >= 1 characters

200 Response

networkBalances dictionary<string, object> required
Detailed information about balances across all client connections to this partner. This record contains: - Keys: Connection IDs that uniquely identify each connection. - Values: Detailed information about the connection and its balances. This provides a comprehensive view of client funds allocated to each connection and their current availability.
object
balances dictionary<string, object>
Information on the balances for the partner's own BitGo account. This object, when present, contains: - Keys: Currency identifiers (e.g., "BTC", "ETH", "USDC") in the partner's currency naming convention - Values: Balance information in base units including available and held amounts for each currency This allows partners to see their own BitGo account balances alongside client connection balances, providing a complete view of their financial position within the BitGo system. Note: This field may be omitted if the partner doesn't have permission to view their own BitGo account balances.
object

400 Response

401 Response

error string required

403 Response

error string required

404 Response

error string required

500 Response

error string required