wallets.md

Wallets

• List Coin Wallets
• Get Wallet Details
• List Wallet Transfers
• Get Wallet Transfer Details
• Create Wallet Address
• Get Wallet Address
• Create Transfer Request
• Get Transfer Request
• Get Wallet Pending Approvals

List Coin Wallets

GET /:coin/wallets

Returns an array of Wallet objects.

Wallet Body Fields

Please refer to Wallet object

Get Wallet Details

GET /:coin/wallets/:walletId

Returns Wallet object.

Wallet Object Fields

Name	Type(value)	Mandatory	Description
walletId	String	M	Wallet id
label	String	M	Wallet label
coin	String	M	Coin id
balance	String	M	Wallet balance on blockchain
availableBalance	String	M	Available balance for spending

Get Wallet Transfers

GET /:coin/wallet/:walletId/transfers

Returns an array of wallet Transfer objects.

Wallet Transfer Body Fields

Please refer to Transfer object

Get Wallet Transfer Details

GET /:coin/wallet/:walletId/transfers/:transferId

Returns wallet Transfer object

Transfer Object Fields

Name	Type(value)	Mandatory	Description
transferId	String	M	Transfer id
coin	String	M	Coin id
walletId	String	M	Wallet id
txid	String	M	Txid on blockchain
createdTime	Long	M	Time the transfer was created
lastModifiedTime	Long	M	Time the transfer was last updated
confirmations	Integer	M	Number of confirmations
transferState	Enum	M	Please refer to transferState in enums file
confirmedTime	Long	M	Time the transfer was confirmed

Create Wallet Address

POST /:coin/wallets/:walletId/addresses

Returns Address object.

Address Body Fields

Please refer to Address object

Get Wallet Address

GET /:coin/wallets/:walletId/addresses/:address

Returns Address object.

Address Object Fields

Name	Type(value)	Mandatory	Description
address	String	M	Coin address
coin	String	M	Coin id
walletId	String	M	Wallet id
createdTime	Long	M	Time the address was created

Create Transfer Request

PUT /:coin/wallets/:walletId/transferRequests

Request Parameters

Name	Type(value)	Mandatory	Description
walletPassPhrase	String	M	Wallet pass phrase
amount	DoubleString	M	The amount to be sent
toAddress	String	M	The address to send to
comment	String	O	Notes for the transfer

Transfer Request Body Fields

Please refer to TransferRequest object

Get Transfer Request

GET /:coin/wallets/:walletId/transferRequests/:transferRequestId

Returns Transfer Request Object

Transfer Request Fields

Name	Type(value)	Mandatory	Description
transferRequestId	String	M	Transfer request id
coin	String	M	Coin Id
walletId	String	M	Wallet Id
toAddress	String	M	Send to address
amount	DoubleString	M	The amount to be sent
comment	String	O	Notes for the transfer
transferState	Enum	M	Please refer to transferState in enums
approvalsRequired	Integer	M	Number of approvals required
createdTime	Long	M	Created time
createdBy	String	M	User id that is used to create the transfer request
apiKey	String	O	Exists if the request is sent through api
transferId	String	O	Transfer id
txid	String	O	Txid on blockchain

List Wallet Pending Approvals

GET /:coin/wallets/:walletId/transferRequests?transferState=PENDING_APPROVAL

Returns an array of Transfer Request Objects with transfer state of PENDING_APPROVAL

Pending Approval Transfer Request Object Fields

Please refer to TransferRequest object