Skip to content

Commit 0f660f2

Browse files
authored
Merge pull request #16 from BitGo/update-bitgo-api-docs
Update API reference on BitGo Developer Portal
2 parents 586b878 + 8c0c673 commit 0f660f2

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
@@ -34691,10 +34691,6 @@ components:
3469134691
description: ISO 8601 string representation of the timestamp the entry was physically posted
3469234692
example: '2019-06-12T15:28:35.773Z'
3469334693
description: General accounting entry representation
34694-
AmountString:
34695-
type: string
34696-
pattern: ^\d+$
34697-
example: '10100'
3469834694
BlockHash:
3469934695
type: string
3470034696
example: 0000000000000296ed56abee6cb78e40b00c47a03d92e71dd92c4862ca636b95
@@ -34735,104 +34731,6 @@ components:
3473534731
notation:
3473634732
type: string
3473734733
description: The notation on this entry in the DAS ledger
34738-
FeeDescriptor:
34739-
title: General Fee Descriptor
34740-
description: define a fee charged as part of a transaction (same currency only)
34741-
type: object
34742-
properties:
34743-
amount:
34744-
$ref: '#/components/schemas/AmountString'
34745-
notation:
34746-
type: string
34747-
description: Short notation for fee source/info
34748-
example: on chain fee
34749-
fee_type:
34750-
type: string
34751-
enum:
34752-
- WIRE_FEE
34753-
- ELECTRONIC_FEE
34754-
- BANK_FEE
34755-
- CHAIN_FEE
34756-
- BITGO_WITHDRAWAL_FEE
34757-
- BITGO_SETTLEMENT_FEE
34758-
description: 'Each fee type may be treated differently by accounting, revenue fee types: BITGO_WITHDRAWAL_FEE, BITGO_SETTLEMENT_FEE'
34759-
example: BITGO_SETTLEMENT_FEE
34760-
TradeAmountDescriptor:
34761-
type: object
34762-
required:
34763-
- walletId
34764-
- currency
34765-
- amount
34766-
properties:
34767-
walletId:
34768-
$ref: '#/components/schemas/WalletId'
34769-
currency:
34770-
$ref: '#/components/schemas/Coin'
34771-
amount:
34772-
$ref: '#/components/schemas/AmountString'
34773-
receiveAmount:
34774-
$ref: '#/components/schemas/AmountString'
34775-
receiveCurrency:
34776-
$ref: '#/components/schemas/Coin'
34777-
marketValue:
34778-
$ref: '#/components/schemas/AmountString'
34779-
TradeDescriptor:
34780-
allOf:
34781-
- $ref: '#/components/schemas/TradeAmountDescriptor'
34782-
- type: object
34783-
required:
34784-
- backingWallet
34785-
properties:
34786-
backingWallet:
34787-
$ref: '#/components/schemas/WalletId'
34788-
tradeId:
34789-
type: string
34790-
example: abcdef2345abc
34791-
TradeLockDescSigned:
34792-
description: requester party of two-sided locks
34793-
allOf:
34794-
- $ref: '#/components/schemas/TradeLockDescriptor'
34795-
- $ref: '#/components/schemas/TradeSignature'
34796-
TradeLockDescriptor:
34797-
allOf:
34798-
- type: object
34799-
required:
34800-
- lockId
34801-
properties:
34802-
lockId:
34803-
type: string
34804-
example: abcdef012345
34805-
- $ref: '#/components/schemas/TradeAmountDescriptor'
34806-
TradeOneSidedLockSignedDesc:
34807-
allOf:
34808-
- $ref: '#/components/schemas/TradeSignature'
34809-
- type: object
34810-
required:
34811-
- walletId
34812-
properties:
34813-
walletId:
34814-
type: string
34815-
description: walletId of the party signing the payload with their signature
34816-
TradeRequestSigned:
34817-
allOf:
34818-
- $ref: '#/components/schemas/TradeDescriptor'
34819-
- type: object
34820-
properties:
34821-
fees:
34822-
$ref: '#/components/schemas/FeeDescriptor'
34823-
- $ref: '#/components/schemas/TradeSignature'
34824-
TradeSignature:
34825-
type: object
34826-
required:
34827-
- payload
34828-
- signature
34829-
properties:
34830-
payload:
34831-
type: string
34832-
description: 'Stringified(serialized) JSON object containing at least: amount, walletId, currency, and otherParties (for trade). Should also have a significant nonce or salt.'
34833-
signature:
34834-
type: string
34835-
description: Signature of the payload using the proper private key.
3483634734
TxId:
3483734735
type: string
3483834736
description: The on-chain transaction id

0 commit comments

Comments
 (0)