Skip to content

Commit d2302c0

Browse files
Merge pull request #23 from BitGo/update-bitgo-api-docs
Update API reference on BitGo Developer Portal
2 parents 951e783 + ef40fd2 commit d2302c0

File tree

1 file changed

+0
-102
lines changed

1 file changed

+0
-102
lines changed

api.yaml

Lines changed: 0 additions & 102 deletions
Original file line numberDiff line numberDiff line change
@@ -34657,10 +34657,6 @@ components:
3465734657
description: ISO 8601 string representation of the timestamp the entry was physically posted
3465834658
example: '2019-06-12T15:28:35.773Z'
3465934659
description: General accounting entry representation
34660-
AmountString:
34661-
type: string
34662-
pattern: ^\d+$
34663-
example: '10100'
3466434660
BlockHash:
3466534661
type: string
3466634662
example: 0000000000000296ed56abee6cb78e40b00c47a03d92e71dd92c4862ca636b95
@@ -34701,104 +34697,6 @@ components:
3470134697
notation:
3470234698
type: string
3470334699
description: The notation on this entry in the DAS ledger
34704-
FeeDescriptor:
34705-
title: General Fee Descriptor
34706-
description: define a fee charged as part of a transaction (same currency only)
34707-
type: object
34708-
properties:
34709-
amount:
34710-
$ref: '#/components/schemas/AmountString'
34711-
notation:
34712-
type: string
34713-
description: Short notation for fee source/info
34714-
example: on chain fee
34715-
fee_type:
34716-
type: string
34717-
enum:
34718-
- WIRE_FEE
34719-
- ELECTRONIC_FEE
34720-
- BANK_FEE
34721-
- CHAIN_FEE
34722-
- BITGO_WITHDRAWAL_FEE
34723-
- BITGO_SETTLEMENT_FEE
34724-
description: 'Each fee type may be treated differently by accounting, revenue fee types: BITGO_WITHDRAWAL_FEE, BITGO_SETTLEMENT_FEE'
34725-
example: BITGO_SETTLEMENT_FEE
34726-
TradeAmountDescriptor:
34727-
type: object
34728-
required:
34729-
- walletId
34730-
- currency
34731-
- amount
34732-
properties:
34733-
walletId:
34734-
$ref: '#/components/schemas/WalletId'
34735-
currency:
34736-
$ref: '#/components/schemas/Coin'
34737-
amount:
34738-
$ref: '#/components/schemas/AmountString'
34739-
receiveAmount:
34740-
$ref: '#/components/schemas/AmountString'
34741-
receiveCurrency:
34742-
$ref: '#/components/schemas/Coin'
34743-
marketValue:
34744-
$ref: '#/components/schemas/AmountString'
34745-
TradeDescriptor:
34746-
allOf:
34747-
- $ref: '#/components/schemas/TradeAmountDescriptor'
34748-
- type: object
34749-
required:
34750-
- backingWallet
34751-
properties:
34752-
backingWallet:
34753-
$ref: '#/components/schemas/WalletId'
34754-
tradeId:
34755-
type: string
34756-
example: abcdef2345abc
34757-
TradeLockDescSigned:
34758-
description: requester party of two-sided locks
34759-
allOf:
34760-
- $ref: '#/components/schemas/TradeLockDescriptor'
34761-
- $ref: '#/components/schemas/TradeSignature'
34762-
TradeLockDescriptor:
34763-
allOf:
34764-
- type: object
34765-
required:
34766-
- lockId
34767-
properties:
34768-
lockId:
34769-
type: string
34770-
example: abcdef012345
34771-
- $ref: '#/components/schemas/TradeAmountDescriptor'
34772-
TradeOneSidedLockSignedDesc:
34773-
allOf:
34774-
- $ref: '#/components/schemas/TradeSignature'
34775-
- type: object
34776-
required:
34777-
- walletId
34778-
properties:
34779-
walletId:
34780-
type: string
34781-
description: walletId of the party signing the payload with their signature
34782-
TradeRequestSigned:
34783-
allOf:
34784-
- $ref: '#/components/schemas/TradeDescriptor'
34785-
- type: object
34786-
properties:
34787-
fees:
34788-
$ref: '#/components/schemas/FeeDescriptor'
34789-
- $ref: '#/components/schemas/TradeSignature'
34790-
TradeSignature:
34791-
type: object
34792-
required:
34793-
- payload
34794-
- signature
34795-
properties:
34796-
payload:
34797-
type: string
34798-
description: 'Stringified(serialized) JSON object containing at least: amount, walletId, currency, and otherParties (for trade). Should also have a significant nonce or salt.'
34799-
signature:
34800-
type: string
34801-
description: Signature of the payload using the proper private key.
3480234700
TxId:
3480334701
type: string
3480434702
description: The on-chain transaction id

0 commit comments

Comments
 (0)