This section give's control for system wallets.
For a wallet to be stored in the DB,it must be provided with a valid address,currency and a label.
Admin logged in - gets data from an external wallet service (the wallet service is connected to a wallet provider) - admin has abillity to create new wallets,and transfer between it's own wallets.
User logged in - can save to his account any wallet he own's (in case the wallet can be verified,and in case the system is supporting this wallet's currency type).
Returns a list of saved wallets in the system.
Success
Unauthorized
{- "api_message": "<string>",
- "api_data": {
- "wallets": [
- {
- "id": "<string>",
- "user_id": "<string>",
- "external_wallet_id": "<string>",
- "address": "<string>",
- "name": "<string>",
- "description": "<string>",
- "protocol": "<string>",
- "currency": "<string>",
- "ip": "<string>",
- "created_by_id": "<string>",
- "created_at": "<datetime string>",
- "updated_at": "<datetime string>",
- "kyt_score": 1
}
]
}
}Create a new Wallet in the system
Success
Unauthorized
Unprocessable Content
Internal Server Error
{- "address": "0x1bdb47ce8be9334df9ec0fe096aec74802646e70",
- "name": "USDC Wallet",
- "description": "Description of the Wallet",
- "protocol": "ERC20",
- "currency": "ETH"
}{- "api_message": "<string>",
- "api_data": {
- "wallet": {
- "id": "<string>",
- "user_id": "<string>",
- "external_wallet_id": "<string>",
- "address": "<string>",
- "name": "<string>",
- "description": "<string>",
- "protocol": "<string>",
- "currency": "<string>",
- "ip": "<string>",
- "created_by_id": "<string>",
- "created_at": "<datetime string>",
- "updated_at": "<datetime string>",
- "kyt_score": 1
}
}
}Return statistics about wallet holdings in supported wallet providers.
Success
Unauthorized
Forbidden
Internal Server Error
{- "api_message": "<string>",
- "api_data": {
- "[wallet_provider_name]": {
- "[currency_name]": {
- "hot": 1,
- "cold": 1,
- "custodial": 1
}
}
}
}Returns address for requested currency in path parameter
Success
Unauthorized
Internal Server Error
{- "api_message": "<string>",
- "api_data": {
- "address": "<string>"
}
}Returns all wallets matching the requested currency
Success
Unauthorized
Forbidden
Internal Server Error
{- "api_message": "<string>",
- "api_data": [
- {
- "id": "<string>",
- "currency": "<string>",
- "label": "<string>",
- "address": "<string>",
- "balance": 100,
- "created_at": "<datetime string>",
- "type": "<string>"
}
]
}Returns all completed wallet's trnsfers with specific currency
Success
Unauthorized
Unprocessable Content
Internal Server Error
{- "api_message": "<string>",
- "api_data": {
- "transfers": [
- {
- "coin": "<string>",
- "id": "<string>",
- "wallet": "<string>",
- "enterprise": "<string>",
- "txid": "<string>",
- "txidType": "<string>",
- "height": 1,
- "heightId": "<string>",
- "date": "<dateitme string>",
- "type": "<string>",
- "value": 1,
- "valueString": "<string>",
- "intendendValueString": 1,
- "baseValue": 1,
- "baseValueString": "<string>",
- "feeString": "<string>",
- "payGoFee": 1,
- "payGoFeeString": "<string>",
- "usd": 1,
- "usdRate": 1,
- "state": "<string>",
- "tags": [
- "<string>"
], - "history": [
- {
- "date": "<datetime string>",
- "user": "<string>",
- "action": "<string>",
- "comment": "<string>"
}
], - "comment": "<string>",
- "vSize": 1,
- "coinSpecific": { },
- "sequenceId": "<string>",
- "entries": [
- {
- "address": "<string>",
- "wallet": "<string>",
- "value": 1,
- "valueString": "<string>",
- "isChange": true,
- "isPayGo": true,
- "token": "<string>",
- "label": "<string>",
- "failed": true
}
], - "userNotified": true,
- "label": "<string>",
- "confirmations": 0,
- "inputs": [
- {
- "id": "<string>",
- "address": "<string>",
- "value": 1,
- "valueString": 1,
- "blockHeight": 1,
- "date": "<datetime string>",
- "coinbase": true,
- "wallet": "<string>",
- "fromWallet": "<string>",
- "chain": 1,
- "index": 1,
- "redeemScript": "<string>",
- "witnessScript": "<string>",
- "isSegwit": true
}
], - "outputs": [
- {
- "id": "<string>",
- "address": "<string>",
- "value": 1,
- "valueString": "2000000",
- "blockHeight": 1,
- "date": "<datetime string>",
- "coinbase": true,
- "wallet": "<string>",
- "fromWallet": "<string>",
- "chain": 1,
- "index": 1,
- "redeemScript": "<string>",
- "witnessScript": "<string>",
- "isSegwit": true
}
]
}
], - "coin": "<string>",
- "nextBatchPrevId": "<string>"
}
}Create tranfser for specific wallet and currency
raw(json)
Success
Unauthorized
Forbidden
Unprocessable Content
Internal Server Error
{- "walletPassphrase": "One Two Three Four Five",
- "amount": "0.00005",
- "address": "2NAACTp48adM5vR4sCaXTkBdHjhErrqbfZT"
}{- "api_message": "<string>",
- "api_data": {
- "transfer": {
- "coin": "<string>",
- "id": "<string>",
- "wallet": "<string>",
- "enterprise": "<string>",
- "txid": "<string>",
- "txidType": "<string>",
- "height": 1,
- "heightId": "<string>",
- "date": "<dateitme string>",
- "type": "<string>",
- "value": 1,
- "valueString": "<string>",
- "intendendValueString": 1,
- "baseValue": 1,
- "baseValueString": "<string>",
- "feeString": "<string>",
- "payGoFee": 1,
- "payGoFeeString": "<string>",
- "usd": 1,
- "usdRate": 1,
- "state": "<string>",
- "tags": [
- "<string>"
], - "history": [
- {
- "date": "<datetime string>",
- "user": "<string>",
- "action": "<string>",
- "comment": "<string>"
}
], - "comment": "<string>",
- "vSize": 1,
- "coinSpecific": { },
- "sequenceId": "<string>",
- "entries": [
- {
- "address": "<string>",
- "wallet": "<string>",
- "value": 1,
- "valueString": "<string>",
- "isChange": true,
- "isPayGo": true,
- "token": "<string>",
- "label": "<string>",
- "failed": true
}
], - "userNotified": true
}, - "txid": "<string>",
- "tx": "<string>",
- "status": "<string>"
}
}Add new wallet to the system
raw(json)
Success
Unauthorized
Unprocessable Content
Internal Server Error
{- "walletPassphrase": "One Two Three Four Five",
- "label": "Transfer to Wallet",
- "enterprise": "63beb21b97ce44000649279dc854c2fd",
- "type": "hot"
}{- "api_message": "<string>",
- "api_data": {
- "status": "<string>",
- "data": {
- "wallet_id": "<string>",
- "receiveAddress": "<string>",
- "user_keychain_xPrv": {
- "iv": "<string>",
- "v": 1,
- "iter": 1,
- "ks": 1,
- "ts": 1,
- "mode": "<string>",
- "adata": "<string>",
- "cipher": "<string>",
- "salt": "<string>",
- "ct": "<string>"
}, - "bk_keychain_xPrv": "<string>",
- "wallet_webhooks": {
- "webhooks": [
- {
- "id": "<string>",
- "label": "<string>",
- "created": "<datetime string>",
- "walletId": "<string>",
- "coin": "<string>",
- "type": "<string>",
- "url": "<url string>",
- "version": 1,
- "state": "<datetime string>",
- "successiveFailedAttempts": 1,
- "listenToFailureStates": true,
- "allToken": true
}
]
}
}
}
}Get info about wallet from the DB by wallet_id.
Success
Unauthorized
Forbidden
Unprocessable Content
Internal Server Error
{- "api_message": "<string>",
- "api_data": {
- "wallet": {
- "id": "<string>",
- "user_id": "<string>",
- "external_wallet_id": "<string>",
- "address": "<string>",
- "name": "<string>",
- "description": "<string>",
- "protocol": "<string>",
- "currency": "<string>",
- "ip": "<string>",
- "created_by_id": "<string>",
- "created_at": "<datetime string>",
- "updated_at": "<datetime string>",
- "kyt_score": 1
}
}
}Update wallet row by wallet_id
raw(json)
Success
Unauthorized
Unprocessable Content
Internal Server Error
{- "address": "0x1bdb47ce8be9194df9ec0fe096aec74802646e70",
- "name": "MY ETH WALLET",
- "description": "my description",
- "protocol": "ERC20",
- "currency": "ETH"
}{- "api_message": "<string>",
- "api_data": {
- "wallet": {
- "id": "<string>",
- "user_id": "<string>",
- "external_wallet_id": "<string>",
- "address": "<string>",
- "name": "<string>",
- "description": "<string>",
- "protocol": "<string>",
- "currency": "<string>",
- "ip": "<string>",
- "created_by_id": "<string>",
- "created_at": "<datetime string>",
- "updated_at": "<datetime string>",
- "kyt_score": 1
}
}
}