From 7f4f5875b2764f3a27f56dcca26e45332522805e Mon Sep 17 00:00:00 2001
From: "dev-portal-updater[bot]"
 <149019135+dev-portal-updater[bot]@users.noreply.github.com>
Date: Thu, 22 May 2025 20:57:39 +0000
Subject: [PATCH] feat: update `bitgo-api-docs` This commit updates the BitGo
 API.

---
 api.yaml | 211 ++++++++++++++++++++++++++++++++-----------------------
 1 file changed, 122 insertions(+), 89 deletions(-)

diff --git a/api.yaml b/api.yaml
index 6d76493..30bdfab 100644
--- a/api.yaml
+++ b/api.yaml
@@ -29373,6 +29373,10 @@ paths:
             type: string
             format: date-time
             title: ISO Date String
+        - name: prevId
+          in: query
+          schema:
+            type: string
         - name: walletId
           in: path
           required: true
@@ -29384,46 +29388,7 @@ paths:
           content:
             application/json:
               schema:
-                type: array
-                items:
-                  type: object
-                  properties:
-                    valueMsat:
-                      type: string
-                      format: number
-                    paymentHash:
-                      type: string
-                    invoice:
-                      type: string
-                    walletId:
-                      type: string
-                    status:
-                      $ref: '#/components/schemas/InvoiceStatus'
-                    expiresAt:
-                      type: string
-                      format: date-time
-                      title: ISO Date String
-                    createdAt:
-                      type: string
-                      format: date-time
-                      title: ISO Date String
-                    updatedAt:
-                      type: string
-                      format: date-time
-                      title: ISO Date String
-                    amtPaidMsat:
-                      type: string
-                      description: The number of millisats actually paid to this invoice, this may be greater than the amount requested by the invoice, since lightning allows overpaying (but not underpaying) invoices.
-                      format: number
-                  required:
-                    - valueMsat
-                    - paymentHash
-                    - invoice
-                    - walletId
-                    - status
-                    - expiresAt
-                    - createdAt
-                    - updatedAt
+                $ref: '#/components/schemas/GetInvoicesResponse'
         '400':
           description: Bad Request
           content:
@@ -29589,6 +29554,10 @@ paths:
             type: string
             format: date-time
             title: ISO Date String
+        - name: prevId
+          in: query
+          schema:
+            type: string
         - name: walletId
           in: path
           required: true
@@ -29600,55 +29569,7 @@ paths:
           content:
             application/json:
               schema:
-                type: array
-                items:
-                  type: object
-                  description: Off-chain payment information
-                  properties:
-                    paymentHash:
-                      type: string
-                    walletId:
-                      type: string
-                    txRequestId:
-                      type: string
-                    status:
-                      $ref: '#/components/schemas/PaymentStatus'
-                    invoice:
-                      type: string
-                    feeLimitMsat:
-                      type: string
-                      format: number
-                    destination:
-                      type: string
-                    updatedAt:
-                      type: string
-                      format: date-time
-                      title: ISO Date String
-                    createdAt:
-                      type: string
-                      format: date-time
-                      title: ISO Date String
-                    amountMsat:
-                      type: string
-                      format: number
-                    feeMsat:
-                      type: string
-                      format: number
-                    failureReason:
-                      $ref: '#/components/schemas/PaymentFailureReason'
-                    paymentPreimage:
-                      type: string
-                  required:
-                    - paymentHash
-                    - walletId
-                    - txRequestId
-                    - status
-                    - invoice
-                    - feeLimitMsat
-                    - destination
-                    - updatedAt
-                    - createdAt
-                    - amountMsat
+                $ref: '#/components/schemas/GetPaymentsResponse'
         '400':
           description: Bad Request
           content:
@@ -43772,6 +43693,118 @@ components:
         - userId
         - userEmail
         - derivedPubkey
+    GetInvoicesResponse:
+      title: GetInvoicesResponse
+      type: object
+      properties:
+        invoices:
+          type: array
+          items:
+            type: object
+            properties:
+              memo:
+                type: string
+                description: A memo or description for the invoice
+                example: Payment for the coffee
+              invoice:
+                type: string
+                description: The BOLT \#11 encoded invoice
+                example: lnbc500n1p3zv5vkpp5x0thcaz8wep54clc2xt5895azjdzmthyskzzh9yslggy74qtvl6sdpdg3hkuct5d9hkugrxdaezqjn0dphk2fmnypkk2mtsdahkccqzpgxqyz5vqsp5v80q4vq4pwakq2l0hcqgtelgajsymv4ud4jdcrqtnzhvet55qlus9qyyssquqh2wl2m866qs5n72c5vg6wmqx9vzwhs5ypualq4mcu76h2tdkcq3jtjwtggfff7xwtdqxlnwqk8cxpzryjghrmmq3syraswp9vjr7cqry9l96
+              paymentHash:
+                type: string
+                description: The payment hash of the invoice
+                example: 63d9ce82e09d16761a85116ed8b65407db4fb22f85d03573de09c480f2c6d175
+              valueMsat:
+                type: string
+                description: The value of the invoice in satoshis
+                example: '50000'
+                format: number
+              expiresAt:
+                type: string
+                description: ISO-8601 string representing when the invoice will expire
+                example: '2022-04-01T18:46:24.677Z'
+                format: date-time
+                title: ISO Date String
+              status:
+                type: string
+                enum:
+                  - open
+                  - settled
+                  - canceled
+                description: The status of the invoice
+              walletId:
+                allOf:
+                  - $ref: '#/components/schemas/WalletIdString'
+                description: The wallet to which this invoice belongs
+            required:
+              - invoice
+              - paymentHash
+              - valueMsat
+              - expiresAt
+              - status
+              - walletId
+        nextBatchPrevId:
+          type: string
+      required:
+        - invoices
+    GetPaymentsResponse:
+      title: GetPaymentsResponse
+      type: object
+      properties:
+        payments:
+          type: array
+          items:
+            type: object
+            description: Off-chain payment information
+            properties:
+              paymentHash:
+                type: string
+              walletId:
+                type: string
+              txRequestId:
+                type: string
+              status:
+                $ref: '#/components/schemas/PaymentStatus'
+              invoice:
+                type: string
+              feeLimitMsat:
+                type: string
+                format: number
+              destination:
+                type: string
+              updatedAt:
+                type: string
+                format: date-time
+                title: ISO Date String
+              createdAt:
+                type: string
+                format: date-time
+                title: ISO Date String
+              amountMsat:
+                type: string
+                format: number
+              feeMsat:
+                type: string
+                format: number
+              failureReason:
+                $ref: '#/components/schemas/PaymentFailureReason'
+              paymentPreimage:
+                type: string
+            required:
+              - paymentHash
+              - walletId
+              - txRequestId
+              - status
+              - invoice
+              - feeLimitMsat
+              - destination
+              - updatedAt
+              - createdAt
+              - amountMsat
+        nextBatchPrevId:
+          type: string
+      required:
+        - payments
     GetPinnedWalletsCountResponse:
       title: GetPinnedWalletsCountResponse
       type: object