Skip to content

Commit 530e009

Browse files
Merge pull request #409 from BitGo/update-bitgo-api-docs
Update API reference on BitGo Developer Portal
2 parents 9f9afef + eb5b6c8 commit 530e009

2 files changed

Lines changed: 63 additions & 0 deletions

File tree

api.yaml

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29918,6 +29918,7 @@ paths:
2991829918
additionalProperties: true
2991929919
/api/fiat/v1/transaction/ach-debit:
2992029920
post:
29921+
x-internal: false
2992129922
summary: Initiate ACH deposit
2992229923
description: Initiate an ACH deposit transaction from a linked bank account.
2992329924
operationId: fiat.ach.deposit
@@ -29992,6 +29993,7 @@ paths:
2999229993
$ref: '#/components/schemas/V1ErrorResponse'
2999329994
/api/tradfi/v1/enterprise-transfer-limits/{enterpriseId}/{currency}/{transferType}/{transferDirection}:
2999429995
get:
29996+
x-internal: false
2999529997
summary: List enterprise transfer limits
2999629998
description: List the transfer limits for an enterprise based on currency, transfer type, and direction.
2999729999
operationId: tradfi.v1.enterprise.transfer.limits
@@ -30084,6 +30086,7 @@ paths:
3008430086
$ref: '#/components/schemas/V1ErrorResponse'
3008530087
/api/tradfi/v1/bank-transfers:
3008630088
post:
30089+
x-internal: false
3008730090
summary: Create a bank transfer
3008830091
description: Creates a new bank transfer using the `walletId` and `bankAccountId` as counterparties. Most details are inferred from `bankAccountId`. The `walletId` and `bankAccountId` must be owned by the same `enterpriseId`.
3008930092
operationId: tradfi.v1.bank-transfers.create
@@ -30175,6 +30178,7 @@ paths:
3017530178
$ref: '#/components/schemas/V1ErrorResponse'
3017630179
/api/tradfi/v1/bank-transfers/{id}:
3017730180
get:
30181+
x-internal: false
3017830182
summary: Get a bank transfer
3017930183
description: Gets a bank transfer by its `id` or `txid`. Either identifier may be used interchangeably.
3018030184
operationId: tradfi.v1.bank-transfers.get
@@ -30220,6 +30224,7 @@ paths:
3022030224
$ref: '#/components/schemas/V1ErrorResponse'
3022130225
/api/fiat/v1/transaction/ach-debit/agreement:
3022230226
get:
30227+
x-internal: false
3022330228
summary: Get ACH agreement
3022430229
description: Get the ACH agreement for a specific bank account.
3022530230
operationId: fiat.ach.agreement
@@ -30317,6 +30322,7 @@ paths:
3031730322
$ref: '#/components/schemas/V1ErrorResponse'
3031830323
/api/accounts/v1/address:
3031930324
get:
30325+
x-internal: false
3032030326
tags:
3032130327
- Bank Accounts
3032230328
operationId: fiat.address.info
@@ -30398,6 +30404,7 @@ paths:
3039830404
$ref: '#/components/schemas/V1ErrorResponse'
3039930405
/api/tradfi/v1/banks/{bankType}/{routingNumber}:
3040030406
get:
30407+
x-internal: false
3040130408
tags:
3040230409
- Bank Accounts
3040330410
summary: Verify routing number by bank type
@@ -30456,6 +30463,7 @@ paths:
3045630463
$ref: '#/components/schemas/V1ErrorResponse'
3045730464
/api/tradfi/v1/plaid/link/token:
3045830465
post:
30466+
x-internal: false
3045930467
summary: Create Plaid Link token
3046030468
description: |
3046130469
Creates a Plaid Link token for initiating the Plaid Link flow.
@@ -30537,6 +30545,7 @@ paths:
3053730545
$ref: '#/components/schemas/V1ErrorResponse'
3053830546
/api/tradfi/v1/plaid/link/token/exchange:
3053930547
post:
30548+
x-internal: false
3054030549
summary: Exchange Plaid Public Token
3054130550
description: |
3054230551
Exchanges a public token received from Plaid Link for secure storage.
@@ -30617,6 +30626,7 @@ paths:
3061730626
$ref: '#/components/schemas/V1ErrorResponse'
3061830627
/api/v2/bankaccounts:
3061930628
get:
30629+
x-internal: false
3062030630
tags:
3062130631
- Bank Accounts
3062230632
summary: List bank accounts
@@ -30723,6 +30733,7 @@ paths:
3072330733
schema:
3072430734
$ref: '#/components/schemas/V1ErrorResponse'
3072530735
post:
30736+
x-internal: false
3072630737
tags:
3072730738
- Bank Accounts
3072830739
summary: Add bank account
@@ -30776,6 +30787,7 @@ paths:
3077630787
$ref: '#/components/schemas/V1ErrorResponse'
3077730788
/api/v2/bankaccounts/{bankAccountId}:
3077830789
delete:
30790+
x-internal: false
3077930791
tags:
3078030792
- Bank Accounts
3078130793
summary: Delete bank account
@@ -30832,6 +30844,7 @@ paths:
3083230844
schema:
3083330845
$ref: '#/components/schemas/V1ErrorResponse'
3083430846
get:
30847+
x-internal: false
3083530848
tags:
3083630849
- Bank Accounts
3083730850
summary: Get bank account
@@ -30876,6 +30889,7 @@ paths:
3087630889
schema:
3087730890
$ref: '#/components/schemas/V1ErrorResponse'
3087830891
put:
30892+
x-internal: false
3087930893
tags:
3088030894
- Bank Accounts
3088130895
summary: Update bank account
@@ -31028,6 +31042,7 @@ paths:
3102831042
$ref: '#/components/schemas/V1ErrorResponse'
3102931043
/api/v2/bankaccounts/deposit/info:
3103031044
get:
31045+
x-internal: false
3103131046
tags:
3103231047
- Bank Accounts
3103331048
summary: Get deposit info
@@ -36611,6 +36626,8 @@ paths:
3661136626
- tradeOrder
3661236627
- unspentExpiry
3661336628
- twoStepTransfer
36629+
- twoStepDeposit
36630+
- twoStepWithdrawal
3661436631
example: transfer
3661536632
- name: prevId
3661636633
description: The ID of the item to start at
@@ -54350,6 +54367,8 @@ components:
5435054367
$ref: '#/components/schemas/optionalString'
5435154368
isConsolidate:
5435254369
type: boolean
54370+
numberOfSplits:
54371+
type: number
5435354372
unspents:
5435454373
$ref: '#/components/schemas/optionalStringArray'
5435554374
required:
@@ -75420,6 +75439,25 @@ components:
7542075439
- recipients
7542175440
- $ref: '#/components/schemas/BaseIntent'
7542275441
- $ref: '#/components/schemas/SolBuildOptions'
75442+
SolCloseAssociatedTokenAccountIntent1:
75443+
title: SOL Close Associated Token Account Intent
75444+
allOf:
75445+
- type: object
75446+
properties:
75447+
intentType:
75448+
type: string
75449+
enum:
75450+
- closeAssociatedTokenAccount
75451+
recipients:
75452+
type: array
75453+
minItems: 1
75454+
items:
75455+
$ref: '#/components/schemas/RecipientEntry1'
75456+
required:
75457+
- intentType
75458+
- recipients
75459+
- $ref: '#/components/schemas/BaseIntent1'
75460+
- $ref: '#/components/schemas/SolBuildOptions1'
7542375461
SolConsolidateIntent:
7542475462
title: SOL Consolidate Intent
7542575463
allOf:
@@ -80604,6 +80642,7 @@ components:
8060480642
- $ref: '#/components/schemas/NearUnstakeIntent1'
8060580643
- $ref: '#/components/schemas/NearWithdrawIntent1'
8060680644
- $ref: '#/components/schemas/SolClaimIntent1'
80645+
- $ref: '#/components/schemas/SolCloseAssociatedTokenAccountIntent1'
8060780646
- $ref: '#/components/schemas/SolCreateAssociatedTokenAccountIntent1'
8060880647
- $ref: '#/components/schemas/SolStakeIntent1'
8060980648
- $ref: '#/components/schemas/SolUnstakeIntent1'
@@ -90628,6 +90667,8 @@ components:
9062890667
- stuckTx
9062990668
- unspentExpiry
9063090669
- twoStepTransfer
90670+
- twoStepDeposit
90671+
- twoStepWithdrawal
9063190672
WalletsResponse:
9063290673
type: object
9063390674
properties:
@@ -91101,6 +91142,8 @@ components:
9110191142
- tradeOrder
9110291143
- unspentExpiry
9110391144
- twoStepTransfer
91145+
- twoStepDeposit
91146+
- twoStepWithdrawal
9110491147
WebhookTypeBlock:
9110591148
type: string
9110691149
enum:

