Skip to content

Commit 9ce9b4b

Browse files
Merge pull request #253 from BitGo/update-bitgo-api-docs
Update API reference on BitGo Developer Portal
2 parents c89ba13 + 11803c5 commit 9ce9b4b

File tree

1 file changed

+0
-89
lines changed

1 file changed

+0
-89
lines changed

api.yaml

Lines changed: 0 additions & 89 deletions
Original file line numberDiff line numberDiff line change
@@ -21172,36 +21172,6 @@ paths:
2117221172
oneOf:
2117321173
- $ref: '#/components/schemas/PlatformError3'
2117421174
- $ref: '#/components/schemas/InvalidWalletId'
21175-
/api/v2/{coin}/wallet/{walletId}/lightning/withdraw:
21176-
post:
21177-
tags:
21178-
- Express
21179-
summary: Lightning - Withdraw to an onchain address
21180-
operationId: express.lightning.withdrawOnchain
21181-
description: Withdraw onchain balance from a lightning wallet to a regular onchain address.
21182-
parameters:
21183-
- $ref: '#/components/parameters/pathLightningCoin'
21184-
- $ref: '#/components/parameters/pathWalletId'
21185-
requestBody:
21186-
content:
21187-
application/json:
21188-
schema:
21189-
$ref: '#/components/schemas/ExpressOnchainWithdrawRequest'
21190-
responses:
21191-
'200':
21192-
description: OK
21193-
content:
21194-
application/json:
21195-
schema:
21196-
$ref: '#/components/schemas/ExpressOnchainWithdrawResponse'
21197-
'400':
21198-
description: Bad Request
21199-
content:
21200-
application/json:
21201-
schema:
21202-
oneOf:
21203-
- $ref: '#/components/schemas/PlatformError3'
21204-
- $ref: '#/components/schemas/InvalidWalletId'
2120521175
/api/v2/wallet/{walletId}/lightning/backup:
2120621176
get:
2120721177
tags:
@@ -47452,65 +47422,6 @@ components:
4745247422
amtPaidMsat:
4745347423
type: string
4745447424
description: Amount actually paid in millisatoshis (may be greater than valueMsat)
47455-
ExpressOnchainWithdrawRequest:
47456-
type: object
47457-
properties:
47458-
passphrase:
47459-
type: string
47460-
description: The wallet passphrase.
47461-
recipients:
47462-
type: array
47463-
description: A list of on-chain recipients with their withdrawal amounts.
47464-
items:
47465-
type: object
47466-
properties:
47467-
amountSat:
47468-
type: string
47469-
description: The amount to send in satoshis.
47470-
address:
47471-
type: string
47472-
description: The on-chain Bitcoin address of the recipient.
47473-
satsPerVbyte:
47474-
type: string
47475-
description: The fee rate for the transaction in satoshis per virtual byte.
47476-
sequenceId:
47477-
type: string
47478-
description: Optional sequence ID for the withdrawal transfer.
47479-
comment:
47480-
type: string
47481-
description: Optional comment for the withdrawal transfer.
47482-
required:
47483-
- passphrase
47484-
- recipients
47485-
- satsPerVbyte
47486-
ExpressOnchainWithdrawResponse:
47487-
type: object
47488-
properties:
47489-
txRequestId:
47490-
type: string
47491-
description: Transaction request identifier.
47492-
txRequestState:
47493-
$ref: '#/components/schemas/TransactionRequestState1'
47494-
pendingApproval:
47495-
$ref: '#/components/schemas/PendingApproval1'
47496-
withdrawStatus:
47497-
type: object
47498-
description: The status of the on-chain withdrawal transaction.
47499-
properties:
47500-
status:
47501-
type: string
47502-
enum:
47503-
- delivered
47504-
- failed
47505-
description: State of the withdrawal.
47506-
txid:
47507-
type: string
47508-
description: The transaction ID on the blockchain.
47509-
failureReason:
47510-
type: string
47511-
description: The reason for failure, if any.
47512-
transfer:
47513-
$ref: '#/components/schemas/AnnotatedTransferWithInputsOutputs'
4751447425
ExpressPayInvoiceRequest:
4751547426
type: object
4751647427
properties:

0 commit comments

Comments
 (0)