Class Settlements

Hierarchy

Settlements

Index

Constructors

constructor

Methods

Constructors

constructor

new Settlements(bitgo: BitGo, enterpriseId: string, account?: TradingAccount): Settlements

- Defined in drone/src/modules/core/src/v2/trading/settlements.ts:33
Parameters
- bitgo: BitGo
- enterpriseId: string
- Optional account: TradingAccount
Returns Settlements

Methods

create

create(params: CreateSettlementParams, callback?: NodeCallback<Settlement>): Bluebird<Settlement>

- Defined in drone/src/modules/core/src/v2/trading/settlements.ts:98
Submits a new settlement for a set of trades. NOTE: This function must be called as tradingAccount.settlements().create(), enterprise.settlements().create() is not a valid call.

Parameters
- params: CreateSettlementParams
- Optional callback: NodeCallback<Settlement>
Returns Bluebird<Settlement>

get

get(__namedParameters: object, callback?: NodeCallback<Settlement>): Bluebird<Settlement>

- Defined in drone/src/modules/core/src/v2/trading/settlements.ts:70
Retrieves a single settlement by its ID.

Parameters
- __namedParameters: object
- Optional callback: NodeCallback<Settlement>
Returns Bluebird<Settlement>

list

list(callback?: NodeCallback<Settlement[]>): Bluebird<Settlement[]>

- Defined in drone/src/modules/core/src/v2/trading/settlements.ts:45
Retrieves all settlements for an enterprise

Parameters
- Optional callback: NodeCallback<Settlement[]>
Returns Bluebird<Settlement[]>

Generated using TypeDoc