Merge pull request #153 from BitGo/update-bitgo-api-docs

Update API reference on BitGo Developer Portal

Author: ericcrosson-bitgo

api.yaml

@@ -43710,47 +43710,42 @@ components:
           items:
             type: object
             properties:
-              memo:
-                type: string
-                description: A memo or description for the invoice
-                example: Payment for the coffee
-              invoice:
+              valueMsat:
                 type: string
-                description: The BOLT \#11 encoded invoice
-                example: lnbc500n1p3zv5vkpp5x0thcaz8wep54clc2xt5895azjdzmthyskzzh9yslggy74qtvl6sdpdg3hkuct5d9hkugrxdaezqjn0dphk2fmnypkk2mtsdahkccqzpgxqyz5vqsp5v80q4vq4pwakq2l0hcqgtelgajsymv4ud4jdcrqtnzhvet55qlus9qyyssquqh2wl2m866qs5n72c5vg6wmqx9vzwhs5ypualq4mcu76h2tdkcq3jtjwtggfff7xwtdqxlnwqk8cxpzryjghrmmq3syraswp9vjr7cqry9l96
+                format: number
               paymentHash:
                 type: string
-                description: The payment hash of the invoice
-                example: 63d9ce82e09d16761a85116ed8b65407db4fb22f85d03573de09c480f2c6d175
-              valueMsat:
+              invoice:
                 type: string
-                description: The value of the invoice in satoshis
-                example: '50000'
-                format: number
+              walletId:
+                type: string
+              status:
+                $ref: '#/components/schemas/InvoiceStatus'
               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:
+              createdAt:
                 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
+                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:
-              - invoice
-              - paymentHash
               - valueMsat
-              - expiresAt
-              - status
+              - paymentHash
+              - invoice
               - walletId
+              - status
+              - expiresAt
+              - createdAt
+              - updatedAt
         nextBatchPrevId:
           type: string
       required: