Get Wallets by Client

HTTP Method: GET Endpoint URL: /wallets-by-client Description: Returns a list of all deposit wallets that have a clientId assigned and belong to the authenticated merchant. Security: Requires the API-KEY header.

Use this endpoint to discover which wallets are linked to your clients. For per-client balance aggregation and transaction history, see Client Wallet Balances & Transactions.

Query Parameters

page (integer, optional, default: 1) — Page number
pageSize (integer, optional, default: 20) — Number of results per page

Request Headers

API-KEY: your_account_api_key

Example cURL

curl "https://api.alppay.io/v2/wallets-by-client?page=1&pageSize=20" \
  -H "API-KEY: ak_live_1234567890abcdef"

Successful Response (200 OK)

Returns an array of wallet objects. Only wallets with a non-empty clientId are returned.

[
  {
    "id": 1042,
    "address": "TQn9Y2khEsLJW1ChVWFMSMeRDow5KcbLSE",
    "assetShort": "USDT",
    "assetNetwork": "tron",
    "statusValue": "UNLOCKED",
    "statusDate": "2025-11-01T10:00:00Z",
    "merchantName": "my-merchant",
    "destinationTag": "",
    "merchantId": 7,
    "comment": "",
    "blockedAt": "0001-01-01T00:00:00Z",
    "createdAt": "2025-10-15T08:30:00Z",
    "updatedAt": "2025-11-01T10:05:00Z",
    "lastActionUser": "00000000-0000-0000-0000-000000000000",
    "riskScore": 12,
    "riskCheckedAt": "2025-11-01T10:05:00Z",
    "isDanger": false,
    "clientId": "client_abc123"
  }
]

Response Field Descriptions

id — Internal wallet ID (integer)
address — Cryptocurrency deposit address
assetShort — Asset symbol (e.g. USDT)
assetNetwork — Blockchain network (e.g. tron). See Available Assets for API values.
statusValue — Wallet status: UNLOCKED, LOCKED, BLOCKED
statusDate — ISO 8601 timestamp of last status change
merchantName — Merchant name
destinationTag — Optional destination tag (XRP, XLM, etc.)
merchantId — Merchant ID
comment — Optional merchant comment
blockedAt — ISO 8601 timestamp when wallet was blocked (zero value if not blocked)
createdAt — ISO 8601 wallet creation timestamp
updatedAt — ISO 8601 timestamp of last update
lastActionUser — UUID of the user who performed the last action on this wallet
riskScore — AML risk score (0–100)
riskCheckedAt — ISO 8601 timestamp of last AML check
isDanger — Whether the wallet is flagged as dangerous
clientId — Client identifier assigned to this wallet

Error Responses

401 Unauthorized — Invalid or missing API key
429 Too Many Requests — Rate limit exceeded