diff --git a/api.yaml b/api.yaml
index 8dda593..27a870c 100644
--- a/api.yaml
+++ b/api.yaml
@@ -101,10 +101,10 @@ tags:
- name: Trade REST API
description: |-
## Rate-Limiting
- All REST endpoints are rate-limited to 10 requests/second. Once the limit is reached, requests will be rejected with '429 Too Many Requests'
+ All REST endpoints are rate-limited to 10 requests/second. Once the limit is reached, requests will be rejected with `429 Too Many Requests`
The following headers are returned on every request
| Header | Description |
| X-Ratelimit-Limit | Request limit per second |
| X-Ratelimit-Remaining | Remaining number of requests allowed in interval |
| X-Ratelimit-Reset | Duration in milliseconds until the total quota resets |
- The following header is also returned if the response is '429 Too Many Requests' | Header | Description |
| Retry-After | Duration in seconds of how long to wait before making a new request |
+ The following header is also returned if the response is `429 Too Many Requests` | Header | Description |
| Retry-After | Duration in seconds of how long to wait before making a new request |
- name: Staking Request
description: API to create, retrieve staking requests, and retrieve staking request transactions. A staking request can be of type STAKE or UNSTAKE.
- name: Staking State Information
@@ -142,7 +142,7 @@ paths:
- Wallet
summary: Update wallet
operationId: v2.wallet.update
- description: Update a wallet by its 'coin' and 'walletId'.
+ description: Update a wallet by its `coin` and `walletId`.
parameters:
- $ref: '#/components/parameters/pathCoin'
- $ref: '#/components/parameters/pathWalletId'
@@ -174,7 +174,7 @@ paths:
tags:
- Wallet
summary: Delete wallet
- description: Delete one wallet by its 'coin' and 'walletId'. Once removed, you can no longer view or access this wallet, but it does remain accessible to other wallet users. If you are the only user on this wallet, you can only delete it if it has a 0 balance.
+ description: Delete one wallet by its `coin` and `walletId`. Once removed, you can no longer view or access this wallet, but it does remain accessible to other wallet users. If you are the only user on this wallet, you can only delete it if it has a 0 balance.
operationId: v2.wallet.remove
parameters:
- $ref: '#/components/parameters/pathCoin'
@@ -309,8 +309,8 @@ paths:
summary: List wallet webhooks
description: |
List webhooks set up on the wallet. Currently, the types of
- webhooks that can be attached to a wallet are 'transfer',
- 'pendingapproval', and 'address_confirmation' notifications.
+ webhooks that can be attached to a wallet are `transfer`,
+ `pendingapproval`, and `address_confirmation` notifications.
operationId: v2.wallet.listwebhooks
parameters:
- $ref: '#/components/parameters/pathCoin'
@@ -393,7 +393,7 @@ paths:
description: |-
Add a webhook to a wallet that sends an HTTP callback from BitGo to a specified
URL when specific conditions occur. A wallet can have up to 10 webhooks of each
- wallet-webhook 'type'. Learn more about webhooks on the
+ wallet-webhook `type`. Learn more about webhooks on the
[Developer Portal](https://developers.bitgo.com/guides/wallets/webhooks).
**Note:** Before you process webhook notifications, BitGo strongly recommends that
@@ -930,7 +930,7 @@ paths:
- Pending approval
summary: Update pending approval
description: |
- Updates the state of a pending approval to 'approved' or 'rejected'.
+ Updates the state of a pending approval to `approved` or `rejected`.
You can manage pending approvals programmatically by API or with the
BigGo web UI. Ensure your authentication token has the proper scope.
When creating an access token in the web UI, check the permission,
@@ -1076,7 +1076,7 @@ paths:
- type: array
items:
type: string
- description: The permissions granted by this access token. - 'all' - Access all actions in the test environment. - 'crypto_compare' - Call CryptoCompare API. - 'enterprise_manage_all' - Manage users and settings for any enterprise to which the user belongs. - 'enterprise_view_all' - View any enterprise to which the user belongs. - 'metamask_institutional' - Enables using BitGo wallets in the MetaMask Institutional extension. - 'openid' - Verify your BitGo user ID using OpenID Connect. - 'pending_approval_update' - Approve or reject pending actions that require approval to proceed. - 'portfolio_view' - Call the Portfolio API (deprecated). - 'profile' - View your BitGo Profile. - 'settlement_network_read' - View your client's Go Network data, enabling allocations to and from your platform. Only for Go Network partners. - 'settlement_network_write' - Update your client's Go Network data, enabling allocations to and from your platform. Only for Go Network partners. - 'trade_trade' - Initiate trades. - 'trade_view' - View trades. - 'wallet_approve' - Approve policies and transactions for a wallet where the user is a wallet admin. - 'wallet_approve_all' - Approve transactions for any wallet where the user is a wallet admin within any enterprise to which the user belongs. - 'wallet_approve_enterprise' - Approve transactions for any wallet where the user is a wallet admin within a single enterprise. - 'wallet_create' - Create wallets. - 'wallet_edit' - Edit comments on a transfer. - 'wallet_edit_all' - Edit comments on all transfers within multiple enterprises. - 'wallet_edit_enterprise' - Edit comments on all transfers within a single enterprise (deprecated). - 'wallet_freeze' - Freeze a wallet. - 'wallet_freeze_all' - Freeze any wallet within any enterprises to which the user belongs. - 'wallet_manage' - Manage settings for a wallet where the user is a wallet admin. - 'wallet_manage_all' - Manage settings for any wallet where the user is a wallet admin within any enterprise to which the user belongs. - 'wallet_manage_enterprise' - Manage settings for any wallet where the user is a wallet admin within a single enterprise. - 'wallet_spend' - Initiate transactions from a wallet. - 'wallet_spend_all' - Initiate transactions from any wallet within any enterprise to which the user belongs. - 'wallet_spend_enterprise' - Initiate transactions from any wallet within a single enterprise. - 'wallet_stake' - Initiate staking transactions from a wallet. - 'wallet_stake_all' - Initiate staking transactions from any wallet within any enterprise to which the user belongs. - 'wallet_view' - View a wallet. - 'wallet_view_all' - View any wallet within any enterprise to which the user belongs. - 'wallet_view_enterprise' - View any wallet within a single enterprise.
+ description: The permissions granted by this access token. - `all` - Access all actions in the test environment. - `crypto_compare` - Call CryptoCompare API. - `enterprise_manage_all` - Manage users and settings for any enterprise to which the user belongs. - `enterprise_view_all` - View any enterprise to which the user belongs. - `metamask_institutional` - Enables using BitGo wallets in the MetaMask Institutional extension. - `openid` - Verify your BitGo user ID using OpenID Connect. - `pending_approval_update` - Approve or reject pending actions that require approval to proceed. - `portfolio_view` - Call the Portfolio API (deprecated). - `profile` - View your BitGo Profile. - `settlement_network_read` - View your client's Go Network data, enabling allocations to and from your platform. Only for Go Network partners. - `settlement_network_write` - Update your client's Go Network data, enabling allocations to and from your platform. Only for Go Network partners. - `trade_trade` - Initiate trades. - `trade_view` - View trades. - `wallet_approve` - Approve policies and transactions for a wallet where the user is a wallet admin. - `wallet_approve_all` - Approve transactions for any wallet where the user is a wallet admin within any enterprise to which the user belongs. - `wallet_approve_enterprise` - Approve transactions for any wallet where the user is a wallet admin within a single enterprise. - `wallet_create` - Create wallets. - `wallet_edit` - Edit comments on a transfer. - `wallet_edit_all` - Edit comments on all transfers within multiple enterprises. - `wallet_edit_enterprise` - Edit comments on all transfers within a single enterprise (deprecated). - `wallet_freeze` - Freeze a wallet. - `wallet_freeze_all` - Freeze any wallet within any enterprises to which the user belongs. - `wallet_manage` - Manage settings for a wallet where the user is a wallet admin. - `wallet_manage_all` - Manage settings for any wallet where the user is a wallet admin within any enterprise to which the user belongs. - `wallet_manage_enterprise` - Manage settings for any wallet where the user is a wallet admin within a single enterprise. - `wallet_spend` - Initiate transactions from a wallet. - `wallet_spend_all` - Initiate transactions from any wallet within any enterprise to which the user belongs. - `wallet_spend_enterprise` - Initiate transactions from any wallet within a single enterprise. - `wallet_stake` - Initiate staking transactions from a wallet. - `wallet_stake_all` - Initiate staking transactions from any wallet within any enterprise to which the user belongs. - `wallet_view` - View a wallet. - `wallet_view_all` - View any wallet within any enterprise to which the user belongs. - `wallet_view_enterprise` - View any wallet within a single enterprise.
duration:
type: number
description: The duration of the access token in seconds.
@@ -1140,7 +1140,7 @@ paths:
/api/v2/user/session:
get:
summary: Get session
- description: Returns the session associated with access token passed via the 'Authorization' header.
+ description: Returns the session associated with access token passed via the `Authorization` header.
operationId: user.getsession
tags:
- User
@@ -1224,13 +1224,13 @@ paths:
- Transaction request
parameters:
- name: txRequestIds
- description: If provided, only transaction requests specified will be returned.
+ description: 'If provided, only transaction requests of the specified state will be returned. - `canceled`: Transaction request was canceled by a wallet spender before approval or sending. - `delivered`: Transaction request was inserted into the send queue (or rejected by BitGo through circuit breakers). This state is only used with apiVersion "full". - `failed` : Catch-all state indicating an unrecoverable failure (such as a duplicate key error when creating a transfer). - `initialized`: Initial state when a transaction request is created, before any policy evaluation occurs. `pendingApproval`: Transaction request triggered a policy that requires approval to move forward. `pendingDelivery`: Transaction request requires further action to proceed. For example, transaction requests pending signature, or transaction requests that trigger a circuit breaker and require you to accept or reject them with BitGo. This state is only used with apiVersion "full". - `pendingUserCommitment`: Transaction request is ready to receive your user commitments. This state is only used with apiVersion "lite" and EdDSA assets with commitment signing states. - `pendingUserGShare`: Transaction request is ready to receive your gShare. - `pendingUserRShare`: Transaction request is ready to receive your rShare. - `pendingUserSignature`: Transaction request is ready to receive your user signature. Get the unsigned transaction from BitGo and sign it. This state is only used with apiVersion "lite" and EdDSA assets without commitment signing states. - `readyToSend`: Transaction request is ready send (share combination is complete). - `rejected`: Transaction request was rejected by an approver. - `signed`: All transactions for the transaction request were signed. All future updates will be in the transfer document.'
in: query
schema:
type: array
items:
type: string
- description: If provided, only transaction requests specified will be returned.
+ description: 'If provided, only transaction requests of the specified state will be returned. - `canceled`: Transaction request was canceled by a wallet spender before approval or sending. - `delivered`: Transaction request was inserted into the send queue (or rejected by BitGo through circuit breakers). This state is only used with apiVersion "full". - `failed` : Catch-all state indicating an unrecoverable failure (such as a duplicate key error when creating a transfer). - `initialized`: Initial state when a transaction request is created, before any policy evaluation occurs. `pendingApproval`: Transaction request triggered a policy that requires approval to move forward. `pendingDelivery`: Transaction request requires further action to proceed. For example, transaction requests pending signature, or transaction requests that trigger a circuit breaker and require you to accept or reject them with BitGo. This state is only used with apiVersion "full". - `pendingUserCommitment`: Transaction request is ready to receive your user commitments. This state is only used with apiVersion "lite" and EdDSA assets with commitment signing states. - `pendingUserGShare`: Transaction request is ready to receive your gShare. - `pendingUserRShare`: Transaction request is ready to receive your rShare. - `pendingUserSignature`: Transaction request is ready to receive your user signature. Get the unsigned transaction from BitGo and sign it. This state is only used with apiVersion "lite" and EdDSA assets without commitment signing states. - `readyToSend`: Transaction request is ready send (share combination is complete). - `rejected`: Transaction request was rejected by an approver. - `signed`: All transactions for the transaction request were signed. All future updates will be in the transfer document.'
- name: idempotencyKeys
description: If provided, only transaction requests with the matching idempotencyKeys will be returned.
in: query
@@ -1472,8 +1472,8 @@ paths:
summary: Add Go Account connection
description: |-
Add a connection for your Go Account to another Go Account.
- To connect to a Go Account that's not listed in the public directory, pass a 'walletId'.
- To connect to a Go Account that is listed in the public directory, pass a value for the 'targetListingEntryId'.
+ To connect to a Go Account that's not listed in the public directory, pass a `walletId`.
+ To connect to a Go Account that is listed in the public directory, pass a value for the `targetListingEntryId`.
operationId: V1PostConnectionRoute
tags:
- Counterparties
@@ -1564,7 +1564,7 @@ paths:
$ref: '#/components/schemas/V1ErrorResponse'
put:
summary: Update connection status
- description: Update connections to 'PENDING_DEACTIVATION'.
+ description: Update connections to `PENDING_DEACTIVATION`.
operationId: V1PutConnectionsRoute
tags:
- Counterparties
@@ -1790,7 +1790,7 @@ paths:
minLength: 1
name:
type: string
- description: The name of your listing that displays in the global directory. 'editable' must be 'true'
+ description: The name of your listing that displays in the global directory. `editable` must be `true`
minLength: 1
responses:
'200':
@@ -1833,7 +1833,7 @@ paths:
/api/address-book/v1/listing/entry/{listingEntryId}:
put:
summary: Update Go Account entry
- description: Update your Go Account entry and 'targetListingEntries' for your connections.
+ description: Update your Go Account entry and `targetListingEntries` for your connections.
operationId: V1PutListingEntryRoute
tags:
- Counterparties
@@ -16848,7 +16848,7 @@ paths:
operationId: user.get
parameters:
- name: id
- description: The user ID, email address, or 'me' for the currently authenticated user
+ description: The user ID, email address, or `me` for the currently authenticated user
in: path
required: true
schema:
@@ -17111,7 +17111,7 @@ paths:
Filter by request type. The default behavior is to return all request types.
- name: state
description: |
- Filter by state. The default behavior is to return objects where state is 'awaitingSignature', 'pending', or 'pendingFinalApproval'
+ Filter by state. The default behavior is to return objects where state is `awaitingSignature`, `pending`, or `pendingFinalApproval`
in: query
schema:
type: array
@@ -17120,7 +17120,7 @@ paths:
- $ref: '#/components/parameters/walletId'
- name: expandWalletLabels
description: |
- True, if adding 'walletLabel' to each returned pending approval associated with a 'wallet'
+ True, if adding `walletLabel` to each returned pending approval associated with a `wallet`
in: query
schema:
type: boolean
@@ -17139,8 +17139,8 @@ paths:
summary: List transfers
description: |
Returns deposits and withdrawals for a wallet. Transfers are sorted
- in descending order by 'height', then 'id'. Transfers with 'rejected'
- and 'pendingApproval' states are excluded by default.
+ in descending order by `height`, then `id`. Transfers with `rejected`
+ and `pendingApproval` states are excluded by default.
operationId: v2.wallet.listtransfers
parameters:
- $ref: '#/components/parameters/pathCoin'
@@ -17169,7 +17169,7 @@ paths:
$ref: '#/components/schemas/Id'
- name: address
in: query
- description: Return transfers with elements in 'entries' that have an 'address' field set to this value
+ description: Return transfers with elements in `entries` that have an `address` field set to this value
schema:
type: array
items:
@@ -17231,7 +17231,7 @@ paths:
- $ref: '#/components/parameters/pathTransferId'
- name: includeTxRequestCreatedDate
in: query
- description: True, if returning the 'txRequestCreatedDate'. This field is only present on transfers associated with a transaction request.
+ description: True, if returning the `txRequestCreatedDate`. This field is only present on transfers associated with a transaction request.
schema:
type: boolean
default: false
@@ -17312,8 +17312,8 @@ paths:
description: |
Unlocks the current user session, enabling operations that require
an unlocked token, such as sending a transaction. Call this endpoint
- if an API returns a '401' response with the 'needsUnlock'
- body parameter set to 'true'.
+ if an API returns a `401` response with the `needsUnlock`
+ body parameter set to `true`.
**Note:** Unlocking a token with spending limits, removes all spending limits from the token.
tags:
@@ -17377,8 +17377,8 @@ paths:
potentially delay all subsequent transactions. To help lower network fee costs,
two fee addresses are provided.
- 'feeAddress' is a main fee address usable for all operations.
- 'lowPriorityFeeAddress' is a secondary fee address that can be used to pay
+ `feeAddress` is a main fee address usable for all operations.
+ `lowPriorityFeeAddress` is a secondary fee address that can be used to pay
lower fee for Create Address operations without risking delaying subsequent
higher-priority transactions initiated by main fee address.
operationId: v2.wallet.add.deprecated
@@ -17479,8 +17479,8 @@ paths:
potentially delay all subsequent transactions. To help lower network fee costs,
two fee addresses are provided.
- 'feeAddress' is a main fee address usable for all operations.
- 'lowPriorityFeeAddress' is a secondary fee address that can be used to pay
+ `feeAddress` is a main fee address usable for all operations.
+ `lowPriorityFeeAddress` is a secondary fee address that can be used to pay
lower fee for Create Address operations without risking delaying subsequent
higher-priority transactions initiated by main fee address.
operationId: v2.wallet.add
@@ -17518,7 +17518,7 @@ paths:
- Wallet
summary: Get wallet by address
operationId: v2.wallet.getwalletbyaddress
- description: Get one wallet by its 'coin' and receive 'address'. Multiple receive addresses can map to one 'walletId'.
+ description: Get one wallet by its `coin` and receive `address`. Multiple receive addresses can map to one `walletId`.
parameters:
- $ref: '#/components/parameters/pathCoin'
- $ref: '#/components/parameters/pathAddress'
@@ -17772,7 +17772,7 @@ paths:
$ref: '#/components/schemas/UnspentId'
expireTime:
type: string
- description: Time when reservation expires. Use 'date-time' format or 'never'. If 'never', reservation doesn't expire.
+ description: Time when reservation expires. Use `date-time` format or 'never'. If 'never', reservation doesn't expire.
type:
type: string
description: Type of reservation to make on the unspent.
@@ -17852,19 +17852,19 @@ paths:
type: string
- $ref: '#/components/parameters/limit'
- name: expireTimeGt
- description: Returns reserved unspents with an 'expireTime' greater than this value.
+ description: Returns reserved unspents with an `expireTime` greater than this value.
in: query
schema:
type: string
format: date-time
- name: expireTimeLte
- description: Returns reserved unspents with an 'expireTime' less than or equal to this value.
+ description: Returns reserved unspents with an `expireTime` less than or equal to this value.
in: query
schema:
type: string
format: date-time
- name: expireTime
- description: Returns reserved unspents with an 'expireTime' equal to this value. If 'never', returns unspents without expiration dates.
+ description: Returns reserved unspents with an `expireTime` equal to this value. If `never`, returns unspents without expiration dates.
in: query
schema:
type: string
@@ -18110,7 +18110,7 @@ paths:
summary: Simulate wallet webhook
description: |
Simulates and tests a webhook so you can view its response. A
- 'transferId', 'pendingApprovalId' or 'txRequestId' is required.
+ `transferId`, `pendingApprovalId` or `txRequestId` is required.
operationId: v2.wallet.simulatewebhook
parameters:
- $ref: '#/components/parameters/pathCoin'
@@ -18196,8 +18196,8 @@ paths:
- Webhook
summary: List block webhooks
description: |
- Returns block webhooks. The types of webhooks are 'block' and
- 'wallet_confirmation' notifications.
+ Returns block webhooks. The types of webhooks are `block` and
+ `wallet_confirmation` notifications.
operationId: v2.webhooks.list
parameters:
- $ref: '#/components/parameters/pathCoin'
@@ -18913,8 +18913,8 @@ paths:
summary: List bank accounts
operationId: v2.bankaccount.list
description: |
- This route is potentially useful for finding the 'idHash' of the desired account to use for fiat withdrawals. The 'idHash' field
- is used as the recipient address along with an optional hyphen separator and memo (example: '5812dcaa9a285aa6-memohere').
+ This route is potentially useful for finding the `idHash` of the desired account to use for fiat withdrawals. The `idHash` field
+ is used as the recipient address along with an optional hyphen separator and memo (example: `5812dcaa9a285aa6-memohere`).
parameters:
- name: verificationState
in: query
@@ -18976,8 +18976,8 @@ paths:
- Bank account
summary: Get bank account
description: |
- This route is potentially useful for finding the 'idHash' of the desired account to use for fiat withdrawals. The 'idHash' field
- is used as the recipient address along with an optional hyphen separator and memo (example: '5812dcaa9a285aa6-memohere').
+ This route is potentially useful for finding the `idHash` of the desired account to use for fiat withdrawals. The `idHash` field
+ is used as the recipient address along with an optional hyphen separator and memo (example: `5812dcaa9a285aa6-memohere`).
operationId: v2.bankaccount.get
parameters:
- $ref: '#/components/parameters/pathBankAccountId'
@@ -19636,7 +19636,7 @@ paths:
**Notes**:
1. As other coins do not have a blockspace market, this route is only available for Bitcoin at this time.
- 2. Using CPFP, if a target transaction depends on other unconfirmed transactions, this route also adds sufficient fees to elevate the entire transaction ancestry's effective fee rate to the 'cpfpFeeRate'.
+ 2. Using CPFP, if a target transaction depends on other unconfirmed transactions, this route also adds sufficient fees to elevate the entire transaction ancestry's effective fee rate to the `cpfpFeeRate`.
parameters:
- $ref: '#/components/parameters/pathBitcoin'
- $ref: '#/components/parameters/pathWalletId'
@@ -19825,7 +19825,7 @@ paths:
- Express
summary: Lightning - Initialize node
operationId: express.lightning.initWallet
- description: This is only used for self-custody lightning. Initialize a newly created Lightning Network Daemon (LND) for the first time. Returns the updated wallet with the encrypted admin macaroon in the 'coinSpecific' response field.
+ description: This is only used for self-custody lightning. Initialize a newly created Lightning Network Daemon (LND) for the first time. Returns the updated wallet with the encrypted admin macaroon in the `coinSpecific` response field.
parameters:
- $ref: '#/components/parameters/pathLightningCoin'
- $ref: '#/components/parameters/pathWalletId'
@@ -19855,7 +19855,7 @@ paths:
- Express
summary: Lightning - Create signer macaroon
operationId: express.lightning.signerMacaroon
- description: This is only used for self-custody lightning. Create the signer macaroon for the watch-only Lightning Network Daemon (LND) node. This macaroon derives from the signer node admin macaroon and is used by the watch-only node to request signatures from the signer node for operational tasks. Returns the updated wallet with the encrypted signer macaroon in the 'coinSpecific' response field.
+ description: This is only used for self-custody lightning. Create the signer macaroon for the watch-only Lightning Network Daemon (LND) node. This macaroon derives from the signer node admin macaroon and is used by the watch-only node to request signatures from the signer node for operational tasks. Returns the updated wallet with the encrypted signer macaroon in the `coinSpecific` response field.
parameters:
- $ref: '#/components/parameters/pathLightningCoin'
- $ref: '#/components/parameters/pathWalletId'
@@ -20068,7 +20068,7 @@ paths:
tags:
- Policy Builder
summary: Get policy rule
- description: Returns a policy rule by its ID. If version is passed, returns the most recent 'INACTIVE' policy rule. If version isn't passed, returns the currently 'ACTIVE' policy rule.
+ description: Returns a policy rule by its ID. If version is passed, returns the most recent `INACTIVE` policy rule. If version isn't passed, returns the currently `ACTIVE` policy rule.
operationId: v1.policy.rules.get
parameters:
- $ref: '#/components/parameters/Enterprise'
@@ -20103,7 +20103,7 @@ paths:
- $ref: '#/components/parameters/PolicyRuleId'
responses:
'200':
- description: The 'INACTIVE' policy rule
+ description: The `INACTIVE` policy rule
content:
application/json:
schema:
@@ -20480,7 +20480,7 @@ paths:
type: string
- name: dateGte
in: query
- description: Return client orders with a 'creationDate' that is greater than or equal to the given timestamp
+ description: Return client orders with a `creationDate` that is greater than or equal to the given timestamp
required: false
style: form
explode: true
@@ -20489,7 +20489,7 @@ paths:
format: date-time
- name: dateLt
in: query
- description: Return client orders with a 'creationDate' that is less than the given timestamp
+ description: Return client orders with a `creationDate` that is less than the given timestamp
required: false
style: form
explode: true
@@ -20498,7 +20498,7 @@ paths:
format: date-time
- name: status
in: query
- description: Return client orders with an order 'status' that is equal to the given string
+ description: Return client orders with an order `status` that is equal to the given string
required: false
style: form
explode: true
@@ -24276,7 +24276,7 @@ paths:
- 'false'
default: 'false'
- name: includeStakingBalances
- description: Include 'stakingBalanceString' and 'rewardBalanceString' properties for each staking wallet.
+ description: Include `stakingBalanceString` and `rewardBalanceString` properties for each staking wallet.
in: query
schema:
type: string
@@ -24346,11 +24346,13 @@ paths:
in: query
schema:
type: string
+ example: '2025-04-26T18:30:00.000Z'
- name: dateLt
- description: Date less than or equal to
+ description: Date less than
in: query
schema:
type: string
+ example: '2025-04-26T18:30:00.000Z'
- name: enterpriseId
description: The enterprise ID to filter by
in: query
@@ -24926,13 +24928,13 @@ paths:
- Transaction request
parameters:
- name: txRequestIds
- description: If provided, only transaction requests specified will be returned.
+ description: 'If provided, only transaction requests of the specified state will be returned. - `canceled`: Transaction request was canceled by a wallet spender before approval or sending. - `delivered`: Transaction request was inserted into the send queue (or rejected by BitGo through circuit breakers). This state is only used with apiVersion "full". - `failed` : Catch-all state indicating an unrecoverable failure (such as a duplicate key error when creating a transfer). - `initialized`: Initial state when a transaction request is created, before any policy evaluation occurs. `pendingApproval`: Transaction request triggered a policy that requires approval to move forward. `pendingDelivery`: Transaction request requires further action to proceed. For example, transaction requests pending signature, or transaction requests that trigger a circuit breaker and require you to accept or reject them with BitGo. This state is only used with apiVersion "full". - `pendingUserCommitment`: Transaction request is ready to receive your user commitments. This state is only used with apiVersion "lite" and EdDSA assets with commitment signing states. - `pendingUserGShare`: Transaction request is ready to receive your gShare. - `pendingUserRShare`: Transaction request is ready to receive your rShare. - `pendingUserSignature`: Transaction request is ready to receive your user signature. Get the unsigned transaction from BitGo and sign it. This state is only used with apiVersion "lite" and EdDSA assets without commitment signing states. - `readyToSend`: Transaction request is ready send (share combination is complete). - `rejected`: Transaction request was rejected by an approver. - `signed`: All transactions for the transaction request were signed. All future updates will be in the transfer document.'
in: query
schema:
type: array
items:
type: string
- description: If provided, only transaction requests specified will be returned.
+ description: 'If provided, only transaction requests of the specified state will be returned. - `canceled`: Transaction request was canceled by a wallet spender before approval or sending. - `delivered`: Transaction request was inserted into the send queue (or rejected by BitGo through circuit breakers). This state is only used with apiVersion "full". - `failed` : Catch-all state indicating an unrecoverable failure (such as a duplicate key error when creating a transfer). - `initialized`: Initial state when a transaction request is created, before any policy evaluation occurs. `pendingApproval`: Transaction request triggered a policy that requires approval to move forward. `pendingDelivery`: Transaction request requires further action to proceed. For example, transaction requests pending signature, or transaction requests that trigger a circuit breaker and require you to accept or reject them with BitGo. This state is only used with apiVersion "full". - `pendingUserCommitment`: Transaction request is ready to receive your user commitments. This state is only used with apiVersion "lite" and EdDSA assets with commitment signing states. - `pendingUserGShare`: Transaction request is ready to receive your gShare. - `pendingUserRShare`: Transaction request is ready to receive your rShare. - `pendingUserSignature`: Transaction request is ready to receive your user signature. Get the unsigned transaction from BitGo and sign it. This state is only used with apiVersion "lite" and EdDSA assets without commitment signing states. - `readyToSend`: Transaction request is ready send (share combination is complete). - `rejected`: Transaction request was rejected by an approver. - `signed`: All transactions for the transaction request were signed. All future updates will be in the transfer document.'
- name: idempotencyKeys
description: If provided, only transaction requests with the matching idempotencyKeys will be returned.
in: query
@@ -25697,6 +25699,547 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/PlatformError'
+ /api/v2/organization/{organizationId}/reports:
+ get:
+ summary: List org-level reports
+ description: Lists generated reports.
+ operationId: v2.organization.reports.list
+ tags:
+ - Reports
+ parameters:
+ - name: limit
+ description: Number of reports to return
+ in: query
+ schema:
+ type: string
+ default: '25'
+ maximum: 500
+ format: number
+ - name: createdAtGt
+ description: Only return reports created after this date
+ in: query
+ schema:
+ type: string
+ format: date-time
+ title: ISO Date String
+ - name: enterprise
+ description: Only return reports that includes this enterprise
+ in: query
+ schema:
+ type: string
+ minLength: 1
+ - name: wallet
+ description: Only return reports for this wallet
+ in: query
+ schema:
+ type: string
+ minLength: 1
+ - name: walletType
+ description: Only return reports for this wallet type
+ in: query
+ schema:
+ type: string
+ minLength: 1
+ - name: reportType
+ description: Only return reports for this report type
+ in: query
+ schema:
+ type: string
+ enum:
+ - holdings
+ - transactions
+ - quarterly
+ - trades
+ - staking
+ - holdingsByAddress
+ - organizationHoldings
+ - organizationHoldingsByAddress
+ - organizationTransactions
+ - organizationTrades
+ - organizationStaking
+ - name: status
+ description: Only return rports for this report status
+ in: query
+ schema:
+ type: string
+ enum:
+ - pending
+ - processing
+ - completed
+ - failed
+ - name: prevId
+ description: Only return reports created after this ID
+ in: query
+ schema:
+ type: string
+ minLength: 1
+ - name: format
+ description: Only return reports for this report format
+ in: query
+ schema:
+ type: string
+ enum:
+ - csv
+ - pdf
+ - name: asset
+ description: Only return reports for this report asset
+ in: query
+ schema:
+ type: string
+ minLength: 1
+ - name: reportParams
+ description: Only return reports for this report asset
+ in: query
+ schema: {}
+ - name: organizationId
+ in: path
+ required: true
+ schema:
+ $ref: '#/components/schemas/OrganizationIdString'
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ListReportsJSON'
+ '400':
+ description: Bad Request
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PlatformError'
+ '401':
+ description: Unauthorized
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PlatformError'
+ '403':
+ description: Forbidden
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PlatformError'
+ '500':
+ description: Internal Server Error
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PlatformError'
+ post:
+ summary: Generate org-level report
+ description: Creates a new report in pending status.
+ operationId: v2.organization.reports.create
+ tags:
+ - Reports
+ parameters:
+ - name: organizationId
+ in: path
+ required: true
+ schema:
+ $ref: '#/components/schemas/OrganizationIdString'
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ type:
+ $ref: '#/components/schemas/SnowflakeReportType'
+ format:
+ $ref: '#/components/schemas/ReportFormatType'
+ holdings:
+ type: object
+ description: Holdings report
+ properties:
+ byWallet:
+ type: boolean
+ enterprise:
+ type: string
+ description: ID of the enterprise
+ example: 59cd72485007a239fb00282ed480da1f
+ minLength: 1
+ pattern: ^[0-9a-f]{32}$
+ includeStaking:
+ type: boolean
+ snapshotDate:
+ type: string
+ description: Date of the snapshot
+ format: date-time
+ title: ISO Date String
+ required:
+ - enterprise
+ - snapshotDate
+ transactions:
+ type: object
+ description: Transactions report
+ properties:
+ assets:
+ type: array
+ items:
+ type: string
+ minLength: 1
+ endDate:
+ type: string
+ description: Date of the snapshot
+ format: date-time
+ title: ISO Date String
+ enterprise:
+ $ref: '#/components/schemas/EnterpriseIdNonEmptyString'
+ isAddressReport:
+ type: boolean
+ isDetailed:
+ type: boolean
+ startDate:
+ type: string
+ description: Date of the snapshot
+ format: date-time
+ title: ISO Date String
+ wallets:
+ type: array
+ items:
+ type: string
+ minLength: 1
+ example: 59cd72485007a239fb00282ed480da1f
+ walletTypes:
+ type: array
+ items:
+ type: string
+ minLength: 1
+ required:
+ - endDate
+ - enterprise
+ - startDate
+ quarterly:
+ type: object
+ description: Quarterly report
+ properties:
+ endDate:
+ type: string
+ description: Date of the snapshot
+ format: date-time
+ title: ISO Date String
+ enterprise:
+ $ref: '#/components/schemas/EnterpriseIdNonEmptyString'
+ startDate:
+ type: string
+ description: Date of the snapshot
+ format: date-time
+ title: ISO Date String
+ required:
+ - endDate
+ - enterprise
+ - startDate
+ trades:
+ type: object
+ description: Trades report
+ properties:
+ assets:
+ type: array
+ items:
+ type: string
+ minLength: 1
+ endDate:
+ type: string
+ description: Date of the snapshot
+ format: date-time
+ title: ISO Date String
+ enterprise:
+ $ref: '#/components/schemas/EnterpriseIdNonEmptyString'
+ isFillsReport:
+ type: boolean
+ startDate:
+ type: string
+ description: Date of the snapshot
+ format: date-time
+ title: ISO Date String
+ required:
+ - endDate
+ - enterprise
+ - startDate
+ staking:
+ type: object
+ description: Staking report
+ properties:
+ assets:
+ type: array
+ items:
+ type: string
+ minLength: 1
+ endDate:
+ type: string
+ description: Date of the snapshot
+ format: date-time
+ title: ISO Date String
+ enterprise:
+ $ref: '#/components/schemas/EnterpriseIdNonEmptyString'
+ isBalanceReport:
+ type: boolean
+ startDate:
+ type: string
+ description: Date of the snapshot
+ format: date-time
+ title: ISO Date String
+ wallets:
+ type: array
+ items:
+ type: string
+ minLength: 1
+ example: 59cd72485007a239fb00282ed480da1f
+ walletTypes:
+ type: array
+ items:
+ type: string
+ minLength: 1
+ required:
+ - endDate
+ - enterprise
+ - startDate
+ holdingsByAddress:
+ type: object
+ description: Address-level Holdings report
+ properties:
+ assets:
+ type: array
+ items:
+ type: string
+ minLength: 1
+ enterprise:
+ type: string
+ minLength: 1
+ snapshotDate:
+ type: string
+ format: date-time
+ title: ISO Date String
+ wallets:
+ type: array
+ items:
+ type: string
+ minLength: 1
+ example: 59cd72485007a239fb00282ed480da1f
+ walletTypes:
+ type: array
+ items:
+ type: string
+ minLength: 1
+ required:
+ - enterprise
+ - snapshotDate
+ organizationHoldings:
+ type: object
+ description: Organization-level Holdings report
+ properties:
+ byWallet:
+ type: boolean
+ enterprises:
+ type: array
+ items:
+ type: string
+ minLength: 1
+ includeStaking:
+ type: boolean
+ organization:
+ type: string
+ minLength: 1
+ snapshotDate:
+ type: string
+ format: date-time
+ title: ISO Date String
+ required:
+ - enterprises
+ - organization
+ - snapshotDate
+ organizationTransactions:
+ type: object
+ description: Organization-level Transactions report
+ properties:
+ assets:
+ type: array
+ items:
+ type: string
+ minLength: 1
+ endDate:
+ type: string
+ format: date-time
+ title: ISO Date String
+ enterprises:
+ type: array
+ items:
+ type: string
+ minLength: 1
+ isAddressReport:
+ type: boolean
+ isDetailed:
+ type: boolean
+ organization:
+ type: string
+ minLength: 1
+ startDate:
+ type: string
+ format: date-time
+ title: ISO Date String
+ wallets:
+ type: array
+ items:
+ type: string
+ minLength: 1
+ example: 59cd72485007a239fb00282ed480da1f
+ walletTypes:
+ type: array
+ items:
+ type: string
+ minLength: 1
+ required:
+ - endDate
+ - enterprises
+ - organization
+ - startDate
+ organizationHoldingsByAddress:
+ type: object
+ description: Organization-level Holdings by Address report
+ properties:
+ assets:
+ type: array
+ items:
+ type: string
+ minLength: 1
+ enterprises:
+ type: array
+ items:
+ type: string
+ minLength: 1
+ organization:
+ type: string
+ minLength: 1
+ snapshotDate:
+ type: string
+ format: date-time
+ title: ISO Date String
+ wallets:
+ type: array
+ items:
+ type: string
+ minLength: 1
+ example: 59cd72485007a239fb00282ed480da1f
+ walletTypes:
+ type: array
+ items:
+ type: string
+ minLength: 1
+ required:
+ - enterprises
+ - organization
+ - snapshotDate
+ organizationStaking:
+ type: object
+ description: Organization-level Staking report
+ properties:
+ assets:
+ type: array
+ items:
+ type: string
+ minLength: 1
+ endDate:
+ type: string
+ format: date-time
+ title: ISO Date String
+ enterprises:
+ type: array
+ items:
+ type: string
+ minLength: 1
+ isBalanceReport:
+ type: boolean
+ organization:
+ type: string
+ minLength: 1
+ startDate:
+ type: string
+ format: date-time
+ title: ISO Date String
+ wallets:
+ type: array
+ items:
+ type: string
+ minLength: 1
+ example: 59cd72485007a239fb00282ed480da1f
+ walletTypes:
+ type: array
+ items:
+ type: string
+ minLength: 1
+ required:
+ - endDate
+ - enterprises
+ - organization
+ - startDate
+ organizationTrades:
+ type: object
+ description: Organization-level Trades report
+ properties:
+ assets:
+ type: array
+ items:
+ type: string
+ minLength: 1
+ endDate:
+ type: string
+ format: date-time
+ title: ISO Date String
+ enterprises:
+ type: array
+ items:
+ type: string
+ minLength: 1
+ isFillsReport:
+ type: boolean
+ organization:
+ type: string
+ minLength: 1
+ startDate:
+ type: string
+ format: date-time
+ title: ISO Date String
+ required:
+ - endDate
+ - enterprises
+ - organization
+ - startDate
+ required:
+ - type
+ - format
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ReportJSON'
+ '400':
+ description: Bad Request
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PlatformError'
+ '401':
+ description: Unauthorized
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PlatformError'
+ '403':
+ description: Forbidden
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PlatformError'
+ '500':
+ description: Internal Server Error
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PlatformError'
/api/v2/organization/{organizationId}/user:
delete:
summary: Remove a user from an organization
@@ -26588,6 +27131,11 @@ paths:
- trades
- staking
- holdingsByAddress
+ - organizationHoldings
+ - organizationHoldingsByAddress
+ - organizationTransactions
+ - organizationTrades
+ - organizationStaking
- name: status
description: Only return rports for this report status
in: query
@@ -26847,6 +27395,186 @@ paths:
required:
- enterprise
- snapshotDate
+ organizationHoldings:
+ type: object
+ description: Organization-level Holdings report
+ properties:
+ byWallet:
+ type: boolean
+ enterprises:
+ type: array
+ items:
+ type: string
+ minLength: 1
+ includeStaking:
+ type: boolean
+ organization:
+ type: string
+ minLength: 1
+ snapshotDate:
+ type: string
+ format: date-time
+ title: ISO Date String
+ required:
+ - enterprises
+ - organization
+ - snapshotDate
+ organizationTransactions:
+ type: object
+ description: Organization-level Transactions report
+ properties:
+ assets:
+ type: array
+ items:
+ type: string
+ minLength: 1
+ endDate:
+ type: string
+ format: date-time
+ title: ISO Date String
+ enterprises:
+ type: array
+ items:
+ type: string
+ minLength: 1
+ isAddressReport:
+ type: boolean
+ isDetailed:
+ type: boolean
+ organization:
+ type: string
+ minLength: 1
+ startDate:
+ type: string
+ format: date-time
+ title: ISO Date String
+ wallets:
+ type: array
+ items:
+ type: string
+ minLength: 1
+ example: 59cd72485007a239fb00282ed480da1f
+ walletTypes:
+ type: array
+ items:
+ type: string
+ minLength: 1
+ required:
+ - endDate
+ - enterprises
+ - organization
+ - startDate
+ organizationHoldingsByAddress:
+ type: object
+ description: Organization-level Holdings by Address report
+ properties:
+ assets:
+ type: array
+ items:
+ type: string
+ minLength: 1
+ enterprises:
+ type: array
+ items:
+ type: string
+ minLength: 1
+ organization:
+ type: string
+ minLength: 1
+ snapshotDate:
+ type: string
+ format: date-time
+ title: ISO Date String
+ wallets:
+ type: array
+ items:
+ type: string
+ minLength: 1
+ example: 59cd72485007a239fb00282ed480da1f
+ walletTypes:
+ type: array
+ items:
+ type: string
+ minLength: 1
+ required:
+ - enterprises
+ - organization
+ - snapshotDate
+ organizationStaking:
+ type: object
+ description: Organization-level Staking report
+ properties:
+ assets:
+ type: array
+ items:
+ type: string
+ minLength: 1
+ endDate:
+ type: string
+ format: date-time
+ title: ISO Date String
+ enterprises:
+ type: array
+ items:
+ type: string
+ minLength: 1
+ isBalanceReport:
+ type: boolean
+ organization:
+ type: string
+ minLength: 1
+ startDate:
+ type: string
+ format: date-time
+ title: ISO Date String
+ wallets:
+ type: array
+ items:
+ type: string
+ minLength: 1
+ example: 59cd72485007a239fb00282ed480da1f
+ walletTypes:
+ type: array
+ items:
+ type: string
+ minLength: 1
+ required:
+ - endDate
+ - enterprises
+ - organization
+ - startDate
+ organizationTrades:
+ type: object
+ description: Organization-level Trades report
+ properties:
+ assets:
+ type: array
+ items:
+ type: string
+ minLength: 1
+ endDate:
+ type: string
+ format: date-time
+ title: ISO Date String
+ enterprises:
+ type: array
+ items:
+ type: string
+ minLength: 1
+ isFillsReport:
+ type: boolean
+ organization:
+ type: string
+ minLength: 1
+ startDate:
+ type: string
+ format: date-time
+ title: ISO Date String
+ required:
+ - endDate
+ - enterprises
+ - organization
+ - startDate
required:
- type
- format
@@ -27052,7 +27780,7 @@ paths:
post:
summary: Freeze User
description: |-
- Route for users to freeze their account. Requires the 'user_manage' scope.
+ Route for users to freeze their account. Requires the `user_manage` scope.
Session must be unlocked using the [unlock](https://developers.bitgo.com/api/user.unlock) endpoint, prior to hitting this route.
In the UI, call to this route is followed by a call to [logout](https://developers.bitgo.com/api/user.logout) endpoint.
operationId: v2.user.freeze
@@ -27152,7 +27880,7 @@ paths:
get:
summary: Get Recovery Codes
description: |-
- Get the recovery codes for the given recovery code set ID. Requires the 'user_manage' scope.
+ Get the recovery codes for the given recovery code set ID. Requires the `user_manage` scope.
Session must be unlocked using the [unlock](https://developers.bitgo.com/api/user.unlock)
endpoint, prior to hitting this route.
operationId: v2.user.recoveryCodes.getById
@@ -27747,10 +28475,6 @@ paths:
type: string
blockHeight:
type: number
- blockHash:
- type: string
- blockPosition:
- type: number
inputIds: {}
entries: {}
inputs: {}
@@ -27769,14 +28493,16 @@ paths:
type: string
confirmations:
type: number
+ blockHash:
+ type: string
+ blockPosition:
+ type: number
label:
type: string
required:
- id
- normalizedTxHash
- blockHeight
- - blockHash
- - blockPosition
- inputIds
- entries
- inputs
@@ -28660,8 +29386,8 @@ paths:
put:
summary: Update wire withdrawal
description: |-
- Approve or reject a pending wire withdrawal. If approving, the 'state' updates to 'confirmed', enabling
- BitGo Trust to wire transfer the funds. If rejecting, the 'state' updates to 'rejected', canceling
+ Approve or reject a pending wire withdrawal. If approving, the `state` updates to `confirmed`, enabling
+ BitGo Trust to wire transfer the funds. If rejecting, the `state` updates to `rejected`, canceling
the pending wire transfer.
operationId: v2.wallet.wireWithdrawals.confirm
tags:
@@ -28936,7 +29662,7 @@ paths:
example: 59cd72485007a239fb00282ed480da1f
pattern: ^[0-9a-f]{32}$
- name: includeStakingBalances
- description: Include 'stakingBalanceString' and 'rewardBalanceString' properties for each staking wallet.
+ description: Include `stakingBalanceString` and `rewardBalanceString` properties for each staking wallet.
in: query
schema:
type: string
@@ -29026,7 +29752,7 @@ paths:
description: |-
Lists all wallets you can access when the enterprise ID is provided, including:
- Wallets you have a role on (admin, spender, or viewer).
- - Wallets in enterprises you belong to that have the 'View All Wallets' option enabled
+ - Wallets in enterprises you belong to that have the `View All Wallets` option enabled
from the enterprise settings.
If the enterprise ID is not provided, lists only the wallets you have a role on.
@@ -29139,7 +29865,7 @@ paths:
- 'true'
- 'false'
- name: includeStakingBalances
- description: Include 'stakingBalanceString' and 'rewardBalanceString' properties for each staking wallet. Requires 'expandBalance' to be set to true.
+ description: Include `stakingBalanceString` and `rewardBalanceString` properties for each staking wallet. Requires `expandBalance` to be set to true.
in: query
schema:
type: string
@@ -29222,7 +29948,7 @@ paths:
description: |-
Get a count of all wallets you can access, including:
- Wallets you have a role on (admin, spender, or viewer).
- - Wallets in enterprises you belong to that have the 'View All Wallets' option
+ - Wallets in enterprises you belong to that have the `View All Wallets` option
enabled from the enterprise settings.
You can use this endpoint in conjunction with the List wallets endpoint to
@@ -29438,7 +30164,7 @@ paths:
Create a webhook secret for a specified enterprise or organization.
This secret will be used to generate webhook notification signatures so that you can verify that the notification comes from BitGo using the v2.webhook.notification.verify endpoint.
The secret can be rotated by calling this endpoint again at a cadence of once every 5 minutes.
- You must specify exactly one of 'enterpriseId' or 'organizationId'.
+ You must specify exactly one of `enterpriseId` or `organizationId`.
The requester must be an admin of the specified enterprise or organization.
operationId: v2.webhook.secret.create
tags:
@@ -30497,7 +31223,7 @@ components:
allowMultiple: false
values: []
InactivePolicyRuleExample:
- summary: An 'INACTIVE' policy rule
+ summary: An `INACTIVE` policy rule
value:
uniqueId: c5a818c7-1831-4fe2-8363-d469378bb106
id: 4fa8326b-4f5f-4065-8cfc-85a08c290c49
@@ -32504,14 +33230,14 @@ components:
dateGte:
name: dateGte
in: query
- description: Return transfers with a 'date' that is greater than or equal to the given timestamp
+ description: Return transfers with a `date` that is greater than or equal to the given timestamp
schema:
type: string
format: date-time
dateLt:
name: dateLt
in: query
- description: Return transfers with a 'date' that is less than the given timestamp
+ description: Return transfers with a `date` that is less than the given timestamp
schema:
type: string
format: date-time
@@ -32526,7 +33252,7 @@ components:
enforceMinConfirmsForChange:
name: enforceMinConfirmsForChange
in: query
- description: Enforces 'minConfirms' on change inputs
+ description: Enforces `minConfirms` on change inputs
schema:
type: boolean
enterprise:
@@ -32552,7 +33278,7 @@ components:
expandAddressLabels:
name: expandAddressLabels
description: |
- If true, adds 'addressLabels' to each returned pending approval associated with recipient's addresses
+ If true, adds `addressLabels` to each returned pending approval associated with recipient's addresses
in: query
schema:
type: boolean
@@ -32576,7 +33302,7 @@ components:
minimum: 1
maximum: 500
default: 25
- description: Maximum number of results to return. If the result set is truncated, use the 'nextBatchPrevId' value to get the next batch.
+ description: Maximum number of results to return. If the result set is truncated, use the `nextBatchPrevId` value to get the next batch.
maxFeeRate:
name: maxFeeRate
in: query
@@ -32592,7 +33318,7 @@ components:
minConfirms:
name: minConfirms
in: query
- description: Minimum number of confirmations for the collected inputs. Only applies to external unspents. Use 'enforceMinConfirmsForChange' to filter change as well.
+ description: Minimum number of confirmations for the collected inputs. Only applies to external unspents. Use `enforceMinConfirmsForChange` to filter change as well.
schema:
type: integer
minimum: 0
@@ -32618,9 +33344,9 @@ components:
minimum: 1
maximum: 1000
description: |
- (BTC only) The number of blocks required to confirm a transaction. You can use 'numBlocks' to estimate the fee rate by targeting confirmation within a given number of blocks. If both 'feeRate' and 'numBlocks' are absent, the transaction defaults to 2 blocks for confirmation.
+ (BTC only) The number of blocks required to confirm a transaction. You can use `numBlocks` to estimate the fee rate by targeting confirmation within a given number of blocks. If both `feeRate` and `numBlocks` are absent, the transaction defaults to 2 blocks for confirmation.
- Note: The 'maxFeeRate' limits the fee rate generated by 'numBlocks'.
+ Note: The `maxFeeRate` limits the fee rate generated by `numBlocks`.
organizationId:
name: organizationId
in: query
@@ -32705,7 +33431,7 @@ components:
schema:
type: string
description: |
- A 'sequenceId' is a unique and arbitrary wallet identifier applied to transfers and transactions at creation. It is optional but highly recommended. With a 'sequenceId' you can easily reference transfers and transactions—for example, to safely retry sending. Because the system only confirms one send request per 'sequenceId' (and fails all subsequent attempts), you can retry sending without the risk of double spending. The 'sequenceId' is only visible to users on the wallet and is not shared publicly.
+ A `sequenceId` is a unique and arbitrary wallet identifier applied to transfers and transactions at creation. It is optional but highly recommended. With a `sequenceId` you can easily reference transfers and transactions—for example, to safely retry sending. Because the system only confirms one send request per `sequenceId` (and fails all subsequent attempts), you can retry sending without the risk of double spending. The `sequenceId` is only visible to users on the wallet and is not shared publicly.
pathShareId:
name: shareId
in: path
@@ -32752,7 +33478,7 @@ components:
name: prevId
schema:
$ref: '#/components/schemas/Id'
- description: Return the next batch of results, based on the 'nextBatchPrevId' value from the previous batch.
+ description: Return the next batch of results, based on the `nextBatchPrevId` value from the previous batch.
queryCoin:
name: coin
in: query
@@ -32853,18 +33579,18 @@ components:
name: searchLabel
in: query
example: My very first wallet
- description: Query for 'Wallets' with a label containing this string
+ description: Query for `Wallets` with a label containing this string
schema:
type: string
segwit:
name: segwit
in: query
- description: DEPRECATED. Mutually exclusive with 'chains'. Returns only 'p2shP2wsh' unspents/addresses on true. Returns only 'p2sh' unspents/addresses on false. Equivalent to passing 10 and 11 as the only value in 'chains' on true, 0 and 1 on false.
+ description: DEPRECATED. Mutually exclusive with `chains`. Returns only `p2shP2wsh` unspents/addresses on true. Returns only `p2sh` unspents/addresses on false. Equivalent to passing 10 and 11 as the only value in `chains` on true, 0 and 1 on false.
schema:
type: boolean
showAllWallets:
name: showAllWallets
- description: Include wallets that have 'deleted' or 'creationFailed' set to **true**
+ description: Include wallets that have `deleted` or `creationFailed` set to **true**
in: query
schema:
type: boolean
@@ -32881,14 +33607,14 @@ components:
name: state
description: |
The status of the transfer.
- • 'confirmed' indicates the transaction is confirmed on chain.
- • 'failed' indicates the transaction failed. 'initialized' is the first state of a transaction and indicates the transaction is initialized.
- • 'pendingApproval' indicates the transaction is initialized and pending approval.
- • 'rejected' indicates the transaction was rejected by an approver.
- • 'removed' indicates the transaction was reorganized from the mempool (it's still possible recieve confirmation in another block).
- • 'replaced' indicates the transaction was replaced with a new transaction with higher fees.
- • 'signed' indicates the transaction is signed and pending on-chain confirmation.
- • 'unconfirmed' indicates the transaction is pending on-chain confirmation.
+ • `confirmed` indicates the transaction is confirmed on chain.
+ • `failed` indicates the transaction failed. `initialized` is the first state of a transaction and indicates the transaction is initialized.
+ • `pendingApproval` indicates the transaction is initialized and pending approval.
+ • `rejected` indicates the transaction was rejected by an approver.
+ • `removed` indicates the transaction was reorganized from the mempool (it's still possible recieve confirmation in another block).
+ • `replaced` indicates the transaction was replaced with a new transaction with higher fees.
+ • `signed` indicates the transaction is signed and pending on-chain confirmation.
+ • `unconfirmed` indicates the transaction is pending on-chain confirmation.
in: query
schema:
type: array
@@ -32912,7 +33638,7 @@ components:
type:
name: type
in: query
- description: Filter on sending or receiving 'Transfers'
+ description: Filter on sending or receiving `Transfers`
schema:
type: string
enum:
@@ -32929,13 +33655,13 @@ components:
valueGte:
name: valueGte
in: query
- description: Return transfers with a 'value' that is greater than or equal to the given number
+ description: Return transfers with a `value` that is greater than or equal to the given number
schema:
type: integer
valueLt:
name: valueLt
in: query
- description: Return transfers with a 'value' that is less than the given number
+ description: Return transfers with a `value` that is less than the given number
schema:
type: integer
walletId:
@@ -33518,7 +34244,7 @@ components:
allOf:
- type: object
- $ref: '#/components/schemas/AddressBalance'
- description: Balance of the address. In case of Eth and Celo, if returnBalancesForToken is passed with includeBalances, then it will return token balance in the address object. This field will be present only when 'includeBalances' query param is passed as true.
+ description: Balance of the address. In case of Eth and Celo, if returnBalancesForToken is passed with includeBalances, then it will return token balance in the address object. This field will be present only when `includeBalances` query param is passed as true.
label:
$ref: '#/components/schemas/AddressLabel'
addressType:
@@ -33536,7 +34262,7 @@ components:
example: 50000
balanceString:
type: string
- description: String representation of 'balance'. Guaranteed to not lose precision.
+ description: String representation of `balance`. Guaranteed to not lose precision.
example: '50000'
totalReceived:
type: integer
@@ -33683,10 +34409,10 @@ components:
$ref: '#/components/schemas/CoinString'
pendingAddressCount:
type: number
- description: Total number of addresses pending on-chain initialization on this wallet **Note:** for wallets with many addresses (100,000 or more), this property may be omitted for performance reasons. If the pending address count is needed for a large wallet, the 'includeTotalAddressCount' query parameter can be used to force an address count to be returned with the initial page of addresses.
+ description: Total number of addresses pending on-chain initialization on this wallet **Note:** for wallets with many addresses (100,000 or more), this property may be omitted for performance reasons. If the pending address count is needed for a large wallet, the `includeTotalAddressCount` query parameter can be used to force an address count to be returned with the initial page of addresses.
totalAddressCount:
type: number
- description: Total number of addresses which match the provided query parameters. **Note:** for wallets with many addresses (100,000 or more), this property may be omitted for performance reasons. If the total address count is needed for a large wallet, the 'includeTotalAddressCount' query parameter can be used to force an address count to be returned with the initial page of addresses.
+ description: Total number of addresses which match the provided query parameters. **Note:** for wallets with many addresses (100,000 or more), this property may be omitted for performance reasons. If the total address count is needed for a large wallet, the `includeTotalAddressCount` query parameter can be used to force an address count to be returned with the initial page of addresses.
addresses:
type: array
items:
@@ -33709,7 +34435,7 @@ components:
- $ref: '#/components/schemas/BaseWalletAddress'
nextBatchPrevId:
type: string
- description: When a result set is truncated, this field returns the id of the last object in the previous batch. To get the next batch of results, pass this value via the 'prevId' query parameter.
+ description: When a result set is truncated, this field returns the id of the last object in the previous batch. To get the next batch of results, pass this value via the `prevId` query parameter.
example: 585951a5df8380e0e3063e9f
format: uuid
count:
@@ -33943,6 +34669,7 @@ components:
- wlf
- walrus
- mtgox
+ - landingPageReferral
Agreements:
title: Agreements
type: object
@@ -34107,10 +34834,10 @@ components:
status:
type: string
description: |
- Status of the action. Indicates if the Actions is usable 'ACTIVE' or not 'INACTIVE'.
+ Status of the action. Indicates if the Actions is usable `ACTIVE` or not `INACTIVE`.
- * 'ACTIVE' - The action is available for use.
- * 'INACTIVE' - The action is NOT available for use.
+ * `ACTIVE` - The action is available for use.
+ * `INACTIVE` - The action is NOT available for use.
enum:
- ACTIVE
- INACTIVE
@@ -34918,6 +35645,21 @@ components:
BNSupportedCurrency:
title: BNSupportedCurrency
type: string
+ BabyCreateBtcDelegationIntent:
+ title: Baby CreateBtcDelegation Intent
+ allOf:
+ - type: object
+ properties:
+ intentType:
+ type: string
+ enum:
+ - createBtcDelegation
+ createBtcDelegationBytes:
+ type: string
+ required:
+ - intentType
+ - createBtcDelegationBytes
+ - $ref: '#/components/schemas/BaseStakeIntent'
BackingValue:
title: Backing hot wallet
type: object
@@ -34970,7 +35712,7 @@ components:
BankAccountCurrency:
title: BankAccountCurrency
description: |
- The currency of the bank account. If null, defaults to 'fiatusd'.
+ The currency of the bank account. If null, defaults to `fiatusd`.
type: string
nullable: true
enum:
@@ -35016,8 +35758,8 @@ components:
type: string
example: 5c645791cf8eb19304292a8e3365fee3
description: |
- Unique identifier for this account, derived from 'accountNumber',
- 'routingNumber', and 'swiftCode'
+ Unique identifier for this account, derived from `accountNumber`,
+ `routingNumber`, and `swiftCode`
BankAccountJson:
title: BankAccountJson
type: object
@@ -35081,8 +35823,8 @@ components:
BankAccountResponse:
type: object
description: |
- An external bank account. 'routingNumber' must be set for US bank accounts.
- 'swiftCode' must be set for banks outside the US.
+ An external bank account. `routingNumber` must be set for US bank accounts.
+ `swiftCode` must be set for banks outside the US.
properties:
accountNumber:
description: Bank account number or IBAN.
@@ -35182,7 +35924,7 @@ components:
BankAccountType:
title: BankAccountType
description: |
- The type of bank account. If null, defaults 'wire'.
+ The type of bank account. If null, defaults `wire`.
type: string
nullable: true
enum:
@@ -35237,18 +35979,18 @@ components:
sequenceId:
type: string
description: |
- A 'sequenceId' is a unique and arbitrary wallet identifier applied to transfers and transactions at creation. It is optional but highly recommended. With a 'sequenceId' you can easily reference transfers and transactions—for example, to safely retry sending. Because BitGo only confirms one send request per 'sequenceId' (and fails all subsequent attempts), you can retry sending without the risk of double spending. The 'sequenceId' is only visible to users on the wallet and is not shared publicly. It is the responsibility of the caller to keep track of this ID.
+ A `sequenceId` is a unique and arbitrary wallet identifier applied to transfers and transactions at creation. It is optional but highly recommended. With a `sequenceId` you can easily reference transfers and transactions—for example, to safely retry sending. Because BitGo only confirms one send request per `sequenceId` (and fails all subsequent attempts), you can retry sending without the risk of double spending. The `sequenceId` is only visible to users on the wallet and is not shared publicly. It is the responsibility of the caller to keep track of this ID.
example: abc123
comment:
type: string
- description: The 'comment' is only visible to users on the wallet and is not shared publicly.
+ description: The `comment` is only visible to users on the wallet and is not shared publicly.
nonce:
type: string
description: The 'nonce' of a transaction (optional)
memo:
type: string
description: |
- A 'memo' is an additional address feature necessary for identifying a transaction recipient beyond wallet address.
+ A `memo` is an additional address feature necessary for identifying a transaction recipient beyond wallet address.
required:
- intentType
BaseIntentWithoutNonce:
@@ -35294,6 +36036,16 @@ components:
required:
- stakingRequestId
- $ref: '#/components/schemas/BaseIntent'
+ BaseStakeIntent1:
+ title: BaseStakeIntent
+ allOf:
+ - type: object
+ properties:
+ stakingRequestId:
+ type: string
+ required:
+ - stakingRequestId
+ - $ref: '#/components/schemas/BaseIntent1'
BaseStakeIntent2:
allOf:
- $ref: '#/components/schemas/BaseIntent2'
@@ -35517,17 +36269,17 @@ components:
description: |
Required for transactions from MPC wallets. "acceleration" speeds up transactions with a certain nonce by adjusting the gas setting. "accountSet" is for XRP AccountSet transactions. "enabletoken" is for SOL. "stakingLock" and "stakingUnlock" are for Stacks delegations. "transfer" is for native-asset transfers. "trustline" is for Stellar trustline transactions. Possible types include: [acceleration, accountSet, enabletoken, stakingLock, stakingUnlock, transfer, transfertoken, trustline]
- For AVAX, possible types include: 'addValidator', 'export', and 'import'.
+ For AVAX, possible types include: `addValidator`, `export`, and `import`.
- For XRP, possible types include: 'payment' and 'accountSet'. The default is 'payment'.
+ For XRP, possible types include: `payment` and `accountSet`. The default is `payment`.
For STX, type is required.
numBlocks:
type: integer
description: |
- (BTC only) The number of blocks required to confirm a transaction. You can use 'numBlocks' to estimate the fee rate by targeting confirmation within a given number of blocks. If both 'feeRate' and 'numBlocks' are absent, the transaction defaults to 2 blocks for confirmation.
+ (BTC only) The number of blocks required to confirm a transaction. You can use `numBlocks` to estimate the fee rate by targeting confirmation within a given number of blocks. If both `feeRate` and `numBlocks` are absent, the transaction defaults to 2 blocks for confirmation.
- Note: The 'maxFeeRate' limits the fee rate generated by 'numBlocks'.
+ Note: The `maxFeeRate` limits the fee rate generated by `numBlocks`.
minimum: 2
maximum: 1000
feeRate:
@@ -35537,29 +36289,29 @@ components:
description: |
Custom fee rate (in base units) per kilobyte (or virtual kilobyte). For example, satoshis per kvByte.
- If the 'feeRate' is less than the minimum required network fee, then the minimum fee applies. For example, 1000 sat/kvByte, a flat 1000 microAlgos, or a flat 10 drops of xrp. For XRP, the actual fee is usually 4.5 times the open ledger fee.
+ If the `feeRate` is less than the minimum required network fee, then the minimum fee applies. For example, 1000 sat/kvByte, a flat 1000 microAlgos, or a flat 10 drops of xrp. For XRP, the actual fee is usually 4.5 times the open ledger fee.
- Note: The 'feeRate' overrides the 'maxFeeRate' and 'minFeeRate'.
+ Note: The `feeRate` overrides the `maxFeeRate` and `minFeeRate`.
maxFeeRate:
allOf:
- $ref: '#/components/schemas/IntegerOrIntegerString'
- example: 20000
description: |
- (BTC only) The maximum fee rate (in base units) per kilobyte (or virtual kilobyte). For example, satoshis per kvByte. The 'maxFeeRate' limits the fee rate generated by both 'feeMultiplier' and 'numBlocks'.
+ (BTC only) The maximum fee rate (in base units) per kilobyte (or virtual kilobyte). For example, satoshis per kvByte. The `maxFeeRate` limits the fee rate generated by both `feeMultiplier` and `numBlocks`.
- Note: The 'feeRate' overrides the 'maxFeeRate'.
+ Note: The `feeRate` overrides the `maxFeeRate`.
feeMultiplier:
allOf:
- $ref: '#/components/schemas/NumberOrString'
- example: 1.5
description: |
- (UTXO only) Custom multiplier to the 'feeRate'. The resulting fee rate is limited by the 'maxFeeRate'. For replace-by-fee (RBF) transactions (that include 'rbfTxIds'), the 'feeMultiplier' must be greater than 1, since it's an absolute fee multiplier to the transaction being replaced.
+ (UTXO only) Custom multiplier to the `feeRate`. The resulting fee rate is limited by the `maxFeeRate`. For replace-by-fee (RBF) transactions (that include `rbfTxIds`), the `feeMultiplier` must be greater than 1, since it's an absolute fee multiplier to the transaction being replaced.
- Note: The 'maxFeeRate' limits the fee rate generated by 'feeMultiplier'.
+ Note: The `maxFeeRate` limits the fee rate generated by `feeMultiplier`.
minConfirms:
type: integer
description: |
- The unspent selection for the transaction will only consider unspents with at least this many confirmations to be used as inputs. Does not apply to change outputs unless used in combination with 'enforceMinConfirmsForChange'.
+ The unspent selection for the transaction will only consider unspents with at least this many confirmations to be used as inputs. Does not apply to change outputs unless used in combination with `enforceMinConfirmsForChange`.
enforceMinConfirmsForChange:
type: boolean
description: When set to true, will enforce minConfirms for change outputs. Defaults to false.
@@ -35587,10 +36339,10 @@ components:
type: integer
description: |
Specifies the minimum count of good-sized unspents to maintain in the wallet. Change splitting ceases when the
- wallet has 'targetWalletUnspents' good-sized unspents.
+ wallet has `targetWalletUnspents` good-sized unspents.
**Note**: Wallets that continuously send a high count of transactions will automatically split large change amounts
- into multiple good-sized change outputs while they have fewer than 'targetWalletUnspents' good-sized unspents in
+ into multiple good-sized change outputs while they have fewer than `targetWalletUnspents` good-sized unspents in
their unspent pool. Breaking up large unspents helps to reduce the amount of unconfirmed funds in flight in future
transactions, and helps to avoid long chains of unconfirmed transactions. This is especially useful for newly
funded wallets or recently refilled send-only wallets.
@@ -35606,7 +36358,7 @@ components:
sequenceId:
type: string
description: |
- A 'sequenceId' is a unique and arbitrary wallet identifier applied to transfers and transactions at creation. It is optional but highly recommended. With a 'sequenceId' you can easily reference transfers and transactions—for example, to safely retry sending. Because the system only confirms one send request per 'sequenceId' (and fails all subsequent attempts), you can retry sending without the risk of double spending. The 'sequenceId' is only visible to users on the wallet and is not shared publicly.
+ A `sequenceId` is a unique and arbitrary wallet identifier applied to transfers and transactions at creation. It is optional but highly recommended. With a `sequenceId` you can easily reference transfers and transactions—for example, to safely retry sending. Because the system only confirms one send request per `sequenceId` (and fails all subsequent attempts), you can retry sending without the risk of double spending. The `sequenceId` is only visible to users on the wallet and is not shared publicly.
nonce:
allOf:
- $ref: '#/components/schemas/IntegerString'
@@ -35617,9 +36369,9 @@ components:
noSplitChange:
type: boolean
description: |
- Set 'true' to disable automatic change splitting.
+ Set `true` to disable automatic change splitting.
- Also see: 'targetWalletUnspents'
+ Also see: `targetWalletUnspents`
default: false
unspents:
type: array
@@ -35627,7 +36379,7 @@ components:
example: 12b147dd8b4f73c01f72bdbf5b589eea614f3de609ffdbdac84852d6505cf8a3:1
type: string
description: |
- Used to explicitly specify the unspents to be used in the input set in the transaction. Each unspent should be in the form 'prevTxId:nOutput'.
+ Used to explicitly specify the unspents to be used in the input set in the transaction. Each unspent should be in the form `prevTxId:nOutput`.
changeAddress:
allOf:
- $ref: '#/components/schemas/AddressString3'
@@ -35661,13 +36413,13 @@ components:
type: string
deprecated: true
description: |-
- DEPRECATED - use 'changeAddressType'.
- The type of address to create for change. One of 'p2sh', 'p2shP2wsh', 'p2wsh', or 'p2tr'.
+ DEPRECATED - use `changeAddressType`.
+ The type of address to create for change. One of `p2sh`, `p2shP2wsh`, `p2wsh`, or `p2tr`.
changeAddressType:
anyOf:
- $ref: '#/components/schemas/AddressType'
- $ref: '#/components/schemas/ChangeAddressTypes'
- description: The address type for the change address. One of 'p2sh', 'p2shP2wsh', 'p2wsh', 'p2tr' or 'p2trMusig2'.
+ description: The address type for the change address. One of `p2sh`, `p2shP2wsh`, `p2wsh`, `p2tr` or `p2trMusig2`.
startTime:
type: string
description: Unix timestamp in seconds.nanoseconds format, denoting the start of the validity window. Only for HBAR transactions.
@@ -35708,7 +36460,7 @@ components:
description: Required object for staking. Only for CSPR and STX.
messageKey:
type: string
- description: Optional parameter that takes a hexadecimal value to set 'messagekey' for an XRP 'accountSet' transaction. Recipients field should be empty when 'messageKey' is set.
+ description: Optional parameter that takes a hexadecimal value to set `messagekey` for an XRP `accountSet` transaction. Recipients field should be empty when `messageKey` is set.
reservation:
type: object
properties:
@@ -35819,8 +36571,8 @@ components:
title: CBIT Bank Account
type: object
description: |
- An external bank account. 'routingNumber' must be set for US bank accounts.
- 'swiftCode' must be set for banks outside the US.
+ An external bank account. `routingNumber` must be set for US bank accounts.
+ `swiftCode` must be set for banks outside the US.
properties:
accountNumber:
description: Bank account number or IBAN.
@@ -35921,7 +36673,7 @@ components:
type: integer
description: |
Current number of admins on the wallet. This number must be
- greater than 'approvalsRequired', since an admin cannot approve
+ greater than `approvalsRequired`, since an admin cannot approve
his/her own operation.
approvalsRequired:
description: Number of admins that must approve a wallet operation
@@ -36040,7 +36792,7 @@ components:
type: array
items:
$ref: '#/components/schemas/AddressType'
- description: The address types for the change address. Order by preference and BitGo uses the first available. Any subset of 'p2sh', 'p2shP2wsh', 'p2wsh', 'p2tr' or 'p2trMusig2'.
+ description: The address types for the change address. Order by preference and BitGo uses the first available. Any subset of `p2sh`, `p2shP2wsh`, `p2wsh`, `p2tr` or `p2trMusig2`.
ChangeFeeResponse:
title: ChangeFeeResponse
type: object
@@ -36351,17 +37103,17 @@ components:
description: |
Custom fee rate (in base units) per kilobyte (or virtual kilobyte). For example, satoshis per kvByte.
- If the 'feeRate' is less than the minimum required network fee, then the minimum fee applies. For example, 1000 sat/kvByte, a flat 1000 microAlgos, or a flat 10 drops of xrp. For XRP, the actual fee is usually 4.5 times the open ledger fee.
+ If the `feeRate` is less than the minimum required network fee, then the minimum fee applies. For example, 1000 sat/kvByte, a flat 1000 microAlgos, or a flat 10 drops of xrp. For XRP, the actual fee is usually 4.5 times the open ledger fee.
- Note: The 'feeRate' overrides the 'maxFeeRate' and 'minFeeRate'.
+ Note: The `feeRate` overrides the `maxFeeRate` and `minFeeRate`.
maxFeeRate:
allOf:
- $ref: '#/components/schemas/IntegerOrIntegerString'
- example: 20000
description: |
- (BTC only) The maximum fee rate (in base units) per kilobyte (or virtual kilobyte). For example, satoshis per kvByte. The 'maxFeeRate' limits the fee rate generated by both 'feeMultiplier' and 'numBlocks'.
+ (BTC only) The maximum fee rate (in base units) per kilobyte (or virtual kilobyte). For example, satoshis per kvByte. The `maxFeeRate` limits the fee rate generated by both `feeMultiplier` and `numBlocks`.
- Note: The 'feeRate' overrides the 'maxFeeRate'.
+ Note: The `feeRate` overrides the `maxFeeRate`.
maxFeePercentage:
type: integer
description: Maximum relative portion that can be spent towards fees
@@ -36370,7 +37122,7 @@ components:
description: Block target for fee estimation
bulk:
type: boolean
- description: Build multiple transactions at the same time. This enables you to increase the maximum number of unspents on the 'limit' parameter up to 2,000. If true, you must pass the 'txFormat' as 'psbt' and you can't pass the 'targetAddress' or 'numUnspentsToMake' parameters.
+ description: Build multiple transactions at the same time. This enables you to increase the maximum number of unspents on the `limit` parameter up to 2,000. If true, you must pass the `txFormat` as `psbt` and you can't pass the `targetAddress` or `numUnspentsToMake` parameters.
minValue:
allOf:
- $ref: '#/components/schemas/IntegerOrIntegerString'
@@ -36724,7 +37476,7 @@ components:
$ref: '#/components/schemas/KeyCreateCoinSpecific'
encryptedPrv:
type: string
- description: Private part of this key pair, encrypted with a passphrase that only the client knows. Required for all sources except 'bitgo'.
+ description: Private part of this key pair, encrypted with a passphrase that only the client knows. Required for all sources except `bitgo`.
source:
$ref: '#/components/schemas/KeySource'
enterprise:
@@ -36791,7 +37543,7 @@ components:
description: |
If set, the rule will only apply to the given coin or ERC20 token in an
Ethereum wallet. It is generally recommended to not set a coin for policy rules of the following types:
- 'advancedWhitelist', 'allTx', 'coinAddressWhitelist', 'coinAddressBlacklist', 'webhook'.
+ `advancedWhitelist`, `allTx`, `coinAddressWhitelist`, `coinAddressBlacklist`, `webhook`.
id:
type: string
description: The id of the rule, must be unique among rules in the policy
@@ -36872,8 +37624,8 @@ components:
description: |
Indicates how the policy rule is locked.
- * 'LOCK_AFTER_DATE' - Will lock after the lockDate set on the policy rule.
- * 'PERMANENT' - Is permanently locked.
+ * `LOCK_AFTER_DATE` - Will lock after the lockDate set on the policy rule.
+ * `PERMANENT` - Is permanently locked.
enum:
- LOCK_AFTER_DATE
- PERMANENT
@@ -36882,7 +37634,7 @@ components:
type: string
description: |
The date after which the policy rule will be locked. Only applicable if the policy rule is locked with
- 'LOCK_AFTER_DATE'.
+ `LOCK_AFTER_DATE`.
format: date-time
example: '2023-11-13T14:49:48.830522Z'
CreatePolicyRuleTriggers:
@@ -36974,7 +37726,7 @@ components:
keys:
allOf:
- $ref: '#/components/schemas/Keys'
- description: This is required for all wallets where the client supplies the keys to be used. The only case where this is not required is when the type is set to 'custodial'.
+ description: This is required for all wallets where the client supplies the keys to be used. The only case where this is not required is when the type is set to `custodial`.
keySignatures:
type: object
properties:
@@ -36993,11 +37745,11 @@ components:
m:
allOf:
- $ref: '#/components/schemas/NumSignatures'
- description: This is required for all wallets where the client supplies the keys to be used. The only case where this is not required is when the type is set to 'custodial'.
+ description: This is required for all wallets where the client supplies the keys to be used. The only case where this is not required is when the type is set to `custodial`.
'n':
allOf:
- $ref: '#/components/schemas/NumKeychains'
- description: This is required for all wallets where the client supplies the keys to be used. The only case where this is not required is when the type is set to 'custodial'.
+ description: This is required for all wallets where the client supplies the keys to be used. The only case where this is not required is when the type is set to `custodial`.
tags:
type: array
items:
@@ -37182,7 +37934,7 @@ components:
- p2trMusig2
- default
description: |
- (UTXO only) The default script type to use for change for this wallet. Per transaction, you override the default with the 'changeAddressType' parameter. If 'default' is provided, it will clear the 'changeAddressType' default on the wallet. Note that each UTXO coin has different address types available. For example, Only BTC supports 'p2tr'.
+ (UTXO only) The default script type to use for change for this wallet. Per transaction, you override the default with the `changeAddressType` parameter. If `default` is provided, it will clear the `changeAddressType` default on the wallet. Note that each UTXO coin has different address types available. For example, Only BTC supports `p2tr`.
DelegationAccrual:
type: object
properties:
@@ -37423,7 +38175,7 @@ components:
minLength: 1
settlementId:
type: string
- description: The unique identifier of the settlement the settlement transfer is associated with. This is a UUID that uniquely identifies the settlement. Will only be undefined if the settlement transfer is in 'pending_settlement_assignment' status.
+ description: The unique identifier of the settlement the settlement transfer is associated with. This is a UUID that uniquely identifies the settlement. Will only be undefined if the settlement transfer is in `pending_settlement_assignment` status.
title: uuid
disputeClosureId:
type: string
@@ -37489,8 +38241,8 @@ components:
title: Domestic Wire Bank Account
type: object
description: |
- An external bank account. 'routingNumber' must be set for US bank accounts.
- 'swiftCode' must be set for banks outside the US.
+ An external bank account. `routingNumber` must be set for US bank accounts.
+ `swiftCode` must be set for banks outside the US.
properties:
accountNumber:
description: Bank account number or IBAN.
@@ -38418,10 +39170,10 @@ components:
status:
type: string
description: |
- Status of the action. Indicates if the Actions is usable 'ACTIVE' or not 'INACTIVE'.
+ Status of the action. Indicates if the Actions is usable `ACTIVE` or not `INACTIVE`.
- * 'ACTIVE' - The action is available for use.
- * 'INACTIVE' - The action is NOT available for use.
+ * `ACTIVE` - The action is available for use.
+ * `INACTIVE` - The action is NOT available for use.
enum:
- ACTIVE
- INACTIVE
@@ -38646,10 +39398,10 @@ components:
status:
type: string
description: |
- Status of the action. Indicates if the Actions is usable 'ACTIVE' or not 'INACTIVE'.
+ Status of the action. Indicates if the Actions is usable `ACTIVE` or not `INACTIVE`.
- * 'ACTIVE' - The action is available for use.
- * 'INACTIVE' - The action is NOT available for use.
+ * `ACTIVE` - The action is available for use.
+ * `INACTIVE` - The action is NOT available for use.
enum:
- ACTIVE
- INACTIVE
@@ -38700,7 +39452,7 @@ components:
example: BITGO_USER_ID
required:
type: string
- description: A value must be always provided for exactly one or more of the action Parameters with a 'required' value of 'ONE_OR_MORE'. In other words, all the action Parameters with a 'required' of 'ONE_OR_MORE' form a group, and a value must be provided for one or more of the action Parameters in the group.
+ description: A value must be always provided for exactly one or more of the action Parameters with a 'required' value of `ONE_OR_MORE`. In other words, all the action Parameters with a 'required' of `ONE_OR_MORE` form a group, and a value must be provided for one or more of the action Parameters in the group.
enum:
- ONE_OR_MORE
example: ONE_OR_MORE
@@ -38912,9 +39664,9 @@ components:
numBlocks:
type: integer
description: |
- (BTC only) The number of blocks required to confirm a transaction. You can use 'numBlocks' to estimate the fee rate by targeting confirmation within a given number of blocks. If both 'feeRate' and 'numBlocks' are absent, the transaction defaults to 2 blocks for confirmation.
+ (BTC only) The number of blocks required to confirm a transaction. You can use `numBlocks` to estimate the fee rate by targeting confirmation within a given number of blocks. If both `feeRate` and `numBlocks` are absent, the transaction defaults to 2 blocks for confirmation.
- Note: The 'maxFeeRate' limits the fee rate generated by 'numBlocks'.
+ Note: The `maxFeeRate` limits the fee rate generated by `numBlocks`.
example: 2
confidence:
type: integer
@@ -38925,9 +39677,9 @@ components:
feeByBlockTarget:
type: object
description: |
- (UTXO only) Custom multiplier to the 'feeRate'. The resulting fee rate is limited by the 'maxFeeRate'. For replace-by-fee (RBF) transactions (that include 'rbfTxIds'), the 'feeMultiplier' must be greater than 1, since it's an absolute fee multiplier to the transaction being replaced.
+ (UTXO only) Custom multiplier to the `feeRate`. The resulting fee rate is limited by the `maxFeeRate`. For replace-by-fee (RBF) transactions (that include `rbfTxIds`), the `feeMultiplier` must be greater than 1, since it's an absolute fee multiplier to the transaction being replaced.
- Note: The 'maxFeeRate' limits the fee rate generated by 'feeMultiplier'.
+ Note: The `maxFeeRate` limits the fee rate generated by `feeMultiplier`.
example:
'1': 50536
'2': 15902
@@ -39045,7 +39797,7 @@ components:
type: integer
example: 100000000
netFee:
- description: Fee rate per unit of tx size. Not used currently ('fee' is a maximum limit, the network charges the cost of the transaction)
+ description: Fee rate per unit of tx size. Not used currently (`fee` is a maximum limit, the network charges the cost of the transaction)
type: integer
example: 1000
required:
@@ -39517,9 +40269,9 @@ components:
minimum: 1
- example: 1.5
description: |
- (UTXO only) Custom multiplier to the 'feeRate'. The resulting fee rate is limited by the 'maxFeeRate'. For replace-by-fee (RBF) transactions (that include 'rbfTxIds'), the 'feeMultiplier' must be greater than 1, since it's an absolute fee multiplier to the transaction being replaced.
+ (UTXO only) Custom multiplier to the `feeRate`. The resulting fee rate is limited by the `maxFeeRate`. For replace-by-fee (RBF) transactions (that include `rbfTxIds`), the `feeMultiplier` must be greater than 1, since it's an absolute fee multiplier to the transaction being replaced.
- Note: The 'maxFeeRate' limits the fee rate generated by 'feeMultiplier'.
+ Note: The `maxFeeRate` limits the fee rate generated by `feeMultiplier`.
walletPassphrase:
type: string
description: (Hot wallet only) Passphrase to decrypt the user key on the wallet to sign the transaction.
@@ -39554,7 +40306,7 @@ components:
- $ref: '#/components/schemas/IntegerOrString'
- example: 10000
description: |
- Custom minimum fee rate in a coin's base unit per kilobyte (or virtual kilobyte)--for example, satoshis per kvByte or microAlgos per kByte. If the applied 'feeRate' does not meet a coin's required minimum transaction fee amount, the minimum is still applied (for example, 1000 sat/kvByte or a flat 1000 microAlgos).
+ Custom minimum fee rate in a coin's base unit per kilobyte (or virtual kilobyte)--for example, satoshis per kvByte or microAlgos per kByte. If the applied `feeRate` does not meet a coin's required minimum transaction fee amount, the minimum is still applied (for example, 1000 sat/kvByte or a flat 1000 microAlgos).
nP2shInputs:
type: integer
description: Number of P2SH (multi-signature) inputs
@@ -39626,7 +40378,7 @@ components:
description: |
The un-encrypted user private key in string form.
If the key is a JSON object it must be stringified.
- Required if 'walletPassphrase' is not available or encrypted private key is not stored by BitGo.
+ Required if `walletPassphrase` is not available or encrypted private key is not stored by BitGo.
type: string
apiVersion:
description: |
@@ -39652,17 +40404,17 @@ components:
description: |
Custom fee rate (in base units) per kilobyte (or virtual kilobyte). For example, satoshis per kvByte.
- If the 'feeRate' is less than the minimum required network fee, then the minimum fee applies. For example, 1000 sat/kvByte, a flat 1000 microAlgos, or a flat 10 drops of xrp. For XRP, the actual fee is usually 4.5 times the open ledger fee.
+ If the `feeRate` is less than the minimum required network fee, then the minimum fee applies. For example, 1000 sat/kvByte, a flat 1000 microAlgos, or a flat 10 drops of xrp. For XRP, the actual fee is usually 4.5 times the open ledger fee.
- Note: The 'feeRate' overrides the 'maxFeeRate' and 'minFeeRate'.
+ Note: The `feeRate` overrides the `maxFeeRate` and `minFeeRate`.
maxFeeRate:
allOf:
- $ref: '#/components/schemas/IntegerOrIntegerString'
- example: 20000
description: |
- (BTC only) The maximum fee rate (in base units) per kilobyte (or virtual kilobyte). For example, satoshis per kvByte. The 'maxFeeRate' limits the fee rate generated by both 'feeMultiplier' and 'numBlocks'.
+ (BTC only) The maximum fee rate (in base units) per kilobyte (or virtual kilobyte). For example, satoshis per kvByte. The `maxFeeRate` limits the fee rate generated by both `feeMultiplier` and `numBlocks`.
- Note: The 'feeRate' overrides the 'maxFeeRate'.
+ Note: The `feeRate` overrides the `maxFeeRate`.
maxFeePercentage:
type: integer
description: Maximum relative portion that can be spent towards fees
@@ -39671,7 +40423,7 @@ components:
description: Block target for fee estimation
bulk:
type: boolean
- description: Build multiple transactions at the same time. This enables you to increase the maximum number of unspents on the 'limit' parameter up to 2,000. If true, you must pass the 'txFormat' as 'psbt' and you can't pass the 'targetAddress' or 'numUnspentsToMake' parameters.
+ description: Build multiple transactions at the same time. This enables you to increase the maximum number of unspents on the `limit` parameter up to 2,000. If true, you must pass the `txFormat` as `psbt` and you can't pass the `targetAddress` or `numUnspentsToMake` parameters.
minValue:
allOf:
- $ref: '#/components/schemas/IntegerOrIntegerString'
@@ -39769,17 +40521,17 @@ components:
description: |
Custom fee rate (in base units) per kilobyte (or virtual kilobyte). For example, satoshis per kvByte.
- If the 'feeRate' is less than the minimum required network fee, then the minimum fee applies. For example, 1000 sat/kvByte, a flat 1000 microAlgos, or a flat 10 drops of xrp. For XRP, the actual fee is usually 4.5 times the open ledger fee.
+ If the `feeRate` is less than the minimum required network fee, then the minimum fee applies. For example, 1000 sat/kvByte, a flat 1000 microAlgos, or a flat 10 drops of xrp. For XRP, the actual fee is usually 4.5 times the open ledger fee.
- Note: The 'feeRate' overrides the 'maxFeeRate' and 'minFeeRate'.
+ Note: The `feeRate` overrides the `maxFeeRate` and `minFeeRate`.
maxFeeRate:
allOf:
- $ref: '#/components/schemas/IntegerOrIntegerString'
- example: 20000
description: |
- (BTC only) The maximum fee rate (in base units) per kilobyte (or virtual kilobyte). For example, satoshis per kvByte. The 'maxFeeRate' limits the fee rate generated by both 'feeMultiplier' and 'numBlocks'.
+ (BTC only) The maximum fee rate (in base units) per kilobyte (or virtual kilobyte). For example, satoshis per kvByte. The `maxFeeRate` limits the fee rate generated by both `feeMultiplier` and `numBlocks`.
- Note: The 'feeRate' overrides the 'maxFeeRate'.
+ Note: The `feeRate` overrides the `maxFeeRate`.
maxFeePercentage:
type: integer
description: Maximum relative portion that can be spent towards fees
@@ -39903,13 +40655,13 @@ components:
- $ref: '#/components/schemas/ExpressWallet'
- title: Wallet (including keychains)
type: object
- description: Wallet with user, bitgo and backup keychains (when 'includeKeychains' query param is 'true').
+ description: Wallet with user, bitgo and backup keychains (when `includeKeychains` query param is `true`).
properties:
wallet:
$ref: '#/components/schemas/ExpressWallet'
encryptedWalletPassphrase:
type: string
- description: Encrypted wallet passphrase. Used only with 'passcodeEncryptionCode'. You can use the encrypted wallet passphrase in the BitGo web app during password recovery for the wallet.
+ description: Encrypted wallet passphrase. Used only with `passcodeEncryptionCode`. You can use the encrypted wallet passphrase in the BitGo web app during password recovery for the wallet.
example: '"{\"iv\":\"IpwAFi0+TDsLJCV4pg8T6w==\",\"v\":1,\"iter\":10000,\"ks\":256,\"ts\":64,\"mode\":\"ccm\",\"adata\":\"\",\"cipher\":\"aes\",\"salt\":\"3lkIc47rjzo=\",\"ct\":\"/m6JL/ttTJWXNmHm+dzI\"}"'
userKeychain:
type: object
@@ -40141,7 +40893,7 @@ components:
description: Passphrase to decrypt the user key on the wallet
prv:
type: string
- description: Optional, private key in string form, if 'walletPassphrase' is not available or encrypted private key is not stored by BitGo.
+ description: Optional, private key in string form, if `walletPassphrase` is not available or encrypted private key is not stored by BitGo.
- $ref: '#/components/schemas/BuildParams'
- type: object
properties:
@@ -40235,7 +40987,7 @@ components:
description: |
The un-encrypted user private key in string form.
If the key is a JSON object it must be stringified.
- Required if 'walletPassphrase' is not available or encrypted private key is not stored by BitGo.
+ Required if `walletPassphrase` is not available or encrypted private key is not stored by BitGo.
- $ref: '#/components/schemas/BuildParams'
- type: object
properties:
@@ -40337,9 +41089,9 @@ components:
description: |
Custom fee rate (in base units) per kilobyte (or virtual kilobyte). For example, satoshis per kvByte.
- If the 'feeRate' is less than the minimum required network fee, then the minimum fee applies. For example, 1000 sat/kvByte, a flat 1000 microAlgos, or a flat 10 drops of xrp. For XRP, the actual fee is usually 4.5 times the open ledger fee.
+ If the `feeRate` is less than the minimum required network fee, then the minimum fee applies. For example, 1000 sat/kvByte, a flat 1000 microAlgos, or a flat 10 drops of xrp. For XRP, the actual fee is usually 4.5 times the open ledger fee.
- Note: The 'feeRate' overrides the 'maxFeeRate' and 'minFeeRate'.
+ Note: The `feeRate` overrides the `maxFeeRate` and `minFeeRate`.
payGoFee:
type: integer
description: BitGo fee of the transaction (in base units)
@@ -40403,22 +41155,22 @@ components:
description: |
Custom fee rate (in base units) per kilobyte (or virtual kilobyte). For example, satoshis per kvByte.
- If the 'feeRate' is less than the minimum required network fee, then the minimum fee applies. For example, 1000 sat/kvByte, a flat 1000 microAlgos, or a flat 10 drops of xrp. For XRP, the actual fee is usually 4.5 times the open ledger fee.
+ If the `feeRate` is less than the minimum required network fee, then the minimum fee applies. For example, 1000 sat/kvByte, a flat 1000 microAlgos, or a flat 10 drops of xrp. For XRP, the actual fee is usually 4.5 times the open ledger fee.
- Note: The 'feeRate' overrides the 'maxFeeRate' and 'minFeeRate'.
+ Note: The `feeRate` overrides the `maxFeeRate` and `minFeeRate`.
maxFeeRate:
allOf:
- $ref: '#/components/schemas/IntegerOrIntegerString'
- example: 20000
description: |
- (BTC only) The maximum fee rate (in base units) per kilobyte (or virtual kilobyte). For example, satoshis per kvByte. The 'maxFeeRate' limits the fee rate generated by both 'feeMultiplier' and 'numBlocks'.
+ (BTC only) The maximum fee rate (in base units) per kilobyte (or virtual kilobyte). For example, satoshis per kvByte. The `maxFeeRate` limits the fee rate generated by both `feeMultiplier` and `numBlocks`.
- Note: The 'feeRate' overrides the 'maxFeeRate'.
+ Note: The `feeRate` overrides the `maxFeeRate`.
allowPartialSweep:
type: boolean
default: false
description: |
- Use 'allowPartialSweep: true' to sweep part of a wallet when there are too many unspents to empty the wallet in a
+ Use `allowPartialSweep: true` to sweep part of a wallet when there are too many unspents to empty the wallet in a
single transaction. While the expected outcome of a single sweep call would usually be an empty wallet, using the
allowPartialSweep option may leave some funds in the wallet. Making repeated calls with the allowPartialSweep
option allows emptying wallets with many unspents without consolidating first.
@@ -40663,13 +41415,13 @@ components:
type: string
description: Encrypted user private key
description: |
- The user's keychain object with an 'encryptedPrv' property. The 'walletPassphrase' parameter is required when using 'keychain'. Any request must include either 'keychain' or 'prv'.
+ The user's keychain object with an `encryptedPrv` property. The `walletPassphrase` parameter is required when using `keychain`. Any request must include either `keychain` or `prv`.
prv:
type: string
description: |
User private key
- Note: The request must include either 'prv' or 'keychain'
+ Note: The request must include either `prv` or `keychain`
example: xprv9s21ZrQH143K3xQwj4yx3fHjDieEdqFDweBvFxn28qGvfQGvweUWuUuDRpepDu6opq3jiWHU9h3yYTKk5vvu4ykRuGA4i4Kz1vmFMPLTsoC
txPrebuild:
type: object
@@ -40698,7 +41450,7 @@ components:
walletPassphrase:
type: string
description: |
- Passphrase to decrypt the user keychain. 'walletPassphrase' is a required parameter when the parameter 'keychain' is provided.
+ Passphrase to decrypt the user keychain. `walletPassphrase` is a required parameter when the parameter `keychain` is provided.
recipients:
type: array
items:
@@ -40780,6 +41532,33 @@ components:
type: string
description: |
Total balance in enterprise gas tank.
+ FeeAddressTransferIntent:
+ title: FeeAddressTransferIntent
+ allOf:
+ - type: object
+ properties:
+ intentType:
+ type: string
+ enum:
+ - feeAddressTransfer
+ recipients:
+ type: array
+ items:
+ type: object
+ properties:
+ address:
+ $ref: '#/components/schemas/Address'
+ amount:
+ $ref: '#/components/schemas/Amount'
+ data:
+ $ref: '#/components/schemas/optionalString'
+ required:
+ - address
+ - amount
+ required:
+ - intentType
+ - recipients
+ - $ref: '#/components/schemas/BaseIntent'
FeeOption:
title: FeeOption
type: object
@@ -40890,10 +41669,10 @@ components:
status:
type: string
description: |
- Status of the action. Indicates if the Actions is usable 'ACTIVE' or not 'INACTIVE'.
+ Status of the action. Indicates if the Actions is usable `ACTIVE` or not `INACTIVE`.
- * 'ACTIVE' - The action is available for use.
- * 'INACTIVE' - The action is NOT available for use.
+ * `ACTIVE` - The action is available for use.
+ * `INACTIVE` - The action is NOT available for use.
enum:
- ACTIVE
- INACTIVE
@@ -40978,7 +41757,7 @@ components:
example: BITGO_USER_ID
required:
type: string
- description: A value must be always provided for exactly one or more of the action Parameters with a 'required' value of 'ONE_OR_MORE'. In other words, all the action Parameters with a 'required' of 'ONE_OR_MORE' form a group, and a value must be provided for one or more of the action Parameters in the group.
+ description: A value must be always provided for exactly one or more of the action Parameters with a 'required' value of `ONE_OR_MORE`. In other words, all the action Parameters with a 'required' of `ONE_OR_MORE` form a group, and a value must be provided for one or more of the action Parameters in the group.
enum:
- ONE_OR_MORE
example: ONE_OR_MORE
@@ -41663,13 +42442,13 @@ components:
description: String representation of the confirmed balance in base units. Guaranteed to not lose precision.
spendableBalanceString:
type: string
- description: String representation of the spendable in base units. Guaranteed to not lose precision. Will not be included if 'excludeSpendableBalances=false'
+ description: String representation of the spendable in base units. Guaranteed to not lose precision. Will not be included if `excludeSpendableBalances=false`
stakingBalanceString:
type: string
- description: The staked balance in base units. Guaranteed to not lose precision. The is only returned if the 'includeStakingBalances' query parameter is set to 'true'.
+ description: The staked balance in base units. Guaranteed to not lose precision. The is only returned if the `includeStakingBalances` query parameter is set to `true`.
rewardBalanceString:
type: string
- description: The staking reward balance in base units. Guaranteed to not lose precision. The is only returned if the 'includeStakingBalances' query parameter is set to 'true'.
+ description: The staking reward balance in base units. Guaranteed to not lose precision. The is only returned if the `includeStakingBalances` query parameter is set to `true`.
inboundBalance:
type: string
description: Inbound balance in millisatoshis (remote balance)
@@ -41922,6 +42701,14 @@ components:
type: string
description: A description for the condition parameter Value which can be shown to an end user.
example: A hot wallet
+ IcpPaymentIntent:
+ title: ICP Payment Intent
+ allOf:
+ - type: object
+ properties:
+ memo:
+ $ref: '#/components/schemas/optionalString'
+ - $ref: '#/components/schemas/PaymentIntent'
Id:
title: ID
type: string
@@ -42391,6 +43178,8 @@ components:
- customTx
- closeAssociatedTokenAccount
- stakeWithCallData
+ - feeAddressTransfer
+ - createBtcDelegation
IntentType1:
title: IntentType
type: string
@@ -42442,8 +43231,8 @@ components:
title: International Wire Bank Account
type: object
description: |
- An external bank account. 'routingNumber' must be set for US bank accounts.
- 'swiftCode' must be set for banks outside the US.
+ An external bank account. `routingNumber` must be set for US bank accounts.
+ `swiftCode` must be set for banks outside the US.
properties:
accountNumber:
description: Bank account number or IBAN.
@@ -42926,7 +43715,7 @@ components:
key:
allOf:
- $ref: '#/components/schemas/KeyListItem'
- description: Represents a key associated with a wallet. The key can either be a valid 'Key' object or 'null' if no key is associated.
+ description: Represents a key associated with a wallet. The key can either be a valid `Key` object or `null` if no key is associated.
required:
- walletId
KeyPurpose:
@@ -43370,6 +44159,28 @@ components:
- expiresAt
- status
- walletId
+ LightningOnchainRequest:
+ title: LightningOnchainRequest
+ type: object
+ properties:
+ recipients:
+ type: array
+ items:
+ type: object
+ properties:
+ amountSat:
+ type: string
+ format: number
+ address:
+ type: string
+ required:
+ - amountSat
+ - address
+ satsPerVbyte:
+ type: string
+ format: number
+ required:
+ - recipients
LightningPaymentFailureReason:
type: string
enum:
@@ -43395,17 +44206,31 @@ components:
* CANCELED - Payment was canceled
LightningPaymentIntent:
title: Lightning Payment Intent
- allOf:
- - type: object
- properties:
- intentType:
- type: string
- enum:
- - payment
- required:
- - intentType
- - $ref: '#/components/schemas/BaseIntent'
- - $ref: '#/components/schemas/LightningPaymentRequestWithSig'
+ oneOf:
+ - allOf:
+ - type: object
+ properties:
+ intentType:
+ type: string
+ enum:
+ - payment
+ required:
+ - intentType
+ - $ref: '#/components/schemas/BaseIntent'
+ - $ref: '#/components/schemas/LightningPaymentRequestWithSig'
+ - allOf:
+ - type: object
+ properties:
+ intentType:
+ type: string
+ enum:
+ - payment
+ onchainRequest:
+ $ref: '#/components/schemas/LightningOnchainRequest'
+ required:
+ - intentType
+ - onchainRequest
+ - $ref: '#/components/schemas/BaseIntent'
LightningPaymentRequest:
title: LightningPaymentRequest
type: object
@@ -44484,10 +45309,10 @@ components:
MutabilityConstraint1:
type: string
description: |
- Specifies whether a BitGo admin can change 'lockDate'
- * 'managed' - Not locked, but requires approval from a BitGo admin to change
- * 'permanent' - 'lockDate' cannot be changed
- * 'sticky' - Not included in bulk unlock, but 'lockDate' can be individually changed
+ Specifies whether a BitGo admin can change `lockDate`
+ * `managed` - Not locked, but requires approval from a BitGo admin to change
+ * `permanent` - `lockDate` cannot be changed
+ * `sticky` - Not included in bulk unlock, but `lockDate` can be individually changed
enum:
- managed
- permanent
@@ -44931,7 +45756,7 @@ components:
description: Duration of the TWAP order in minutes.
interval:
type: integer
- description: Interval of the time-sliced TWAP order in minutes. Only required if 'isTimeSliced' is 'true'.
+ description: Interval of the time-sliced TWAP order in minutes. Only required if `isTimeSliced` is `true`.
scheduledDate:
type: string
format: date-time
@@ -44954,7 +45779,7 @@ components:
type: string
format: uuid
example: 585951a5df8380e0e3063e9f
- description: When a result set is truncated, this field returns the id of the last object in the previous batch. To get the next batch of results, pass this value via the 'prevId' query parameter.
+ description: When a result set is truncated, this field returns the id of the last object in the previous batch. To get the next batch of results, pass this value via the `prevId` query parameter.
NonNegativeBigAmount:
title: NonNegativeBigAmount
type: string
@@ -45788,6 +46613,9 @@ components:
type: object
description: Resolvers for the pending approval
properties:
+ autoApproved:
+ type: boolean
+ description: Whether the resolution was auto approved
date:
type: string
description: The date of resolution
@@ -45929,6 +46757,9 @@ components:
type: object
description: The resolvers of the action
properties:
+ autoApproved:
+ type: boolean
+ description: Whether the resolution was auto approved
date:
type: string
description: The date of resolution
@@ -47171,10 +48002,10 @@ components:
PlatformMutabilityConstraint:
type: string
description: |
- Specifies whether a BitGo admin can change 'lockDate'
- * 'managed' - Not locked, but requires approval from a BitGo admin to change
- * 'permanent' - 'lockDate' cannot be changed
- * 'sticky' - Not included in bulk unlock, but 'lockDate' can be individually changed
+ Specifies whether a BitGo admin can change `lockDate`
+ * `managed` - Not locked, but requires approval from a BitGo admin to change
+ * `permanent` - `lockDate` cannot be changed
+ * `sticky` - Not included in bulk unlock, but `lockDate` can be individually changed
enum:
- managed
- permanent
@@ -47720,7 +48551,7 @@ components:
example: 6
state:
type: string
- description: If 'active', indicates the webhook can trigger and send to the URL. If 'suspended', indicates the webhook can't trigger.
+ description: If `active`, indicates the webhook can trigger and send to the URL. If `suspended`, indicates the webhook can't trigger.
enum:
- active
- suspended
@@ -47947,10 +48778,10 @@ components:
description: |
Indicates if the Policy Rule is considered in Evaluations.
- * 'ACTIVE' - Will be Evaluated.
- * 'INACTIVE' - Will NOT be Evaluated.
- * 'DENIED' - The requested policy rule change was Denied.
- * 'PENDING_APPROVAL' - This version of the policy rule is Pending Approval before it can be activated.
+ * `ACTIVE` - Will be Evaluated.
+ * `INACTIVE` - Will NOT be Evaluated.
+ * `DENIED` - The requested policy rule change was Denied.
+ * `PENDING_APPROVAL` - This version of the policy rule is Pending Approval before it can be activated.
enum:
- ACTIVE
- INACTIVE
@@ -48005,8 +48836,8 @@ components:
description: |
Indicates how the Policy Rule is locked.
- * 'LOCK_AFTER_DATE' - Will lock after the lockDate set on the Policy Rule.
- * 'PERMANENT' - Is permanently locked.
+ * `LOCK_AFTER_DATE` - Will lock after the lockDate set on the Policy Rule.
+ * `PERMANENT` - Is permanently locked.
enum:
- LOCK_AFTER_DATE
- PERMANENT
@@ -48015,7 +48846,7 @@ components:
type: string
description: |
The date after which the Policy Rule will be locked. Only applicable if the Policy Rule is locked with
- 'LOCK_AFTER_DATE'.
+ `LOCK_AFTER_DATE`.
format: date-time
example: '2023-11-13T14:49:48.830522Z'
enterpriseId:
@@ -48026,7 +48857,7 @@ components:
type: string
description: |
The date when the Policy Rule was last triggered. Only applicable if the Policy Rule is locked with
- 'LOCK_AFTER_DATE'.
+ `LOCK_AFTER_DATE`.
format: date-time
example: '2023-11-13T14:49:48.830522Z'
lastTriggeredEvaluationId:
@@ -48831,6 +49662,186 @@ components:
required:
- enterprise
- snapshotDate
+ organizationHoldings:
+ type: object
+ description: Organization-level Holdings report
+ properties:
+ byWallet:
+ type: boolean
+ enterprises:
+ type: array
+ items:
+ type: string
+ minLength: 1
+ includeStaking:
+ type: boolean
+ organization:
+ type: string
+ minLength: 1
+ snapshotDate:
+ type: string
+ format: date-time
+ title: ISO Date String
+ required:
+ - enterprises
+ - organization
+ - snapshotDate
+ organizationTransactions:
+ type: object
+ description: Organization-level Transactions report
+ properties:
+ assets:
+ type: array
+ items:
+ type: string
+ minLength: 1
+ endDate:
+ type: string
+ format: date-time
+ title: ISO Date String
+ enterprises:
+ type: array
+ items:
+ type: string
+ minLength: 1
+ isAddressReport:
+ type: boolean
+ isDetailed:
+ type: boolean
+ organization:
+ type: string
+ minLength: 1
+ startDate:
+ type: string
+ format: date-time
+ title: ISO Date String
+ wallets:
+ type: array
+ items:
+ type: string
+ minLength: 1
+ example: 59cd72485007a239fb00282ed480da1f
+ walletTypes:
+ type: array
+ items:
+ type: string
+ minLength: 1
+ required:
+ - endDate
+ - enterprises
+ - organization
+ - startDate
+ organizationHoldingsByAddress:
+ type: object
+ description: Organization-level Holdings by Address report
+ properties:
+ assets:
+ type: array
+ items:
+ type: string
+ minLength: 1
+ enterprises:
+ type: array
+ items:
+ type: string
+ minLength: 1
+ organization:
+ type: string
+ minLength: 1
+ snapshotDate:
+ type: string
+ format: date-time
+ title: ISO Date String
+ wallets:
+ type: array
+ items:
+ type: string
+ minLength: 1
+ example: 59cd72485007a239fb00282ed480da1f
+ walletTypes:
+ type: array
+ items:
+ type: string
+ minLength: 1
+ required:
+ - enterprises
+ - organization
+ - snapshotDate
+ organizationStaking:
+ type: object
+ description: Organization-level Staking report
+ properties:
+ assets:
+ type: array
+ items:
+ type: string
+ minLength: 1
+ endDate:
+ type: string
+ format: date-time
+ title: ISO Date String
+ enterprises:
+ type: array
+ items:
+ type: string
+ minLength: 1
+ isBalanceReport:
+ type: boolean
+ organization:
+ type: string
+ minLength: 1
+ startDate:
+ type: string
+ format: date-time
+ title: ISO Date String
+ wallets:
+ type: array
+ items:
+ type: string
+ minLength: 1
+ example: 59cd72485007a239fb00282ed480da1f
+ walletTypes:
+ type: array
+ items:
+ type: string
+ minLength: 1
+ required:
+ - endDate
+ - enterprises
+ - organization
+ - startDate
+ organizationTrades:
+ type: object
+ description: Organization-level Trades report
+ properties:
+ assets:
+ type: array
+ items:
+ type: string
+ minLength: 1
+ endDate:
+ type: string
+ format: date-time
+ title: ISO Date String
+ enterprises:
+ type: array
+ items:
+ type: string
+ minLength: 1
+ isFillsReport:
+ type: boolean
+ organization:
+ type: string
+ minLength: 1
+ startDate:
+ type: string
+ format: date-time
+ title: ISO Date String
+ required:
+ - endDate
+ - enterprises
+ - organization
+ - startDate
ReportStatus1:
title: ReportStatus
type: string
@@ -49206,11 +50217,11 @@ components:
description: |
Comma-separated list of privileges for a wallet. Includes:
- - 'admin' - Can manage wallet policies and users and approve or reject pending approvals.
- - 'freeze' - Can freeze a wallet, disabling all withdrawals.
- - 'spend' - Can initiate withdrawals and generate new receive addresses.
- - 'trade' - Can initiate trades from a Go Account ('trading' wallet type).
- - 'view' - Can view balances and transactions.
+ - `admin` - Can manage wallet policies and users and approve or reject pending approvals.
+ - `freeze` - Can freeze a wallet, disabling all withdrawals.
+ - `spend` - Can initiate withdrawals and generate new receive addresses.
+ - `trade` - Can initiate trades from a Go Account (`trading` wallet type).
+ - `view` - Can view balances and transactions.
Permissions don't overlap. Required parameter if 'reshare' is false.
enum:
@@ -49781,7 +50792,7 @@ components:
transferId:
allOf:
- $ref: '#/components/schemas/Id'
- description: The ID of a transfer on the specified wallet. This must be provided if the webhook is of type 'transfer'.
+ description: The ID of a transfer on the specified wallet. This must be provided if the webhook is of type `transfer`.
required:
- transferId
- title: Pending Approval
@@ -49790,7 +50801,7 @@ components:
pendingApprovalId:
allOf:
- $ref: '#/components/schemas/Id'
- description: The ID of a pending approval on the specified wallet. This must be provided if the webhook is of type 'pendingApproval'.
+ description: The ID of a pending approval on the specified wallet. This must be provided if the webhook is of type `pendingApproval`.
required:
- pendingApprovalId
- title: Transaction request
@@ -49798,7 +50809,7 @@ components:
properties:
txRequestId:
type: string
- description: The txRequestId of a transaction request on the specified wallet. This must be provided if the webhook is of type 'txRequest' or 'txRequestTransaction'.
+ description: The txRequestId of a transaction request on the specified wallet. This must be provided if the webhook is of type `txRequest` or `txRequestTransaction`.
required:
- txRequestId
SnowflakeReportType:
@@ -49811,6 +50822,11 @@ components:
- trades
- staking
- holdingsByAddress
+ - organizationHoldings
+ - organizationHoldingsByAddress
+ - organizationTransactions
+ - organizationTrades
+ - organizationStaking
SolAddress:
title: Sol Address
type: object
@@ -49968,6 +50984,8 @@ components:
$ref: '#/components/schemas/optionalStringArray'
stakingAddress:
$ref: '#/components/schemas/optionalString'
+ isMarinade:
+ type: boolean
required:
- intentType
- validatorAddress
@@ -50095,10 +51113,43 @@ components:
required:
- symbol
- value
+ isMarinade:
+ type: boolean
required:
- stakingAddress
- $ref: '#/components/schemas/UnstakeIntent'
- $ref: '#/components/schemas/SolBuildOptions'
+ SolUnstakeIntent1:
+ title: SOL Unstake Intent
+ allOf:
+ - type: object
+ properties:
+ stakingAddress:
+ type: string
+ amount:
+ type: object
+ properties:
+ symbol:
+ type: string
+ value:
+ type: string
+ required:
+ - symbol
+ - value
+ remainingStakingAmount:
+ type: object
+ properties:
+ symbol:
+ type: string
+ value:
+ type: string
+ required:
+ - symbol
+ - value
+ required:
+ - stakingAddress
+ - $ref: '#/components/schemas/UnstakeIntent1'
+ - $ref: '#/components/schemas/SolBuildOptions'
SolWallet:
title: Sol Wallet
type: object
@@ -51138,7 +52189,7 @@ components:
description: |
The boundsControl field, when provided under the parameters section, determines how strictly the TWAP algorithm adheres to the target fill progression.
- It is optional but can be provided for a regular TWAP strategy.
- - Default value is 'standard'.
+ - Default value is `standard`.
enum:
- narrow
- standard
@@ -51558,10 +52609,10 @@ components:
status:
type: string
description: |
- Status of the Touchpoint. Indicates if the Touchpoint is usable 'ACTIVE' or not 'INACTIVE'.
+ Status of the Touchpoint. Indicates if the Touchpoint is usable `ACTIVE` or not `INACTIVE`.
- * 'ACTIVE' - The Touchpoint is available for use.
- * 'INACTIVE' - The Touchpoint is NOT available for use.
+ * `ACTIVE` - The Touchpoint is available for use.
+ * `INACTIVE` - The Touchpoint is NOT available for use.
enum:
- ACTIVE
- INACTIVE
@@ -51738,10 +52789,6 @@ components:
type: string
blockHeight:
type: number
- blockHash:
- type: string
- blockPosition:
- type: number
inputIds: {}
entries: {}
inputs: {}
@@ -51760,14 +52807,16 @@ components:
type: string
confirmations:
type: number
+ blockHash:
+ type: string
+ blockPosition:
+ type: number
label:
type: string
required:
- id
- normalizedTxHash
- blockHeight
- - blockHash
- - blockPosition
- inputIds
- entries
- inputs
@@ -51884,6 +52933,7 @@ components:
- $ref: '#/components/schemas/AtomStakeIntent'
- $ref: '#/components/schemas/AtomUnstakeIntent'
- $ref: '#/components/schemas/AtomWithdrawIntent'
+ - $ref: '#/components/schemas/BabyCreateBtcDelegationIntent'
- $ref: '#/components/schemas/BscDelegateIntent'
- $ref: '#/components/schemas/BscUnDelegateIntent'
- $ref: '#/components/schemas/BscWithdrawUndelegateIntent'
@@ -51905,6 +52955,8 @@ components:
- $ref: '#/components/schemas/EthPaymentIntent'
- $ref: '#/components/schemas/EthStakingIntent'
- $ref: '#/components/schemas/EthTransferTokenIntent'
+ - $ref: '#/components/schemas/FeeAddressTransferIntent'
+ - $ref: '#/components/schemas/IcpPaymentIntent'
- $ref: '#/components/schemas/LightningPaymentIntent'
- $ref: '#/components/schemas/MmiSignMessageIntent'
- $ref: '#/components/schemas/MmiSignTransactionIntent'
@@ -52233,7 +53285,7 @@ components:
- $ref: '#/components/schemas/SolClaimIntent'
- $ref: '#/components/schemas/SolCreateAssociatedTokenAccountIntent'
- $ref: '#/components/schemas/SolStakeIntent'
- - $ref: '#/components/schemas/SolUnstakeIntent'
+ - $ref: '#/components/schemas/SolUnstakeIntent1'
- $ref: '#/components/schemas/TransferTokenIntent1'
- $ref: '#/components/schemas/UnstakeIntent2'
- $ref: '#/components/schemas/WalletRecoveryIntent1'
@@ -52662,7 +53714,7 @@ components:
- rejected
comment:
type: string
- description: If this history object is of action 'commented', this is the comment from the user
+ description: If this history object is of action `commented`, this is the comment from the user
comment:
type: string
description: A comment from the user
@@ -52675,7 +53727,7 @@ components:
sequenceId:
type: string
description: |
- A 'sequenceId' is a unique and arbitrary wallet identifier applied to transfers and transactions at creation. It is optional but highly recommended. With a 'sequenceId' you can easily reference transfers and transactions—for example, to safely retry sending. Because the system only confirms one send request per 'sequenceId' (and fails all subsequent attempts), you can retry sending without the risk of double spending. The 'sequenceId' is only visible to users on the wallet and is not shared publicly.
+ A `sequenceId` is a unique and arbitrary wallet identifier applied to transfers and transactions at creation. It is optional but highly recommended. With a `sequenceId` you can easily reference transfers and transactions—for example, to safely retry sending. Because the system only confirms one send request per `sequenceId` (and fails all subsequent attempts), you can retry sending without the risk of double spending. The `sequenceId` is only visible to users on the wallet and is not shared publicly.
entries:
type: array
description: An array of objects describing the change in address balances made as a result of this Transfer
@@ -52699,7 +53751,7 @@ components:
description: The change (in base units) in the address's balance represented as a String
isChange:
type: boolean
- description: True if this address is a change address (only exists for UTXO coins) and if this is a 'sent' Transfer
+ description: True if this address is a change address (only exists for UTXO coins) and if this is a `sent` Transfer
isPayGo:
type: boolean
description: True if this address is the BitGo PayGo wallet
@@ -53056,10 +54108,10 @@ components:
status:
type: string
description: |
- Status of the condition. Indicates if the condition is usable 'ACTIVE' or not 'INACTIVE'.
+ Status of the condition. Indicates if the condition is usable `ACTIVE` or not `INACTIVE`.
- * 'ACTIVE' - The condition is available for use.
- * 'INACTIVE' - The condition is NOT available for use.
+ * `ACTIVE` - The condition is available for use.
+ * `INACTIVE` - The condition is NOT available for use.
enum:
- ACTIVE
- INACTIVE
@@ -53143,10 +54195,10 @@ components:
status:
type: string
description: |
- Status of the condition. Indicates if the condition is usable 'ACTIVE' or not 'INACTIVE'.
+ Status of the condition. Indicates if the condition is usable `ACTIVE` or not `INACTIVE`.
- * 'ACTIVE' - The condition is available for use.
- * 'INACTIVE' - The condition is NOT available for use.
+ * `ACTIVE` - The condition is available for use.
+ * `INACTIVE` - The condition is NOT available for use.
enum:
- ACTIVE
- INACTIVE
@@ -53401,10 +54453,10 @@ components:
status:
type: string
description: |
- Status of the condition. Indicates if the condition is usable 'ACTIVE' or not 'INACTIVE'.
+ Status of the condition. Indicates if the condition is usable `ACTIVE` or not `INACTIVE`.
- * 'ACTIVE' - The condition is available for use.
- * 'INACTIVE' - The condition is NOT available for use.
+ * `ACTIVE` - The condition is available for use.
+ * `INACTIVE` - The condition is NOT available for use.
enum:
- ACTIVE
- INACTIVE
@@ -54047,6 +55099,18 @@ components:
required:
- intentType
- $ref: '#/components/schemas/BaseStakeIntent'
+ UnstakeIntent1:
+ title: UnstakeIntent
+ allOf:
+ - type: object
+ properties:
+ intentType:
+ type: string
+ enum:
+ - unstake
+ required:
+ - intentType
+ - $ref: '#/components/schemas/BaseStakeIntent1'
UnstakeIntent2:
title: Generic Unstake
allOf:
@@ -54092,7 +55156,7 @@ components:
- PENDING_DEACTIVATION
UpdateBankAccountRequest:
type: object
- description: Updates some fields on a bank account. The server only allows updating of bank accounts that have their verificationState set to 'rejected' or 'approved'. Does not allow updating of critical fields like accountNumber, enterpriseId, id, routingNumber, swiftCode.
+ description: Updates some fields on a bank account. The server only allows updating of bank accounts that have their verificationState set to `rejected` or 'approved'. Does not allow updating of critical fields like accountNumber, enterpriseId, id, routingNumber, swiftCode.
properties:
address1:
type: string
@@ -54235,7 +55299,7 @@ components:
allOf:
- $ref: '#/components/schemas/Coin'
description: |
- Policy rules of types 'allTx', 'coinAddressWhitelist', 'coinAddressBlacklist' and 'webhook' are recommended to
+ Policy rules of types `allTx`, `coinAddressWhitelist`, `coinAddressBlacklist` and `webhook` are recommended to
be used without setting a coin so that they will apply to all coins and tokens that could be in a wallet. If
your policy rule is of one of these types and has a coin set on it, you also need to set the coin in the body.
This is necessary because the id alone may not be sufficient for finding the correct rule to update or delete.
@@ -54505,6 +55569,12 @@ components:
- allCodesUsed
createTime:
type: string
+ passwordUpdatedAt:
+ type: string
+ format: date-time
+ title: ISO Date String
+ passwordChangeEmailSent:
+ type: boolean
required:
- agreements
- allowedCoins
@@ -54631,7 +55701,7 @@ components:
- $ref: '#/components/schemas/IntegerOrString'
- example: 10000
description: |
- Custom minimum fee rate in a coin's base unit per kilobyte (or virtual kilobyte)--for example, satoshis per kvByte or microAlgos per kByte. If the applied 'feeRate' does not meet a coin's required minimum transaction fee amount, the minimum is still applied (for example, 1000 sat/kvByte or a flat 1000 microAlgos).
+ Custom minimum fee rate in a coin's base unit per kilobyte (or virtual kilobyte)--for example, satoshis per kvByte or microAlgos per kByte. If the applied `feeRate` does not meet a coin's required minimum transaction fee amount, the minimum is still applied (for example, 1000 sat/kvByte or a flat 1000 microAlgos).
payGoFee:
type: integer
description: BitGo fee of the transaction (in base units)
@@ -54644,7 +55714,7 @@ components:
type: string
description: |-
[UTXO only] Format of the returned transaction hex serialization.
- 'legacy' for serialized transaction in custom bitcoinjs-lib format. 'psbt' for BIP174 serialized transaction
+ `legacy` for serialized transaction in custom bitcoinjs-lib format. `psbt` for BIP174 serialized transaction
enum:
- legacy
- psbt
@@ -57122,28 +58192,28 @@ components:
$ref: '#/components/schemas/WalletSubType'
balanceString:
type: string
- description: The cleared balance of the address in base units (e.g. Satoshis). Guaranteed to not lose precision. The is only returned if the 'expandBalance' query parameter is set to 'true'.
+ description: The cleared balance of the address in base units (e.g. Satoshis). Guaranteed to not lose precision. The is only returned if the `expandBalance` query parameter is set to `true`.
balance:
type: number
- description: The cleared balance of the address in base units (e.g. Satoshis). The is only returned if the 'expandBalance' query parameter is set to 'true'.
+ description: The cleared balance of the address in base units (e.g. Satoshis). The is only returned if the `expandBalance` query parameter is set to `true`.
confirmedBalanceString:
type: string
- description: The total balance of confirmed transactions in base units (e.g. Satoshis). The is only returned if the 'expandBalance' query parameter is set to 'true'. Guaranteed to not lose precision.
+ description: The total balance of confirmed transactions in base units (e.g. Satoshis). The is only returned if the `expandBalance` query parameter is set to `true`. Guaranteed to not lose precision.
confirmedBalance:
type: number
- description: The total balance of confirmed transactions in base units (e.g. Satoshis). The is only returned if the 'expandBalance' query parameter is set to 'true'.
+ description: The total balance of confirmed transactions in base units (e.g. Satoshis). The is only returned if the `expandBalance` query parameter is set to `true`.
spendableBalanceString:
type: string
- description: The total balance in base units (e.g. Satoshis) which may be used as inputs for creating new transactions in string representation. Guaranteed to not lose precision. The is only returned if the 'expandBalance' query parameter is set to 'true'.
+ description: The total balance in base units (e.g. Satoshis) which may be used as inputs for creating new transactions in string representation. Guaranteed to not lose precision. The is only returned if the `expandBalance` query parameter is set to `true`.
spendableBalance:
type: number
- description: The total balance in base units (e.g. Satoshis) which may be used as inputs for creating new transactions in string representation. The is only returned if the 'expandBalance' query parameter is set to 'true'.
+ description: The total balance in base units (e.g. Satoshis) which may be used as inputs for creating new transactions in string representation. The is only returned if the `expandBalance` query parameter is set to `true`.
stakingBalanceString:
type: string
- description: The staked balance in base units. Guaranteed to not lose precision. The is only returned if the 'includeStakingBalances' query parameter is set to 'true'.
+ description: The staked balance in base units. Guaranteed to not lose precision. The is only returned if the `includeStakingBalances` query parameter is set to `true`.
rewardBalanceString:
type: string
- description: The staking reward balance in base units. Guaranteed to not lose precision. The is only returned if the 'includeStakingBalances' query parameter is set to 'true'.
+ description: The staking reward balance in base units. Guaranteed to not lose precision. The is only returned if the `includeStakingBalances` query parameter is set to `true`.
users:
type: array
items:
@@ -57342,10 +58412,10 @@ components:
status:
type: string
description: |
- Status of the action. Indicates if the Actions is usable 'ACTIVE' or not 'INACTIVE'.
+ Status of the action. Indicates if the Actions is usable `ACTIVE` or not `INACTIVE`.
- * 'ACTIVE' - The action is available for use.
- * 'INACTIVE' - The action is NOT available for use.
+ * `ACTIVE` - The action is available for use.
+ * `INACTIVE` - The action is NOT available for use.
enum:
- ACTIVE
- INACTIVE
@@ -57413,10 +58483,10 @@ components:
status:
type: string
description: |
- Status of the condition. Indicates if the condition is usable 'ACTIVE' or not 'INACTIVE'.
+ Status of the condition. Indicates if the condition is usable `ACTIVE` or not `INACTIVE`.
- * 'ACTIVE' - The condition is available for use.
- * 'INACTIVE' - The condition is NOT available for use.
+ * `ACTIVE` - The condition is available for use.
+ * `INACTIVE` - The condition is NOT available for use.
enum:
- ACTIVE
- INACTIVE
@@ -57445,25 +58515,25 @@ components:
description: |
(BTC only) The minimum fee rate (in base units) per kilobyte (or virtual kilobyte). For example, satoshis per kvByte. Must be greater than or equal to the default of 1000 satoshis/kvByte.
- Note: The you can override 'minFeeRate' on a per transaction basis with the 'feeRate' parameter.
+ Note: The you can override `minFeeRate` on a per transaction basis with the `feeRate` parameter.
maxFeeRate:
type: integer
minimum: 1000
nullable: true
example: 18000
description: |
- (BTC only) The maximum fee rate (in base units) per kilobyte (or virtual kilobyte). For example, satoshis per kvByte. The 'maxFeeRate' limits the fee rate generated by both 'feeMultiplier' and 'numBlocks'.
+ (BTC only) The maximum fee rate (in base units) per kilobyte (or virtual kilobyte). For example, satoshis per kvByte. The `maxFeeRate` limits the fee rate generated by both `feeMultiplier` and `numBlocks`.
- Note: The you can override 'maxFeeRate' on a per transaction basis with the 'feeRate' parameter.
+ Note: The you can override `maxFeeRate` on a per transaction basis with the `feeRate` parameter.
feeMultiplier:
type: number
minimum: 1
nullable: true
example: 1.2
description: |
- (UTXO only) Custom multiplier to the 'feeRate'. The resulting fee rate is limited by the 'maxFeeRate'. For replace-by-fee (RBF) transactions (that include 'rbfTxIds'), the 'feeMultiplier' must be greater than 1, since it's an absolute fee multiplier to the transaction being replaced.
+ (UTXO only) Custom multiplier to the `feeRate`. The resulting fee rate is limited by the `maxFeeRate`. For replace-by-fee (RBF) transactions (that include `rbfTxIds`), the `feeMultiplier` must be greater than 1, since it's an absolute fee multiplier to the transaction being replaced.
- Note: The 'maxFeeRate' limits the fee rate generated by 'feeMultiplier'.
+ Note: The `maxFeeRate` limits the fee rate generated by `feeMultiplier`.
changeAddressType:
$ref: '#/components/schemas/DefaultChangeAddressType'
txFormat:
@@ -57474,7 +58544,7 @@ components:
- psbt
- psbt-lite
description: |
- (UTXO only) The default transaction format to use for this wallet. Per transaction, you can override the default with the 'txFormat' parameter.
+ (UTXO only) The default transaction format to use for this wallet. Per transaction, you can override the default with the `txFormat` parameter.
WalletCoinSpecific:
oneOf:
- title: Wallet
@@ -57759,10 +58829,10 @@ components:
status:
type: string
description: |
- Status of the condition. Indicates if the condition is usable 'ACTIVE' or not 'INACTIVE'.
+ Status of the condition. Indicates if the condition is usable `ACTIVE` or not `INACTIVE`.
- * 'ACTIVE' - The condition is available for use.
- * 'INACTIVE' - The condition is NOT available for use.
+ * `ACTIVE` - The condition is available for use.
+ * `INACTIVE` - The condition is NOT available for use.
enum:
- ACTIVE
- INACTIVE
@@ -57974,28 +59044,28 @@ components:
$ref: '#/components/schemas/WalletSubType'
balanceString:
type: string
- description: The cleared balance of the address in base units (e.g. Satoshis). Guaranteed to not lose precision. The is only returned if the 'expandBalance' query parameter is set to 'true'.
+ description: The cleared balance of the address in base units (e.g. Satoshis). Guaranteed to not lose precision. The is only returned if the `expandBalance` query parameter is set to `true`.
balance:
type: number
- description: The cleared balance of the address in base units (e.g. Satoshis). The is only returned if the 'expandBalance' query parameter is set to 'true'.
+ description: The cleared balance of the address in base units (e.g. Satoshis). The is only returned if the `expandBalance` query parameter is set to `true`.
confirmedBalanceString:
type: string
- description: The total balance of confirmed transactions in base units (e.g. Satoshis). The is only returned if the 'expandBalance' query parameter is set to 'true'. Guaranteed to not lose precision.
+ description: The total balance of confirmed transactions in base units (e.g. Satoshis). The is only returned if the `expandBalance` query parameter is set to `true`. Guaranteed to not lose precision.
confirmedBalance:
type: number
- description: The total balance of confirmed transactions in base units (e.g. Satoshis). The is only returned if the 'expandBalance' query parameter is set to 'true'.
+ description: The total balance of confirmed transactions in base units (e.g. Satoshis). The is only returned if the `expandBalance` query parameter is set to `true`.
spendableBalanceString:
type: string
- description: The total balance in base units (e.g. Satoshis) which may be used as inputs for creating new transactions in string representation. Guaranteed to not lose precision. The is only returned if the 'expandBalance' query parameter is set to 'true'.
+ description: The total balance in base units (e.g. Satoshis) which may be used as inputs for creating new transactions in string representation. Guaranteed to not lose precision. The is only returned if the `expandBalance` query parameter is set to `true`.
spendableBalance:
type: number
- description: The total balance in base units (e.g. Satoshis) which may be used as inputs for creating new transactions in string representation. The is only returned if the 'expandBalance' query parameter is set to 'true'.
+ description: The total balance in base units (e.g. Satoshis) which may be used as inputs for creating new transactions in string representation. The is only returned if the `expandBalance` query parameter is set to `true`.
stakingBalanceString:
type: string
- description: The staked balance in base units. Guaranteed to not lose precision. The is only returned if the 'includeStakingBalances' query parameter is set to 'true'.
+ description: The staked balance in base units. Guaranteed to not lose precision. The is only returned if the `includeStakingBalances` query parameter is set to `true`.
rewardBalanceString:
type: string
- description: The staking reward balance in base units. Guaranteed to not lose precision. The is only returned if the 'includeStakingBalances' query parameter is set to 'true'.
+ description: The staking reward balance in base units. Guaranteed to not lose precision. The is only returned if the `includeStakingBalances` query parameter is set to `true`.
users:
type: array
items:
@@ -58084,11 +59154,11 @@ components:
description: |
Comma-separated list of privileges for a wallet. Includes:
- - 'admin' - Can manage wallet policies and users and approve or reject pending approvals.
- - 'freeze' - Can freeze a wallet, disabling all withdrawals.
- - 'spend' - Can initiate withdrawals and generate new receive addresses.
- - 'trade' - Can initiate trades from a Go Account ('trading' wallet type).
- - 'view' - Can view balances and transactions.
+ - `admin` - Can manage wallet policies and users and approve or reject pending approvals.
+ - `freeze` - Can freeze a wallet, disabling all withdrawals.
+ - `spend` - Can initiate withdrawals and generate new receive addresses.
+ - `trade` - Can initiate trades from a Go Account (`trading` wallet type).
+ - `view` - Can view balances and transactions.
Permissions don't overlap. Required parameter if 'reshare' is false.
enum:
@@ -58133,11 +59203,11 @@ components:
sequenceId:
type: string
description: |
- A 'sequenceId' is a unique and arbitrary wallet identifier applied to transfers and transactions at creation. It is optional but highly recommended. With a 'sequenceId' you can easily reference transfers and transactions—for example, to safely retry sending. Because BitGo only confirms one send request per 'sequenceId' (and fails all subsequent attempts), you can retry sending without the risk of double spending. The 'sequenceId' is only visible to users on the wallet and is not shared publicly. It is the responsibility of the caller to keep track of this ID.
+ A `sequenceId` is a unique and arbitrary wallet identifier applied to transfers and transactions at creation. It is optional but highly recommended. With a `sequenceId` you can easily reference transfers and transactions—for example, to safely retry sending. Because BitGo only confirms one send request per `sequenceId` (and fails all subsequent attempts), you can retry sending without the risk of double spending. The `sequenceId` is only visible to users on the wallet and is not shared publicly. It is the responsibility of the caller to keep track of this ID.
example: abc123
comment:
type: string
- description: The 'comment' is only visible to users on the wallet and is not shared publicly.
+ description: The `comment` is only visible to users on the wallet and is not shared publicly.
required:
- intentType
WalletShare:
@@ -58160,11 +59230,11 @@ components:
description: |
Comma-separated list of privileges for a wallet. Includes:
- - 'admin' - Can manage wallet policies and users and approve or reject pending approvals.
- - 'freeze' - Can freeze a wallet, disabling all withdrawals.
- - 'spend' - Can initiate withdrawals and generate new receive addresses.
- - 'trade' - Can initiate trades from a Go Account ('trading' wallet type).
- - 'view' - Can view balances and transactions.
+ - `admin` - Can manage wallet policies and users and approve or reject pending approvals.
+ - `freeze` - Can freeze a wallet, disabling all withdrawals.
+ - `spend` - Can initiate withdrawals and generate new receive addresses.
+ - `trade` - Can initiate trades from a Go Account (`trading` wallet type).
+ - `view` - Can view balances and transactions.
Permissions don't overlap. Required parameter if 'reshare' is false.
enum:
@@ -58235,11 +59305,11 @@ components:
description: |
Comma-separated list of privileges for a wallet. Includes:
- - 'admin' - Can manage wallet policies and users and approve or reject pending approvals.
- - 'freeze' - Can freeze a wallet, disabling all withdrawals.
- - 'spend' - Can initiate withdrawals and generate new receive addresses.
- - 'trade' - Can initiate trades from a Go Account ('trading' wallet type).
- - 'view' - Can view balances and transactions.
+ - `admin` - Can manage wallet policies and users and approve or reject pending approvals.
+ - `freeze` - Can freeze a wallet, disabling all withdrawals.
+ - `spend` - Can initiate withdrawals and generate new receive addresses.
+ - `trade` - Can initiate trades from a Go Account (`trading` wallet type).
+ - `view` - Can view balances and transactions.
Permissions don't overlap. Required parameter if 'reshare' is false.
enum:
@@ -58471,10 +59541,10 @@ components:
status:
type: string
description: |
- Status of the condition. Indicates if the condition is usable 'ACTIVE' or not 'INACTIVE'.
+ Status of the condition. Indicates if the condition is usable `ACTIVE` or not `INACTIVE`.
- * 'ACTIVE' - The condition is available for use.
- * 'INACTIVE' - The condition is NOT available for use.
+ * `ACTIVE` - The condition is available for use.
+ * `INACTIVE` - The condition is NOT available for use.
enum:
- ACTIVE
- INACTIVE
@@ -58565,7 +59635,7 @@ components:
- $ref: '#/components/schemas/BackingValue'
WalletTypePublic:
type: string
- description: The type describes who owns the keys to the wallet and how they are stored. 'cold' wallets are wallets where the private key of the user key is stored exclusively outside of BitGo's system. 'custodial' means that this wallet is a cold wallet where BitGo owns the keys. Only customers of the BitGo Trust can create this kind of wallet. 'custodialPaired' means that this is a hot wallet that is owned by the customer but it will be linked to a cold (custodial) wallet where BitGo owns the keys. This option is only available to customers of BitGo Inc. BitGo stores an encrypted private key for the user key of 'hot' wallets. 'trading' wallets are trading accounts where the coin is 'ofc'. 'distributedCustody' means You manage one key and another key agent manages the second key. BitGo manages the third key
+ description: The type describes who owns the keys to the wallet and how they are stored. `cold` wallets are wallets where the private key of the user key is stored exclusively outside of BitGo's system. `custodial` means that this wallet is a cold wallet where BitGo owns the keys. Only customers of the BitGo Trust can create this kind of wallet. `custodialPaired` means that this is a hot wallet that is owned by the customer but it will be linked to a cold (custodial) wallet where BitGo owns the keys. This option is only available to customers of BitGo Inc. BitGo stores an encrypted private key for the user key of `hot` wallets. `trading` wallets are trading accounts where the coin is `ofc`. `distributedCustody` means You manage one key and another key agent manages the second key. BitGo manages the third key
enum:
- cold
- custodial
@@ -58864,7 +59934,7 @@ components:
example: 6
state:
type: string
- description: If 'active', indicates the webhook can trigger and send to the URL. If 'suspended', indicates the webhook can't trigger.
+ description: If `active`, indicates the webhook can trigger and send to the URL. If `suspended`, indicates the webhook can't trigger.
enum:
- active
- suspended
@@ -58938,7 +60008,7 @@ components:
$ref: '#/components/schemas/Id'
state:
type: string
- description: If 'failed', webhook notification failed to connect with the target URL. If 'new', webhook notification was newly generated, in response to an event. If 'pending', webhook notification is awaiting processing by the webhook worker. If 'processed', webhook notification successfully sent to target URL. If 'unconfirmed', webhook notification is awaiting confirmation on the blockchain.
+ description: If `failed`, webhook notification failed to connect with the target URL. If `new`, webhook notification was newly generated, in response to an event. If `pending`, webhook notification is awaiting processing by the webhook worker. If `processed`, webhook notification successfully sent to target URL. If `unconfirmed`, webhook notification is awaiting confirmation on the blockchain.
enum:
- failed
- new
@@ -59520,10 +60590,10 @@ components:
description: String representation of the total balance of all wallets containing the given coin which may be used as inputs for creating new transactions. Guaranteed to not lose precision.
stakingBalanceString:
type: string
- description: The staked balance in base units. Guaranteed to not lose precision. The is only returned if the 'includeStakingBalances' query parameter is set to 'true'.
+ description: The staked balance in base units. Guaranteed to not lose precision. The is only returned if the `includeStakingBalances` query parameter is set to `true`.
rewardBalanceString:
type: string
- description: The staking reward balance in base units. Guaranteed to not lose precision. The is only returned if the 'includeStakingBalances' query parameter is set to 'true'.
+ description: The staking reward balance in base units. Guaranteed to not lose precision. The is only returned if the `includeStakingBalances` query parameter is set to `true`.
required:
- balanceString
- confirmedBalanceString