express-api.yaml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6598,6 +6598,25 @@ components:
65986598
- amount
65996599
- $ref: '#/components/schemas/WithdrawIntent1'
66006600
- $ref: '#/components/schemas/SolBuildOptions1'
6601+
SolCloseAssociatedTokenAccountIntent1:
6602+
title: SOL Close Associated Token Account Intent
6603+
allOf:
6604+
- type: object
6605+
properties:
6606+
intentType:
6607+
type: string
6608+
enum:
6609+
- closeAssociatedTokenAccount
6610+
recipients:
6611+
type: array
6612+
minItems: 1
6613+
items:
6614+
$ref: '#/components/schemas/RecipientEntry1'
6615+
required:
6616+
- intentType
6617+
- recipients
6618+
- $ref: '#/components/schemas/BaseIntent1'
6619+
- $ref: '#/components/schemas/SolBuildOptions1'
66016620
SolCreateAssociatedTokenAccountIntent1:
66026621
title: SOL Create Associated Token Account Intent
66036622
allOf:
@@ -6867,6 +6886,7 @@ components:
68676886
- $ref: '#/components/schemas/NearUnstakeIntent1'
68686887
- $ref: '#/components/schemas/NearWithdrawIntent1'
68696888
- $ref: '#/components/schemas/SolClaimIntent1'
6889+
- $ref: '#/components/schemas/SolCloseAssociatedTokenAccountIntent1'
68706890
- $ref: '#/components/schemas/SolCreateAssociatedTokenAccountIntent1'
68716891
- $ref: '#/components/schemas/SolStakeIntent1'
68726892
- $ref: '#/components/schemas/SolUnstakeIntent1'

0 commit comments

Comments
 (0)