From a41d91b514124ba260fb6fd46ba3d0e3ce0f82d7 Mon Sep 17 00:00:00 2001 From: "dev-portal-updater[bot]" <149019135+dev-portal-updater[bot]@users.noreply.github.com> Date: Thu, 6 Mar 2025 20:58:37 +0000 Subject: [PATCH] feat: update `bitgo-api-docs` This commit updates the BitGo API. --- api.yaml | 729 +++++++++++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 686 insertions(+), 43 deletions(-) diff --git a/api.yaml b/api.yaml index c452940..aa75cc6 100644 --- a/api.yaml +++ b/api.yaml @@ -15666,7 +15666,7 @@ paths: schema: oneOf: - $ref: '#/components/schemas/PlatformError3' - - $ref: '#/components/schemas/InvalidWalletId' + - $ref: '#/components/schemas/InvalidWalletId1' put: tags: - Wallet Policy @@ -15701,7 +15701,7 @@ paths: schema: oneOf: - $ref: '#/components/schemas/PlatformError3' - - $ref: '#/components/schemas/InvalidWalletId' + - $ref: '#/components/schemas/InvalidWalletId1' delete: tags: - Wallet Policy @@ -15736,7 +15736,7 @@ paths: schema: oneOf: - $ref: '#/components/schemas/PlatformError3' - - $ref: '#/components/schemas/InvalidWalletId' + - $ref: '#/components/schemas/InvalidWalletId1' /api/v2/pendingApprovals: get: tags: @@ -15861,7 +15861,7 @@ paths: schema: oneOf: - $ref: '#/components/schemas/PlatformError3' - - $ref: '#/components/schemas/InvalidWalletId' + - $ref: '#/components/schemas/InvalidWalletId1' '404': description: Not Found content: @@ -15912,7 +15912,7 @@ paths: oneOf: - $ref: '#/components/schemas/PlatformError3' - $ref: '#/components/schemas/InvalidTransferId' - - $ref: '#/components/schemas/InvalidWalletId' + - $ref: '#/components/schemas/InvalidWalletId1' /api/v2/{coin}/wallet/{walletId}/transfer/sequenceId/{sequenceId}: get: tags: @@ -15943,7 +15943,7 @@ paths: schema: oneOf: - $ref: '#/components/schemas/PlatformError3' - - $ref: '#/components/schemas/InvalidWalletId' + - $ref: '#/components/schemas/InvalidWalletId1' /api/v2/user/lock: post: description: | @@ -16227,7 +16227,7 @@ paths: - $ref: '#/components/schemas/PlatformError3' - $ref: '#/components/schemas/CannotRemoveAdmin' - $ref: '#/components/schemas/InvalidUserId' - - $ref: '#/components/schemas/InvalidWalletId' + - $ref: '#/components/schemas/InvalidWalletId1' '404': description: Not Found /api/v2/{coin}/wallet/{walletId}/freeze: @@ -16263,7 +16263,7 @@ paths: schema: oneOf: - $ref: '#/components/schemas/PlatformError3' - - $ref: '#/components/schemas/InvalidWalletId' + - $ref: '#/components/schemas/InvalidWalletId1' '401': description: Unauthorized content: @@ -16309,7 +16309,7 @@ paths: schema: oneOf: - $ref: '#/components/schemas/PlatformError3' - - $ref: '#/components/schemas/InvalidWalletId' + - $ref: '#/components/schemas/InvalidWalletId1' '403': description: Forbidden content: @@ -16366,7 +16366,7 @@ paths: schema: oneOf: - $ref: '#/components/schemas/PlatformError3' - - $ref: '#/components/schemas/InvalidWalletId' + - $ref: '#/components/schemas/InvalidWalletId1' '404': description: Not Found content: @@ -16399,7 +16399,7 @@ paths: schema: oneOf: - $ref: '#/components/schemas/PlatformError3' - - $ref: '#/components/schemas/InvalidWalletId' + - $ref: '#/components/schemas/InvalidWalletId1' '404': description: Not Found content: @@ -16805,7 +16805,7 @@ paths: schema: oneOf: - $ref: '#/components/schemas/PlatformError3' - - $ref: '#/components/schemas/InvalidWalletId' + - $ref: '#/components/schemas/InvalidWalletId1' /api/v2/{coin}/webhooks: post: tags: @@ -17335,7 +17335,7 @@ paths: oneOf: - $ref: '#/components/schemas/PlatformError3' - $ref: '#/components/schemas/InvalidAddress1' - - $ref: '#/components/schemas/InvalidWalletId' + - $ref: '#/components/schemas/InvalidWalletId1' /api/v2/{coin}/wallet/{walletId}/consolidateUnspents: post: tags: @@ -17365,7 +17365,7 @@ paths: schema: oneOf: - $ref: '#/components/schemas/PlatformError3' - - $ref: '#/components/schemas/InvalidWalletId' + - $ref: '#/components/schemas/InvalidWalletId1' /api/v2/{coin}/wallet/{walletId}/tx/initiate: post: tags: @@ -17400,7 +17400,7 @@ paths: schema: oneOf: - $ref: '#/components/schemas/PlatformError3' - - $ref: '#/components/schemas/InvalidWalletId' + - $ref: '#/components/schemas/InvalidWalletId1' /api/v2/{coin}/wallet/{walletId}/tx/send: post: tags: @@ -17439,7 +17439,7 @@ paths: schema: oneOf: - $ref: '#/components/schemas/PlatformError3' - - $ref: '#/components/schemas/InvalidWalletId' + - $ref: '#/components/schemas/InvalidWalletId1' - $ref: '#/components/schemas/DuplicateSequenceId1' - $ref: '#/components/schemas/InvalidOFAC' '423': @@ -17477,7 +17477,7 @@ paths: schema: oneOf: - $ref: '#/components/schemas/PlatformError3' - - $ref: '#/components/schemas/InvalidWalletId' + - $ref: '#/components/schemas/InvalidWalletId1' /api/v2/{coin}/requiredReserve: get: tags: @@ -17834,7 +17834,7 @@ paths: schema: oneOf: - $ref: '#/components/schemas/PlatformError3' - - $ref: '#/components/schemas/InvalidWalletId' + - $ref: '#/components/schemas/InvalidWalletId1' /api/v2/{coin}/wallet/{walletId}/sendmany: post: tags: @@ -17876,7 +17876,7 @@ paths: schema: oneOf: - $ref: '#/components/schemas/PlatformError3' - - $ref: '#/components/schemas/InvalidWalletId' + - $ref: '#/components/schemas/InvalidWalletId1' /api/v2/encrypt: post: tags: @@ -18093,7 +18093,7 @@ paths: schema: oneOf: - $ref: '#/components/schemas/PlatformError3' - - $ref: '#/components/schemas/InvalidWalletId' + - $ref: '#/components/schemas/InvalidWalletId1' /api/v2/{coin}/wallet/{walletId}/signtxtss: post: tags: @@ -18145,7 +18145,7 @@ paths: schema: oneOf: - $ref: '#/components/schemas/PlatformError3' - - $ref: '#/components/schemas/InvalidWalletId' + - $ref: '#/components/schemas/InvalidWalletId1' /api/v2/{coin}/wallet/{walletId}/consolidateAccount/build: post: tags: @@ -18176,7 +18176,7 @@ paths: oneOf: - $ref: '#/components/schemas/PlatformError3' - $ref: '#/components/schemas/InvalidAddress1' - - $ref: '#/components/schemas/InvalidWalletId' + - $ref: '#/components/schemas/InvalidWalletId1' /api/v2/{coin}/wallet/{walletId}/consolidateunspents: post: tags: @@ -18206,7 +18206,7 @@ paths: schema: oneOf: - $ref: '#/components/schemas/PlatformError3' - - $ref: '#/components/schemas/InvalidWalletId' + - $ref: '#/components/schemas/InvalidWalletId1' /api/v2/{coin}/wallet/{walletId}/fanoutunspents: post: tags: @@ -18236,7 +18236,7 @@ paths: schema: oneOf: - $ref: '#/components/schemas/PlatformError3' - - $ref: '#/components/schemas/InvalidWalletId' + - $ref: '#/components/schemas/InvalidWalletId1' /api/v2/{coin}/wallet/{walletId}/sweep: post: tags: @@ -18269,7 +18269,7 @@ paths: schema: oneOf: - $ref: '#/components/schemas/PlatformError3' - - $ref: '#/components/schemas/InvalidWalletId' + - $ref: '#/components/schemas/InvalidWalletId1' /api/v2/{coin}/wallet/{walletId}/acceleratetx: post: tags: @@ -18315,7 +18315,7 @@ paths: schema: oneOf: - $ref: '#/components/schemas/PlatformError3' - - $ref: '#/components/schemas/InvalidWalletId' + - $ref: '#/components/schemas/InvalidWalletId1' /api/v2/{coin}/wallet/{walletId}/transfer/{transferId}/comment: post: tags: @@ -18349,7 +18349,7 @@ paths: schema: oneOf: - $ref: '#/components/schemas/PlatformError3' - - $ref: '#/components/schemas/InvalidWalletId' + - $ref: '#/components/schemas/InvalidWalletId1' - $ref: '#/components/schemas/InvalidTransferId' '401': description: Unauthorized @@ -18472,7 +18472,7 @@ paths: schema: oneOf: - $ref: '#/components/schemas/PlatformError3' - - $ref: '#/components/schemas/InvalidWalletId' + - $ref: '#/components/schemas/InvalidWalletId1' /api/v2/{coin}/wallet/{walletId}/initwallet: post: tags: @@ -18502,7 +18502,7 @@ paths: schema: oneOf: - $ref: '#/components/schemas/PlatformError3' - - $ref: '#/components/schemas/InvalidWalletId' + - $ref: '#/components/schemas/InvalidWalletId1' /api/v2/{coin}/wallet/{walletId}/signermacaroon: post: tags: @@ -18532,7 +18532,7 @@ paths: schema: oneOf: - $ref: '#/components/schemas/PlatformError3' - - $ref: '#/components/schemas/InvalidWalletId' + - $ref: '#/components/schemas/InvalidWalletId1' /api/v2/{coin}/wallet/{walletId}/unlockwallet: post: tags: @@ -18562,7 +18562,302 @@ paths: schema: oneOf: - $ref: '#/components/schemas/PlatformError3' - - $ref: '#/components/schemas/InvalidWalletId' + - $ref: '#/components/schemas/InvalidWalletId1' + /api/v2/{coin}/wallet/{walletId}/lightning/invoice: + post: + tags: + - Express + summary: Lightning - Create A Lightning Invoice + operationId: express.lightning.createInvoice + description: Create a Lightning Network Daemon (LND) invoice for the given wallet. + parameters: + - $ref: '#/components/parameters/pathLightningCoin' + - $ref: '#/components/parameters/pathWalletId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ExpressCreateInvoiceRequest' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/ExpressCreateInvoiceResponse' + '400': + description: Bad Request + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/PlatformError3' + - $ref: '#/components/schemas/InvalidWalletId1' + /api/v2/{coin}/wallet/{walletId}/lightning/invoices: + get: + tags: + - Express + summary: Lightning - List Invoices + operationId: express.lightning.listInvoices + description: List Lightning Network invoices for the given wallet. + parameters: + - $ref: '#/components/parameters/pathLightningCoin' + - $ref: '#/components/parameters/pathWalletId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ExpressCreateInvoiceRequest' + responses: + '200': + description: OK + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ExpressListInvoicesResponse' + '400': + description: Bad Request + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/PlatformError3' + - $ref: '#/components/schemas/InvalidWalletId1' + /api/v2/{coin}/wallet/{walletId}/lightning/invoice/{paymentHash}: + get: + tags: + - Express + summary: Lightning - Get Invoice + operationId: express.lightning.getInvoice + description: Get a single Lightning Network invoice by payment hash. + parameters: + - $ref: '#/components/parameters/pathLightningCoin' + - $ref: '#/components/parameters/pathWalletId' + - name: paymentHash + in: path + required: true + schema: + type: string + description: The payment hash of the invoice + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/ExpressListInvoicesResponse' + '400': + description: Bad Request + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/PlatformError3' + - $ref: '#/components/schemas/InvalidWalletId1' + /api/v2/{coin}/wallet/{walletId}/lightning/pay: + post: + tags: + - Express + summary: Lightning - Pay a Lightning Invoice + operationId: express.lightning.payInvoice + description: Pay a Lightning Network invoice from the given wallet. + parameters: + - $ref: '#/components/parameters/pathLightningCoin' + - $ref: '#/components/parameters/pathWalletId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ExpressPayInvoiceRequest' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/ExpressPayInvoiceResponse' + '400': + description: Bad Request + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/PlatformError3' + - $ref: '#/components/schemas/InvalidWalletId1' + /api/v2/{coin}/wallet/{walletId}/lightning/payment: + get: + tags: + - Express + summary: Lightning - List Payments + operationId: express.lightning.listPayments + description: List Lightning Network payments for the given wallet. + parameters: + - $ref: '#/components/parameters/pathLightningCoin' + - $ref: '#/components/parameters/pathWalletId' + - in: query + name: PaymentQuery + schema: + $ref: '#/components/schemas/ExpressListPaymentRequest' + responses: + '200': + description: OK + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/LightningPaymentInfo' + '400': + description: Bad Request + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/PlatformError3' + - $ref: '#/components/schemas/InvalidWalletId1' + /api/v2/{coin}/wallet/{walletId}/lightning/payment/{paymentHash}: + get: + tags: + - Express + summary: Lightning - Get Payment + operationId: express.lightning.getPayment + description: Retrieve Lightning Network payment information for the given payment hash. + parameters: + - $ref: '#/components/parameters/pathLightningCoin' + - $ref: '#/components/parameters/pathWalletId' + - name: paymentHash + in: path + required: true + schema: + type: string + description: The payment hash of the Lightning Network payment. + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/LightningPaymentInfo' + '400': + description: Bad Request + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/PlatformError3' + - $ref: '#/components/schemas/InvalidWalletId1' + /api/v2/{coin}/wallet/{walletId}/lightning/transaction: + get: + tags: + - Express + summary: Lightning - List Onchain Transactions + operationId: express.lightning.listTransactions + description: List Lightning Network transactions for the given wallet. + parameters: + - $ref: '#/components/parameters/pathLightningCoin' + - $ref: '#/components/parameters/pathWalletId' + - in: query + name: blockHeight + schema: + type: string + description: Filter transactions by block height + - in: query + name: limit + schema: + type: string + description: Maximum number of transactions to return + - in: query + name: startDate + schema: + type: string + format: date-time + description: Start date for transaction query in ISO format + - in: query + name: endDate + schema: + type: string + format: date-time + description: End date for transaction query in ISO format + responses: + '200': + description: OK + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/LightningTransaction' + '400': + description: Bad Request + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/PlatformError3' + - $ref: '#/components/schemas/InvalidWalletId1' + /api/v2/{coin}/wallet/{walletId}/lightning/transaction/{txid}: + get: + tags: + - Express + summary: Lightning - Get Onchain Transaction + operationId: express.lightning.getTransaction + description: Retrieve Lightning Network transaction information for the given transaction ID. + parameters: + - $ref: '#/components/parameters/pathLightningCoin' + - $ref: '#/components/parameters/pathWalletId' + - name: txid + in: path + required: true + schema: + type: string + description: The transaction ID of the Lightning Network transaction. + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/LightningTransaction' + '400': + description: Bad Request + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/PlatformError3' + - $ref: '#/components/schemas/InvalidWalletId1' + /api/v2/{coin}/wallet/lightning/{walletId}: + put: + tags: + - Express + summary: Update Wallet + operationId: express.updateWallet + description: Update wallet details. + parameters: + - $ref: '#/components/parameters/pathCoin' + - $ref: '#/components/parameters/pathWalletId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ExpressUpdateWalletRequest' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Wallet1' + '400': + description: Bad Request + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/PlatformError3' + - $ref: '#/components/schemas/InvalidWalletId1' /api/v2/{coin}/wallet/{walletId}/consolidateAccount: post: tags: @@ -18592,7 +18887,7 @@ paths: schema: oneOf: - $ref: '#/components/schemas/PlatformError3' - - $ref: '#/components/schemas/InvalidWalletId' + - $ref: '#/components/schemas/InvalidWalletId1' /api/policy/v1/enterprises/{enterpriseId}/rules: get: tags: @@ -22450,7 +22745,7 @@ paths: schema: oneOf: - $ref: '#/components/schemas/PlatformError' - - $ref: '#/components/schemas/InvalidWalletId1' + - $ref: '#/components/schemas/InvalidWalletId' '403': description: Forbidden content: @@ -22507,7 +22802,7 @@ paths: schema: oneOf: - $ref: '#/components/schemas/PlatformError' - - $ref: '#/components/schemas/InvalidWalletId1' + - $ref: '#/components/schemas/InvalidWalletId' /api/v2/{coin}/wallet/{walletId}/fundforwarders: post: summary: Send funds to forwarder @@ -22669,7 +22964,7 @@ paths: schema: oneOf: - $ref: '#/components/schemas/PlatformError' - - $ref: '#/components/schemas/InvalidWalletId1' + - $ref: '#/components/schemas/InvalidWalletId' /api/v2/{coin}/wallet/{walletId}/tx/changeFee: post: summary: Change Fee @@ -34329,6 +34624,10 @@ components: $ref: '#/components/schemas/PolicyRuleUpdateConditions' action: $ref: '#/components/schemas/PolicyRuleActions' + lockDate: + type: string + description: The time at which this rule becomes immutable + format: date-time required: - id - type @@ -37099,6 +37398,48 @@ components: description: address to use for generated outputs. Must be wallet address. txFormat: $ref: '#/components/schemas/UtxoTransactionFormat' + ExpressCreateInvoiceRequest: + type: object + required: + - valueMsat + properties: + valueMsat: + type: string + description: The invoice amount in millisatoshis + memo: + type: string + description: Optional description for the invoice + expiry: + type: number + description: Optional expiration time in seconds + ExpressCreateInvoiceResponse: + type: object + properties: + valueMsat: + type: string + description: Amount in millisatoshis + paymentHash: + type: string + description: Payment hash of the invoice + invoice: + type: string + description: The BOLT 11 encoded invoice string + walletId: + type: string + description: The public BitGo walletId to which this invoice belongs + status: + type: string + enum: + - open + - settled + - canceled + description: Current status of the invoice + expiresAt: + type: string + description: Expiration date in ISO format + memo: + type: string + description: Optional memo field ExpressCreateKeychainResponse: type: object description: Generated key pair @@ -37391,6 +37732,120 @@ components: - RPC_ACTIVE - SERVER_ACTIVE - WAITING_TO_START + ExpressListInvoicesResponse: + type: object + properties: + valueMsat: + type: string + description: Amount in millisatoshis + paymentHash: + type: string + description: Payment hash of the invoice + invoice: + type: string + description: The BOLT 11 encoded invoice string + walletId: + type: string + description: The public BitGo walletId to which this invoice belongs to + status: + type: string + enum: + - open + - settled + - canceled + description: Current status of the invoice + expiresAt: + type: string + format: date-time + description: Expiration date in ISO format + createdAt: + type: string + format: date-time + description: Creation date in ISO format + updatedAt: + type: string + format: date-time + description: Last update date in ISO format + amtPaidMsat: + type: string + description: Amount actually paid in millisatoshis (may be greater than valueMsat) + ExpressListPaymentRequest: + type: object + properties: + status: + type: string + enum: + - in_flight + - settled + - failed + description: Filter payments by status + limit: + type: string + description: Maximum number of payments to return + startDate: + type: string + format: date-time + description: Start date for payment query in ISO format + endDate: + type: string + format: date-time + description: End date for payment query in ISO format + ExpressPayInvoiceRequest: + type: object + properties: + invoice: + type: string + description: The BOLT 11 invoice to pay + amountMsat: + type: string + description: The amount to pay in millisatoshis + passphrase: + type: string + description: The wallet passphrase + sequenceId: + type: string + description: Optional sequence ID for the payment transfer + comment: + type: string + description: Optional comment for the payment transfer + required: + - invoice + - amountMsat + - passphrase + ExpressPayInvoiceResponse: + type: object + properties: + txRequestId: + type: string + description: Transaction request identifier + txRequestState: + $ref: '#/components/schemas/TransactionRequestState1' + pendingApproval: + $ref: '#/components/schemas/PendingApproval1' + paymentStatus: + type: object + properties: + status: + type: string + enum: + - in_flight + - settled + - failed + description: State of the lightning payment + paymentHash: + type: string + description: Hash of the lightning payment, unique identifier used when doing transfer lookup + paymentPreimage: + type: string + description: Optional preimage of the payment + amountMsat: + type: string + description: Amount in millisatoshis + feeMsat: + type: string + description: Fee in millisatoshis + failureReason: + $ref: '#/components/schemas/LightningPaymentFailureReason' ExpressPingResponse: type: object properties: @@ -37725,6 +38180,21 @@ components: message: type: string example: ok + ExpressUpdateWalletRequest: + type: object + properties: + passphrase: + type: string + description: Wallet passphrase - required for lightning update + signerMacaroon: + type: string + description: Optional signer macaroon (Lightning only) + signerAdminMacaroon: + type: string + description: Optional signer admin macaroon (Lightning only) + signerTlsKey: + type: string + description: Optional signer TLS key (Lightning only) ExpressVerifyCoinAddressRequest: type: object properties: @@ -39879,29 +40349,29 @@ components: required: - name InvalidWalletId: - title: Invalid wallet id + title: Invalid Wallet ID allOf: - - $ref: '#/components/schemas/InvalidId1' - - properties: + - type: object + properties: name: type: string - description: Error code enum: - InvalidWalletId required: - name + - $ref: '#/components/schemas/InvalidId' InvalidWalletId1: - title: Invalid Wallet ID + title: Invalid wallet id allOf: - - type: object - properties: + - $ref: '#/components/schemas/InvalidId1' + - properties: name: type: string + description: Error code enum: - InvalidWalletId required: - name - - $ref: '#/components/schemas/InvalidId' Ip: type: string format: ipv4 @@ -40420,6 +40890,94 @@ components: type: string required: - keys + LightningOutput: + type: object + properties: + id: + type: string + description: Output ID + value: + type: integer + description: Output value + valueString: + type: string + description: Output value as string + wallet: + type: string + description: Wallet ID + address: + type: string + description: Output address + LightningPaymentFailureReason: + type: string + enum: + - TIMEOUT + - NO_ROUTE + - ERROR + - INCORRECT_PAYMENT_DETAILS + - INSUFFICIENT_BALANCE + - INSUFFICIENT_WALLET_BALANCE + - EXCESS_WALLET_BALANCE + - INVOICE_EXPIRED + - CANCELED + description: | + Reason for payment failure: + * TIMEOUT - Payment timed out + * NO_ROUTE - No route found + * ERROR - Non-recoverable error + * INCORRECT_PAYMENT_DETAILS - Payment details are incorrect + * INSUFFICIENT_BALANCE - Insufficient channel outbound capacity + * INSUFFICIENT_WALLET_BALANCE - Insufficient custodial lightning balance + * EXCESS_WALLET_BALANCE - Excess custodial lightning balance + * INVOICE_EXPIRED - Invoice has expired + * CANCELED - Payment was canceled + LightningPaymentInfo: + type: object + properties: + paymentHash: + type: string + description: Payment hash of the payment + walletId: + type: string + description: The public BitGo walletId to which this payment belongs + txRequestId: + type: string + description: Transaction request ID + status: + type: string + enum: + - in_flight + - settled + - failed + description: Current status of the payment + invoice: + type: string + description: The BOLT 11 encoded invoice string + feeLimitMsat: + type: string + description: Fee limit in millisatoshis + destination: + type: string + description: Destination of the payment + updatedAt: + type: string + format: date-time + description: Last update date in ISO format + createdAt: + type: string + format: date-time + description: Creation date in ISO format + amountMsat: + type: string + description: Amount in millisatoshis + feeMsat: + type: string + description: Fee in millisatoshis + failureReason: + $ref: '#/components/schemas/LightningPaymentFailureReason' + paymentPreimage: + type: string + description: Payment preimage LightningPaymentIntent: title: Lightning Payment Intent allOf: @@ -40460,6 +41018,87 @@ components: required: - request - signature + LightningTransaction: + type: object + properties: + id: + type: string + description: Transaction ID + normalizedTxHash: + type: string + description: Normalized transaction hash + blockHeight: + type: integer + description: Block height + blockHash: + type: string + description: Block hash + blockPosition: + type: integer + description: Block position + inputIds: + type: array + items: + type: string + description: List of input IDs + entries: + type: array + items: + $ref: '#/components/schemas/LightningTransactionEntry' + description: List of transaction entries + inputs: + type: array + items: + $ref: '#/components/schemas/LightningOutput' + description: List of transaction inputs + outputs: + type: array + items: + $ref: '#/components/schemas/LightningOutput' + description: List of transaction outputs + size: + type: integer + description: Transaction size + date: + type: string + format: date-time + description: Transaction date + fee: + type: integer + description: Transaction fee + feeString: + type: string + description: Transaction fee as string + hex: + type: string + description: Transaction hex + confirmations: + type: integer + description: Number of confirmations + label: + type: string + description: Transaction label + LightningTransactionEntry: + type: object + properties: + inputs: + type: integer + description: Number of inputs + outputs: + type: integer + description: Number of outputs + value: + type: integer + description: Transaction value + valueString: + type: string + description: Transaction value as string + address: + type: string + description: Transaction address + wallet: + type: string + description: Wallet ID LightningWalletAddress: title: LightningWalletAddress allOf: @@ -50774,6 +51413,10 @@ components: $ref: '#/components/schemas/PolicyRuleUpdateConditions' action: $ref: '#/components/schemas/PolicyRuleActions' + lockDate: + type: string + description: The time at which this rule becomes immutable + format: date-time required: - id - type