Wallet models describe merchant wallets, their network endpoint details, and the assets they hold.
Wallet
| Field | Type | Description |
|---|
id | string | Wallet ID. This ID can be used as walletId when creating a withdrawal intent. |
status | string | Wallet status. Possible values are active and inactive. |
networkEndpoint | WalletNetworkEndpoint | Network endpoint associated with the wallet. |
createdAt | IsoDateTimeUtc | Time when the wallet record was created. |
updatedAt | IsoDateTimeUtc | Time when the wallet record was last updated. |
assets | WalletAsset[] | Assets held by this wallet and their balance summary. |
WalletNetworkEndpoint
The networkEndpoint object identifies the provider endpoint assigned to this wallet.
| Field | Type | Description |
|---|
type | string | Network endpoint type, such as blockchain. |
provider | string | Network provider, such as tron. |
identifier | string | Endpoint identifier on the provider. For crypto wallets, this is typically the blockchain address. |
blockchainDetail | WalletNetworkEndpointBlockchainDetail or null | Blockchain-specific endpoint details. null for non-blockchain endpoints. |
WalletNetworkEndpointBlockchainDetail
| Field | Type | Description |
|---|
chainId | string | Blockchain chain identifier, such as tron:mainnet. |
address | string | Blockchain address assigned to the wallet. |
WalletAsset
| Field | Type | Description |
|---|
currencyCode | string | Asset currency code, such as USDT, TRX, or USD. |
nickname | string | Display name or nickname for this wallet asset. |
balance | WalletAssetBalance | Operational balance summary for this asset. |
createdAt | IsoDateTimeUtc | Time when the wallet asset record was created. |
updatedAt | IsoDateTimeUtc | Time when the wallet asset record was last updated. |
WalletAssetBalance
| Field | Type | Description |
|---|
availableAmount | NumericString | Available balance. |
lockedAmount | NumericString | Locked balance, such as funds reserved by an unfinished withdrawal intent. |