Home API guide Merchant API [DEPRECATED] Wallet methods

Wallet methods

Wallet object

id string

The identifier of a wallet.

label string

The tag or name assigned to a wallet for easier locating it in the system.

The value length can’t exceed 32 characters.

status number

The current status of a wallet:

  • 1 — Not active. The wallet hasn’t been activated due to some technical or blockchain issues.

  • 2 — In progress. The wallet is now being registered in the system or requires the activation and currently unavailable.

  • 3 — Active. The wallet has been activated (if required) and can be used.

type number

The wallet type. Possible values:

  • 1 — Merchant

  • 2 — Enterprise

created_at string

The date and time of wallet creation, with milliseconds precision and timezone included: YYYY-MM-DDThh:mm:ss[.SSSSSS]±hh:mm.

balance_confirmed string

The balance available for financial operations.

balance_pending string

The sum of all deposit- and payout-related transactions that haven’t yet received the required number of confirmation blocks. This value is positive for incoming and negative for outgoing transactions. This balance can’t currently be used for financial operations.

balance_unusable string

The amount of incoming transfers blocked by AML. This balance can’t currently be used for financial operations.

minimal_transfer_amount string

For Enterprise wallets only.

The minimum amount of the incoming transfer, in the wallet currency.

Payments below the specified amount are automatically rejected. This can be useful if the transaction blockchain fee exceeds the transaction amount.

currency object

The wallet currency.

The object contains the id field corresponding to the currency ISO code. Refer to Currency codes for possible values.

parent object

For wallets denominated in tokens.

The Parent wallet of a wallet denominated in tokens. For other wallets, returns null.

The object contains the parent wallet id.

WALLET OBJECT 
{
  "type": "wallet",
  "id": "449",
  "attributes": {
    "label": "My Wallet",
    "status": 3,
    "type": 1,
    "created_at": "2020-11-06T06:03:44.301815Z",
    "balance_confirmed": "150.27",
    "balance_pending": "0.00",
    "balance_unusable": "0.00",
    "minimal_transfer_amount": "0.00"
  },
  "relationships": {
    "currency": {
      "data": {
        "type": "currency",
        "id": "840"
      }
    },
    "parent": {
      "data": null
    }
  }
}

Get wallet

Request

id string

The wallet identifier.

Filtering by any object parameters can be applied according to the JSON API Specification.

To query wallets of multiple types, follow this example:

GET [base]/wallet/?filter[type.in]=1,2

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.

Response 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.