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; wlt_fiat_ also accepted).

Response

200 - application/json

The request has succeeded.

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

id
string
required

Wallet ID (TypeID; wlt_fiat_ for fiat wallets).

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})$
object
enum<string>
required

Resource type discriminator. Always "wallet".

Available options:
wallet
customerId
string
required

The OMS customer that owns this record (cst_ prefix).

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})$
status
enum<string>
required

Current wire status.

Available options:
preallocated,
active,
suspended
routing
object
required

Claim/routing state: whether a live deposit address or virtual account currently routes here, or has in the past. Always present.

provider
string
required

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

multiAsset
boolean
required

true when the wallet supports every network in its family and all assets on them; false when restricted to a single asset (fiat, custodial).

displayName
string
required

Server-generated wallet name. Custodial wallets use their on-chain address; fiat wallets use USD balance (<wallet id>). Distinct from the optional partner-supplied label.

type
enum<string>
required

Type discriminator.

Available options:
custodial
details
object
required

Custodial crypto wallet details — one asset on one network, held by the custody provider on the customer's behalf.

customer
object

Display-safe summary of the owning customer (customer.id equals customerId). Returned on list and detail responses.

label
string | null
balances
object[]
metadata
object
createdAt
string<date-time>
updatedAt
string<date-time>