Wallet methods
Wallet object
- label string
The wallet name for convenient search. The string value length cannot exceed 32 characters.
- status number
Current status of the wallet:
- created_at string
Time of the wallet creation as per ISO 8601 with μs precision and timezone included:
YYYY-MM-DDThh:mm:ss[.SSSSSS]±hh:mm
.- balance_confirmed string
The available balance that can currently be used for payouts.
- balance_pending string
The locked balance, the sum of all incoming and outgoing transfers that have not yet received confirmation: positive in case of deposit and negative in case of payout. This balance cannot currently be used for transfers.
- balance_unusable string
The amount of funds that cannot be used. They are not available, although some part of them can be unblocked. The reason for temporary blocking may be a suspicious operation that does not comply with AML/KYT rules. If transfer is failed or cancelled, its amount will be added to the unusable balance.
- minimal_transfer_amount string
The minimum amount of crediting to the wallet in the wallet currency. If the amount of the incoming transfer is less than the specified minimal transfer amount, the transfer will be canceled.
- destination object
The field contains two string fields:
address_type
— refer to Deposit and invoice address types for supported values, andaddress
— public wallet address, that can be used to directly top up wallet balance.- currency object
The wallet currency. The field includes currency
id
(refer to Currency codes for supported values).- parent object
Parent wallet applicable for token wallets only; for coin wallets returns
null
. Contains parent walletid
.
{
"data": {
"type": "wallet",
"id": "20",
"attributes": {
"status": 3,
"created_at": "2020-11-06T06:03:44.301815Z",
"balance_confirmed": "0.00000000",
"balance_pending": "0.00000000",
"balance_unusable": "0.23221548",
"minimal_transfer_amount": "0.100000000000000000",
"destination": {
"address_type": "p2sh-segwit",
"address": "2N3Ac2cZzRVoqfJGu1bFaAebq3izTgr1WLv"
}
},
"relationships": {
"currency": {
"data": {
"type": "currency",
"id": "2005"
}
},
"parent": {
"data": {
"type": "wallet",
"id": "14"
}
}
}
}
}
Get wallet
Request
- id string
The wallet identifier.
Filtering by any object parameters can be applied according to the JSON API Specification.
GET[base]/wallet/{id}
$ curl --request GET \
--url https://[base]/wallet/ \
--header 'authorization: Bearer eyJ0eXAiOiJKV1QiLC...' \
--header 'content-type: application/vnd.api+json'
import requests
url = 'https://[base]/wallet/'
headers = {
'authorization': 'Bearer <Change to your access token>',
'content-type': 'application/vnd.api+json',
}
requests.get(url, headers=headers)
<?php
use GuzzleHttp\Client;
use GuzzleHttp\Exception\RequestException;
$client = new GuzzleHttp\Client();
try {
$res = $client->get('https://[base]/wallet/', [
'headers' => [
'Authorization' => 'Bearer <Change to your access token>',
'Content-Type' => 'application/vnd.api+json',
],
]);
echo $res->getBody();
} catch (RequestException $e) {}
Response
In case of a successful response, a wallet object or an array of objects (if id
was not specified) is returned.
The wallets list is paginated and default page size is 10.
HTTP status codes
200 Success.
400 Bad request. You have no permission to view the wallet with given id
.
404 The wallet with given id
was not found.