Skip to content

Commit 899bd62

Browse files
feat: update bitgo-api-docs
This commit updates the BitGo API.
1 parent e1b3a57 commit 899bd62

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

api.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -59524,7 +59524,7 @@ components:
5952459524
balances:
5952559525
allOf:
5952659526
- $ref: '#/components/schemas/AccountBalanceRecord'
59527-
description: A record of account balances indexed by currency code. Each key in this record is a currency identifier (e.g., "ofcbtc", "ofceth", "ofcusdc"), and the corresponding value is an AccountBalance object containing the available and held amounts for that currency.
59527+
description: A record of account balances indexed by currency code. Each key in this record is a currency identifier (e.g., "ofcbtc", "ofceth", "ofcusdc"), and the corresponding value is an AccountBalance object containing the available and held amounts for that currency in base units.
5952859528
networkBalances:
5952959529
allOf:
5953059530
- $ref: '#/components/schemas/NetworkAccountBalanceRecordForClient'
@@ -60683,11 +60683,11 @@ components:
6068360683
networkBalances:
6068460684
allOf:
6068560685
- $ref: '#/components/schemas/V1PartnerNetworkAccountBalanceRecordOutput'
60686-
description: '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.'
60686+
description: '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.'
6068760687
balances:
6068860688
allOf:
6068960689
- $ref: '#/components/schemas/V1PartnerAccountBalanceRecordOutput'
60690-
description: '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 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.'
60690+
description: '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.'
6069160691
required:
6069260692
- networkBalances
6069360693
V1PartnerExtDepositsSigningPayload:
@@ -60725,7 +60725,7 @@ components:
6072560725
balances:
6072660726
allOf:
6072760727
- $ref: '#/components/schemas/V1PartnerAccountBalanceRecordOutput'
60728-
description: 'The balances for this connection, indexed by currency code. This object contains: - Keys: Currency identifiers in the partner''s naming convention - Values: Balance information including available and held amounts These balances represent funds that have been allocated by the client to this specific connection and are available for operations by the partner.'
60728+
description: 'The balances for this connection, indexed by currency code. This object contains: - Keys: Currency identifiers in the partner''s naming convention. - Values: Balance information in base units, including available and held amounts. These balances represent funds that have been allocated by the client to this specific connection and are available for operations by the partner.'
6072960729
required:
6073060730
- clientId
6073160731
- partnerId

0 commit comments

Comments
 (0)