Skip to main content
GET
Get a wallet

Authorizations

Authorization
string
header
required

Token from POST /auth/token

Path Parameters

id
string
required

Wallet ID (wlt_ prefix; a wlt_fiat_ id is also accepted).

Response

200 - application/json

The request has succeeded.

The walletCrypto variant — one crypto asset on one network, held on the customer's behalf by the custody provider, currently "Coinme Inc.". address is the on-chain deposit address and is omitted until the provider reports one.

id
string
required

Wallet ID (TypeID; wlt_ for both crypto and fiat wallets; a wlt_fiat_ id is also accepted on input).

Pattern: ^[a-z]+_([0-9a-hjkmnp-tv-z]{26}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$
customer
object
required

The customer that owns this record.

status
enum<string>
required

Current wire status.

Available options:
pending,
active,
frozen,
suspended,
closed
asset
string
required

The asset the wallet holds, lowercase: a crypto symbol (e.g. usdc) or a fiat currency (only usd today).

routing
object
required

Claim/routing state: whether a live deposit address or virtual account currently receives into this wallet, or has in the past. Always present.

provider
string
required

The legal entity holding this wallet's assets, derived from wallet type and asset: walletCrypto → "Coinme Inc."; walletFiat (usd) → "Erebor Bank, N.A.". New providers may be added, so treat the string as free-form rather than a fixed set.

createdAt
string<date-time>
required
updatedAt
string<date-time>
required
type
enum<string>
required

Type discriminator.

Available options:
walletCrypto
network
string
required

Blockchain network the wallet operates on (canonical name, e.g. "polygon").

label
string

The partner-supplied label. Absent when none is set.

balances
object[]
metadata
object
address
string

On-chain deposit address. Omitted when the provider has not reported one yet.