Admin GET Connection Balances

get/api/network/v1/admin/connections/balances

Admin route to fetch Network Account Balances for multiple connections.

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
    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.
  • clientIdsarray[string]
  • connectionIdsarray[string]
  • clientEnterpriseIdsarray[string]
    Min length: >= 1 characters
  • partnerIdsarray[string]
  • partnersConnectionIdsarray[string]
    Min length: >= 1 characters
  • partnerEnterpriseIdsarray[string]
    Min length: >= 1 characters
  • partnerNamesarray[string]
    Min length: >= 1 characters
  • institutionIdentifiersarray[string]
    Min length: >= 1 characters
  • trustOrgstringRequired
    Enum: BitGo Trust BitGo New York BitGo Germany BitGo Switzerland BitGo Europe ApS Frankfurt DE Trust BitGo Singapore BitGo Korea BitGo Custody MENA FZE BitGo India BitGo Sister Trust 1

200 Response

V1AdminConnectionBalancesGetPayload dictionary<string, object>
object
name string required
Min length: >= 1 characters
clientId string required
clientEnterpriseId string required
Min length: >= 1 characters
partnerId string required
partnerName string required
Min length: >= 1 characters
institutionIdentifier string required
Min length: >= 1 characters
partnerEnterpriseId string required
Min length: >= 1 characters
balances dictionary<string, object> required
partnersConnectionId string
Min length: >= 1 characters

400 Response

401 Response

error string required

403 Response

error string required

404 Response

error string required

500 Response

error string required