Download OpenAPI specification:Download
[- {
- "id": "USDC",
- "name": "USD Сoin",
- "precision": 4
}, - {
- "id": "DAI",
- "name": "Dai",
- "precision": 4
}, - {
- "id": "BTC",
- "name": "Bitcoin",
- "precision": 8
}, - {
- "id": "ETH",
- "name": "Ethereum",
- "precision": 8
}, - {
- "id": "USDT",
- "name": "Tether",
- "precision": 4
}
]
[- {
- "asset_id": "USDC",
- "available_for_withdrawal": "string",
- "earn_total": "string",
- "earn_90d": "string",
- "earn_30d": "string",
- "earn_7d": "string",
- "earn_1d": "string",
- "total": "string",
- "last_payout_date": "2022-12-10T09:30Z",
- "last_payout_amount": "string"
}
]
apikey required | any |
amount required | string |
destination_address required | string |
external_tx_id | string |
asset_id required | string Id of the asset, refer to response from /asset endpoint |
{- "amount": "string",
- "destination_address": "string",
- "external_tx_id": "string",
- "asset_id": "USDT"
}
{- "id": "string",
- "status": "TRANSFERRED_OUT",
- "client_id": "string",
- "destination_address": "string",
- "note": "string",
- "external_tx_id": "string",
- "asset_id": "USDC",
- "gross_amount": "string",
- "net_amount": "string",
- "fee_amount": "string",
- "created_at": "2022-06-12T19:27:12.895815Z",
- "modified_at": "2022-06-16T09:45:43.896465Z",
- "txhash": "string",
- "txhash_url": "string",
- "transaction_type": "WITHDRAW"
}
Transaction list on ogranization level does not include transactions for individual sub-clients. Use this operation to check status of in-progress withdrawal requests.
transaction_id | string |
apikey required | string |
{- "next": "string (N/A)",
- "previous": "string (N/A)",
- "count": 21,
- "results": [
- {
- "id": "string",
- "status": "REQUESTED",
- "destination_address": "string",
- "note": "string",
- "external_tx_id": "string",
- "asset_id": "string",
- "created_at": "2022-12-10T09:30Z",
- "modified_at": "2022-12-10T09:30Z",
- "txhash": "string",
- "txhash_url": "string",
- "transaction_type": "WITHDRAW",
- "fee_amount": "string",
- "gross_amount": "string",
- "net_amount": "string"
}, - {
- "id": "string",
- "status": "REQUESTED",
- "destination_address": "string",
- "note": "string",
- "external_tx_id": "string",
- "asset_id": "string",
- "created_at": "2022-12-10T09:30Z",
- "modified_at": "2022-12-10T09:30Z",
- "txhash": "string",
- "txhash_url": "string",
- "transaction_type": "EARN",
- "fee_amount": "string",
- "gross_amount": "string",
- "net_amount": "string"
}
]
}
txhash_url required | string |
amount required | string |
asset_id required | string Id of the asset, refer to response from /asset endpoint |
product required | string Value: "highyield" |
tx_timestamp required | string <date-time> |
{- "txhash": "string",
- "amount": 1.2,
- "asset_id": "USDC",
- "product": "highyield",
- "tx_timestamp": "2018-02-10T09:30Z"
}
amount required | string |
destination_address required | string |
external_tx_id | string |
asset_id required | string Id of the asset, refer to response from /asset endpoint |
{- "amount": "string",
- "destination_address": "string",
- "external_tx_id": "string",
- "asset_id": "USDT"
}
{- "gross_amount": "string",
- "net_amount": "string",
- "fee_amount": "string",
- "withdrawal_status": "Success",
- "message": "string"
}
required | Array of objects (Root Type for Allocation) [ items ] |
{- "allocations": [
- {
- "client_id": "1",
- "allocation_type": "EARN_ACCOUNT",
- "asset_id": "USDT",
- "amount": "100"
}, - {
- "client_id": "2",
- "allocation_type": "EARN_ACCOUNT",
- "asset_id": "USDC",
- "amount": "100"
}
]
}
{- "error": { },
- "status": "success",
- "remaining_reserve_balances": [
- {
- "asset_id": "USDT",
- "balance": "1450.92"
}, - {
- "asset_id": "BTC",
- "balance": "2.02"
}
]
}
apikey required | any |
client_id required | string Unique client ID from the system requesting to create the earn client |
required | Array of objects (Root Type for WithdrawalWallet) [ items ] |
first_name | string First name of the client. Used in client searches. |
last_name | string Last name of the client. Used in client searches. |
{- "client_id": "string",
- "first_name": "string",
- "last_name": "string",
- "withdrawal_wallets": [
- {
- "address": "string",
- "asset_id": "USDT",
- "nickname": "string"
}, - {
- "address": "string",
- "asset_id": "USDC"
}
]
}
[- {
- "field_name": "string",
- "error_details": [
- {
- "message": "string",
- "code": "string"
}, - {
- "message": "string",
- "code": "string"
}
]
}
]
Use this operation to check on the status of the in-progress withdrawal requests.
client_id required | string |
apikey required | string |
{- "next": "string (N/A)",
- "previous": "string (N/A)",
- "count": 21,
- "results": [
- {
- "id": "string",
- "status": "REQUESTED",
- "client_id": "string",
- "destination_address": "string",
- "note": "string",
- "external_tx_id": "string",
- "asset_id": "string",
- "created_at": "2012-12-10T09:30Z",
- "modified_at": "2012-12-10T09:30Z",
- "txhash": "string",
- "txhash_url": "string",
- "transaction_type": "WITHDRAW",
- "fee_amount": "string",
- "gross_amount": "string",
- "net_amount": "string"
}, - {
- "id": "string",
- "status": "REQUESTED",
- "client_id": "string",
- "destination_address": "string",
- "note": "string",
- "external_tx_id": "string",
- "asset_id": "string",
- "created_at": "2022-12-10T09:30Z",
- "modified_at": "2022-12-10T09:30Z",
- "txhash": "string",
- "txhash_url": "string",
- "transaction_type": "EARN",
- "fee_amount": "string",
- "gross_amount": "string",
- "net_amount": "string"
}
]
}