Sign in
latestOpenAPI 3.0.32026-08-224982,0272.8 MB

e445c15e5bee

Partner Balances

List partner 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.

Requires access token scope: settlement_network_read

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

Path parameters

enterpriseIdstring required

The enterprise identifier of the partner. This identifies the partner enterprise making the API request.

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.

partnerIdsstring[]

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.

clientIdsstring[]

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.

connectionIdsstring[]

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.

partnersConnectionIdsstring[]

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.

Response

OK

networkBalancesV1PartnerNetworkAccountBalanceRecordOutput required

A record of network account balances for a partner, indexed by connection ID.

Each key in this record is a connection ID, and the corresponding value contains details about the connection and its balances across different currencies.

balancesV1PartnerAccountBalanceRecordOutput

A record of account balances for a partner, indexed by the partner's currency codes.

Each key in this record is a currency identifier in the partner's naming convention, and the corresponding value contains the available and held amounts for that currency.

Note that currency codes here may differ from BitGo's internal currency codes, as they are mapped to match the partner's expected currency identifiers.