GETv2/merchant/wallets/:id

Retrieve a Wallet by ID

SDKgetMerchantWalletsByIdV2

Finds a merchant client wallet by id

AuthenticatedOAuthclientId/secret

Endpoint · Instance A

Request

path parameters

200 · 401 · 403

Represents a wallet account on the CoinPayments® platform V2.

walletIdstring

the unique id of the wallet

Example283b271a2db744c0b10c

walletTypestring

EnumsingleSigCryptoWallet

currencyIdstring

the id of the currency this wallet holds

currencySymbolstring

Currency symbol

isActiveboolean

Indicates whether this wallet is active (not deleted or deactivated)

isLockedboolean

Indicates whether this wallet is locked due to legal reasons

labelstring

the user or system defined name of the wallet

ExampleMy BitCoin Wallet 😀

depositAddressstringnullable

the current (last) deposit address for the wallet (for crypto currency wallets)

canCreateAddressesboolean

flag that determines ability to create multiple addresses for same wallet

isVaultLockedboolean

flag that determines if the wallet vault is locked or not

vaultLockoutEndDateTimestringnullable

DateTime that specifies the planned date the vault will be unlocked

Formatdate-time

hasPermanentAddressesboolean

Indicates whether generated deposit addresses for this wallet do not expire due to inactivity

hasActiveAddressboolean

Indicates whether the wallet currently has a non-empty active deposit address

clientIdstringnullable

The optional client identifier associated with this wallet (for multi-tenant/client contexts)

Formatuuid