Skip to content

Commit a608280

Browse files
Merge pull request #229 from BitGo/update-bitgo-api-docs
Update API reference on BitGo Developer Portal
2 parents 43e7810 + a39129a commit a608280

File tree

1 file changed

+16
-161
lines changed

1 file changed

+16
-161
lines changed

api.yaml

Lines changed: 16 additions & 161 deletions
Original file line numberDiff line numberDiff line change
@@ -24358,7 +24358,7 @@ paths:
2435824358
/api/fiat/v1/transaction/ach-debit:
2435924359
post:
2436024360
summary: Initiate ACH deposit
24361-
description: Initiates an ACH deposit transaction from a linked bank account
24361+
description: Initiate an ACH deposit transaction from a linked bank account.
2436224362
operationId: fiat.ach.deposit
2436324363
tags:
2436424364
- Fiat
@@ -24427,8 +24427,8 @@ paths:
2442724427
$ref: '#/components/schemas/V1ErrorResponse'
2442824428
/api/tradfi/v1/enterprise-transfer-limits/{enterpriseId}/{currency}/{transferType}/{transferDirection}:
2442924429
get:
24430-
summary: Get enterprise transfer limits
24431-
description: Retrieves transfer limits for an enterprise based on currency, transfer type, and direction
24430+
summary: List enterprise transfer limits
24431+
description: List the transfer limits for an enterprise based on currency, transfer type, and direction.
2443224432
operationId: tradfi.v1.enterprise.transfer.limits
2443324433
tags:
2443424434
- Fiat
@@ -24520,6 +24520,7 @@ paths:
2452024520
/api/fiat/v1/transaction/ach-debit/agreement:
2452124521
get:
2452224522
summary: Get ACH agreement
24523+
description: Get the ACH agreement for a specific bank account.
2452324524
operationId: fiat.ach.agreement
2452424525
tags:
2452524526
- Fiat
@@ -24612,142 +24613,6 @@ paths:
2461224613
application/json:
2461324614
schema:
2461424615
$ref: '#/components/schemas/V1ErrorResponse'
24615-
/api/accounts/internal/v1/bankaccounts:
24616-
post:
24617-
tags:
24618-
- Fiat
24619-
operationId: V1PostBankAccountsInternalRoute
24620-
parameters: []
24621-
requestBody:
24622-
content:
24623-
application/json:
24624-
schema:
24625-
type: object
24626-
properties:
24627-
shortCountryCode:
24628-
type: string
24629-
minLength: 1
24630-
accountNumber:
24631-
type: string
24632-
minLength: 1
24633-
enterpriseId:
24634-
type: string
24635-
minLength: 1
24636-
bitgoOrg:
24637-
$ref: '#/components/schemas/TrustOrg2'
24638-
currency:
24639-
$ref: '#/components/schemas/BackingFiatCoin'
24640-
type:
24641-
$ref: '#/components/schemas/BankAccountType1'
24642-
name:
24643-
type: string
24644-
minLength: 1
24645-
ownerName:
24646-
type: string
24647-
minLength: 1
24648-
routingNumber:
24649-
type: string
24650-
swiftCode:
24651-
type: string
24652-
externalId:
24653-
type: string
24654-
minLength: 1
24655-
furtherCreditTo:
24656-
type: string
24657-
minLength: 1
24658-
intermediaryBankName:
24659-
type: string
24660-
minLength: 1
24661-
intermediaryBankId:
24662-
type: string
24663-
minLength: 1
24664-
description:
24665-
type: string
24666-
accountType:
24667-
type: string
24668-
nullable: true
24669-
enum:
24670-
- checking
24671-
- saving
24672-
- unknown
24673-
ownerAddressLine1:
24674-
type: string
24675-
minLength: 1
24676-
ownerAddressLine2:
24677-
type: string
24678-
minLength: 1
24679-
ownerAddressCityLocality:
24680-
type: string
24681-
minLength: 1
24682-
ownerAddressStateProvince:
24683-
type: string
24684-
minLength: 1
24685-
ownerAddressPostalCode:
24686-
type: string
24687-
minLength: 1
24688-
ownerAddressCountryCode:
24689-
type: string
24690-
minLength: 1
24691-
bankAddressLine1:
24692-
type: string
24693-
minLength: 1
24694-
bankAddressLine2:
24695-
type: string
24696-
minLength: 1
24697-
bankAddressCityLocality:
24698-
type: string
24699-
minLength: 1
24700-
bankAddressStateProvince:
24701-
type: string
24702-
minLength: 1
24703-
bankAddressPostalCode:
24704-
type: string
24705-
minLength: 1
24706-
bankAddressCountryCode:
24707-
type: string
24708-
minLength: 1
24709-
virtualDepositOnly:
24710-
type: boolean
24711-
required:
24712-
- shortCountryCode
24713-
- accountNumber
24714-
- enterpriseId
24715-
- bitgoOrg
24716-
- currency
24717-
- type
24718-
- name
24719-
- virtualDepositOnly
24720-
responses:
24721-
'200':
24722-
description: OK
24723-
content:
24724-
application/json:
24725-
schema:
24726-
$ref: '#/components/schemas/V1GetBankAccountResponse'
24727-
'400':
24728-
description: Bad Request
24729-
content:
24730-
application/json:
24731-
schema:
24732-
$ref: '#/components/schemas/V1ErrorResponse'
24733-
'401':
24734-
description: Unauthorized
24735-
content:
24736-
application/json:
24737-
schema:
24738-
$ref: '#/components/schemas/V1ErrorResponse'
24739-
'404':
24740-
description: Not Found
24741-
content:
24742-
application/json:
24743-
schema:
24744-
$ref: '#/components/schemas/V1ErrorResponse'
24745-
'500':
24746-
description: Internal Server Error
24747-
content:
24748-
application/json:
24749-
schema:
24750-
$ref: '#/components/schemas/V1ErrorResponse'
2475124616
/api/accounts/v1/address:
2475224617
get:
2475324618
tags:
@@ -24833,8 +24698,8 @@ paths:
2483324698
get:
2483424699
tags:
2483524700
- Fiat
24836-
summary: Get Bank Accounts
24837-
description: Endpoint to get bank accounts
24701+
summary: List bank accounts
24702+
description: List all bank accounts associated with a BitGo enterprise.
2483824703
operationId: v2.bankaccount.list
2483924704
x-unknown-tags:
2484024705
tags: Fiat Accounts
@@ -24941,9 +24806,9 @@ paths:
2494124806
post:
2494224807
tags:
2494324808
- Fiat
24944-
summary: Create Bank Account
24945-
description: Endpoint to create a bank account
24946-
operationId: v2.bankaccount.create
24809+
summary: Add bank account
24810+
description: Add a bank account to a BitGo enterprise so you can deposit and withdraw fiat.
24811+
operationId: v2.bankaccount.add
2494724812
x-unknown-tags:
2494824813
tags: Fiat Accounts
2494924814
parameters: []
@@ -24993,8 +24858,8 @@ paths:
2499324858
delete:
2499424859
tags:
2499524860
- Fiat
24996-
summary: Delete Bank Account
24997-
description: Endpoint to delete bank account
24861+
summary: Delete bank account
24862+
description: Delete a bank account associated with a BitGo enterprise.
2499824863
operationId: v2.bankaccount.delete
2499924864
x-unknown-tags:
2500024865
tags: Fiat Accounts
@@ -25051,8 +24916,8 @@ paths:
2505124916
get:
2505224917
tags:
2505324918
- Fiat
25054-
summary: Get Bank Account
25055-
description: Endpoint to get single bank account by id
24919+
summary: Get bank account
24920+
description: Get a bank account associated with a BitGo enterprise by its ID.
2505624921
operationId: v2.bankaccount.get
2505724922
x-unknown-tags:
2505824923
tags: Fiat Accounts
@@ -25097,8 +24962,8 @@ paths:
2509724962
put:
2509824963
tags:
2509924964
- Fiat
25100-
summary: Update Bank Account
25101-
description: Endpoint to update a single bank account
24965+
summary: Update bank account
24966+
description: Update a bank account associated with a BitGo enterprise.
2510224967
operationId: v2.bankaccount.update
2510324968
x-unknown-tags:
2510424969
tags: Fiat Accounts
@@ -25252,7 +25117,7 @@ paths:
2525225117
tags:
2525325118
- Fiat
2525425119
summary: Get deposit info
25255-
description: Returns the bank accounts available for deposits on the specific enterprise
25120+
description: Get BitGo's bank account information so you can deposit fiat into a Go Account.
2525625121
operationId: fiat.get.deposit.info
2525725122
x-unknown-tags:
2525825123
tags: Fiat Accounts
@@ -38944,16 +38809,6 @@ components:
3894438809
- cbit
3894538810
- null
3894638811
example: wire
38947-
BankAccountType1:
38948-
title: BankAccountType
38949-
type: string
38950-
enum:
38951-
- wire
38952-
- cbit
38953-
- ach
38954-
- blinc
38955-
- swift
38956-
- sepa
3895738812
BankAccountsArrayResponse:
3895838813
title: BankAccountsArrayResponse
3895938814
description: Unified schema for an array of bank accounts

0 commit comments

Comments
 (0)