The Wallet API manages the business HD wallet tree: deriving addresses, reading
them, signing and submitting transactions, and tracking the USD balance used to pay
gas on mainnet transfers. Wallets are scoped to the business in your token —
accessing another business’s wallet returns 403.
Each operation is gated on a capability granted by your plan; a missing one returns
403 — Missing required capability: <capability>. See the capability table on each
endpoint.
The wallet object
| Attribute | Type | Description |
|---|
id | string | Unique wallet id (UUID). |
businessName | string | Business the wallet belongs to. |
address | string | On-chain address (0x… for EVM, base58 for Solana). |
chainType | string | EVM or SOLANA. |
purpose | string | Logical tag (e.g. general, deposit). |
derivationPath | string | HD derivation path (e.g. m/44'/60'/0'/0/0). |
addressIndex | integer | HD index of the address. |
isActive | boolean | Whether the wallet is active. |
createdAt | string | ISO 8601 UTC timestamp. |
deactivatedAt | string | null | When the wallet was deactivated, or null. |
metadata | object | null | Arbitrary metadata. |
The transaction object
| Attribute | Type | Description |
|---|
id | string | Unique transaction id. |
type | string | e.g. TRANSFER. |
chainType | string | EVM or SOLANA. |
network | string | MAINNET or TESTNET. |
chainId | integer | Target chain id (e.g. 8453). |
signerType | string | e.g. BUSINESS_HD. |
fromAddress | string | Sending address. |
addressIndex | integer | HD index of the sender. |
toAddress | string | Recipient address. |
amount | string | Amount in the token’s smallest unit. |
tokenAddress | string | null | ERC-20 contract, or null for a native transfer. |
data | string | null | Calldata (hex), if any. |
value | string | null | Native value, if any. |
txHash | string | On-chain transaction hash. |
status | string | e.g. COMPLETED. |
gasUsed | string | Gas units consumed. |
feeWei | string | Fee paid, in wei. |
createdAt | string | ISO 8601 UTC timestamp. |
updatedAt | string | ISO 8601 UTC timestamp. |
The balance object
| Attribute | Type | Description |
|---|
balance | string | Spendable USD balance as a decimal string. |
currency | string | Always USD. |
updatedAt | string | ISO 8601 UTC timestamp. |
