Skip to content

Commit 18fbf86

Browse files
ericcrosson-bitgoericcrosson-bitgo
authored
Merge pull request #148 from BitGo/update-bitgo-api-docs
Update API reference on BitGo Developer Portal
2 parents 7a32633 + 7f4f587 commit 18fbf86

File tree

1 file changed

+122
-89
lines changed

1 file changed

+122
-89
lines changed

‎api.yaml

Lines changed: 122 additions & 89 deletions
Original file line numberDiff line numberDiff line change
@@ -29373,6 +29373,10 @@ paths:
2937329373
type: string
2937429374
format: date-time
2937529375
title: ISO Date String
29376+
- name: prevId
29377+
in: query
29378+
schema:
29379+
type: string
2937629380
- name: walletId
2937729381
in: path
2937829382
required: true
@@ -29384,46 +29388,7 @@ paths:
2938429388
content:
2938529389
application/json:
2938629390
schema:
29387-
type: array
29388-
items:
29389-
type: object
29390-
properties:
29391-
valueMsat:
29392-
type: string
29393-
format: number
29394-
paymentHash:
29395-
type: string
29396-
invoice:
29397-
type: string
29398-
walletId:
29399-
type: string
29400-
status:
29401-
$ref: '#/components/schemas/InvoiceStatus'
29402-
expiresAt:
29403-
type: string
29404-
format: date-time
29405-
title: ISO Date String
29406-
createdAt:
29407-
type: string
29408-
format: date-time
29409-
title: ISO Date String
29410-
updatedAt:
29411-
type: string
29412-
format: date-time
29413-
title: ISO Date String
29414-
amtPaidMsat:
29415-
type: string
29416-
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.
29417-
format: number
29418-
required:
29419-
- valueMsat
29420-
- paymentHash
29421-
- invoice
29422-
- walletId
29423-
- status
29424-
- expiresAt
29425-
- createdAt
29426-
- updatedAt
29391+
$ref: '#/components/schemas/GetInvoicesResponse'
2942729392
'400':
2942829393
description: Bad Request
2942929394
content:
@@ -29589,6 +29554,10 @@ paths:
2958929554
type: string
2959029555
format: date-time
2959129556
title: ISO Date String
29557+
- name: prevId
29558+
in: query
29559+
schema:
29560+
type: string
2959229561
- name: walletId
2959329562
in: path
2959429563
required: true
@@ -29600,55 +29569,7 @@ paths:
2960029569
content:
2960129570
application/json:
2960229571
schema:
29603-
type: array
29604-
items:
29605-
type: object
29606-
description: Off-chain payment information
29607-
properties:
29608-
paymentHash:
29609-
type: string
29610-
walletId:
29611-
type: string
29612-
txRequestId:
29613-
type: string
29614-
status:
29615-
$ref: '#/components/schemas/PaymentStatus'
29616-
invoice:
29617-
type: string
29618-
feeLimitMsat:
29619-
type: string
29620-
format: number
29621-
destination:
29622-
type: string
29623-
updatedAt:
29624-
type: string
29625-
format: date-time
29626-
title: ISO Date String
29627-
createdAt:
29628-
type: string
29629-
format: date-time
29630-
title: ISO Date String
29631-
amountMsat:
29632-
type: string
29633-
format: number
29634-
feeMsat:
29635-
type: string
29636-
format: number
29637-
failureReason:
29638-
$ref: '#/components/schemas/PaymentFailureReason'
29639-
paymentPreimage:
29640-
type: string
29641-
required:
29642-
- paymentHash
29643-
- walletId
29644-
- txRequestId
29645-
- status
29646-
- invoice
29647-
- feeLimitMsat
29648-
- destination
29649-
- updatedAt
29650-
- createdAt
29651-
- amountMsat
29572+
$ref: '#/components/schemas/GetPaymentsResponse'
2965229573
'400':
2965329574
description: Bad Request
2965429575
content:
@@ -43772,6 +43693,118 @@ components:
4377243693
- userId
4377343694
- userEmail
4377443695
- derivedPubkey
43696+
GetInvoicesResponse:
43697+
title: GetInvoicesResponse
43698+
type: object
43699+
properties:
43700+
invoices:
43701+
type: array
43702+
items:
43703+
type: object
43704+
properties:
43705+
memo:
43706+
type: string
43707+
description: A memo or description for the invoice
43708+
example: Payment for the coffee
43709+
invoice:
43710+
type: string
43711+
description: The BOLT \#11 encoded invoice
43712+
example: lnbc500n1p3zv5vkpp5x0thcaz8wep54clc2xt5895azjdzmthyskzzh9yslggy74qtvl6sdpdg3hkuct5d9hkugrxdaezqjn0dphk2fmnypkk2mtsdahkccqzpgxqyz5vqsp5v80q4vq4pwakq2l0hcqgtelgajsymv4ud4jdcrqtnzhvet55qlus9qyyssquqh2wl2m866qs5n72c5vg6wmqx9vzwhs5ypualq4mcu76h2tdkcq3jtjwtggfff7xwtdqxlnwqk8cxpzryjghrmmq3syraswp9vjr7cqry9l96
43713+
paymentHash:
43714+
type: string
43715+
description: The payment hash of the invoice
43716+
example: 63d9ce82e09d16761a85116ed8b65407db4fb22f85d03573de09c480f2c6d175
43717+
valueMsat:
43718+
type: string
43719+
description: The value of the invoice in satoshis
43720+
example: '50000'
43721+
format: number
43722+
expiresAt:
43723+
type: string
43724+
description: ISO-8601 string representing when the invoice will expire
43725+
example: '2022-04-01T18:46:24.677Z'
43726+
format: date-time
43727+
title: ISO Date String
43728+
status:
43729+
type: string
43730+
enum:
43731+
- open
43732+
- settled
43733+
- canceled
43734+
description: The status of the invoice
43735+
walletId:
43736+
allOf:
43737+
- $ref: '#/components/schemas/WalletIdString'
43738+
description: The wallet to which this invoice belongs
43739+
required:
43740+
- invoice
43741+
- paymentHash
43742+
- valueMsat
43743+
- expiresAt
43744+
- status
43745+
- walletId
43746+
nextBatchPrevId:
43747+
type: string
43748+
required:
43749+
- invoices
43750+
GetPaymentsResponse:
43751+
title: GetPaymentsResponse
43752+
type: object
43753+
properties:
43754+
payments:
43755+
type: array
43756+
items:
43757+
type: object
43758+
description: Off-chain payment information
43759+
properties:
43760+
paymentHash:
43761+
type: string
43762+
walletId:
43763+
type: string
43764+
txRequestId:
43765+
type: string
43766+
status:
43767+
$ref: '#/components/schemas/PaymentStatus'
43768+
invoice:
43769+
type: string
43770+
feeLimitMsat:
43771+
type: string
43772+
format: number
43773+
destination:
43774+
type: string
43775+
updatedAt:
43776+
type: string
43777+
format: date-time
43778+
title: ISO Date String
43779+
createdAt:
43780+
type: string
43781+
format: date-time
43782+
title: ISO Date String
43783+
amountMsat:
43784+
type: string
43785+
format: number
43786+
feeMsat:
43787+
type: string
43788+
format: number
43789+
failureReason:
43790+
$ref: '#/components/schemas/PaymentFailureReason'
43791+
paymentPreimage:
43792+
type: string
43793+
required:
43794+
- paymentHash
43795+
- walletId
43796+
- txRequestId
43797+
- status
43798+
- invoice
43799+
- feeLimitMsat
43800+
- destination
43801+
- updatedAt
43802+
- createdAt
43803+
- amountMsat
43804+
nextBatchPrevId:
43805+
type: string
43806+
required:
43807+
- payments
4377543808
GetPinnedWalletsCountResponse:
4377643809
title: GetPinnedWalletsCountResponse
4377743810
type: object

0 commit comments

Comments
 (0)