A wallet (wal_*) holds a party’s funds. Every party gets one wallet when onboarding completes, and you can open more, for example to keep payroll apart from operating cash or to give an agent its own. To learn more, see Wallets and Wallet access.
The object is everything inside data. The field names below are relative to it: attributes.status is data.attributes.status in the response.
Fields
string
required
Resource type. Always wallet.
string
required
Wallet ID (wal_*).
object
required
The wallet’s details.
Hide attributes
string
required
Wallet status. One of: active, frozen, closed. See Statuses.
string
required
Wallet type: a spendable standard wallet or the vault. One of: standard, vault.
boolean
required
Whether this wallet is the owning party’s default. Agent calls resolve their default from wallet grants.
boolean
Present for agent wallet list and detail reads. Whether this wallet is the agent’s default in the current context. For a connected customer, this is the default for that customer connection, independently of the party’s isDefault.
string | null
required
RFC 3339 timestamp when the wallet was created, or null when unknown.
string | null
required
Wallet name, when set.
string | null
required
User-facing wallet description, when set.
object
required
Metadata visible to anyone who can read the resource.
object | null
required
Wallet ledger balance, when available.
Hide balance
integer
required
Amount available to spend or withdraw, in cents.
integer
required
Total wallet ledger balance in cents.
string
required
Currency code. Always USD.
object
required
Party-level claimable payment totals, surfaced on the default wallet (or the first wallet when none is default).
Hide claims
integer
required
Total amount of payments awaiting claim, in cents.
integer
required
Number of unclaimed product payments.
object | null
required
Receiving bank for ACH deposits to this wallet, when available.
Hide depositInstructions
string
required
Name of the receiving bank.
string | null
required
Account number for ACH deposits. Returned when fetching a single wallet, null in list responses.
string | null
required
Bank routing number for ACH deposits. Returned when fetching a single wallet, null in list responses.
object
required
Related resources, each by type and ID.
Hide relationships
object
required
Party that owns the wallet.
Hide party
object
required
Related resource identifier.
Hide data
string
required
Resource type. Always party.
string
required
Party ID (pty_*).
Statuses
Status
Meaning
Can become
active
The wallet can send and receive money.
frozen, closed
frozen
The wallet can’t send or receive money. You can unfreeze a wallet you froze; a wallet Natural froze stays frozen until Natural unfreezes it.