Skip to main content
GET
Get the user's wallet

Notes

  • The wallet is provisioned automatically on first read — there is no separate provision call.
  • balance_usdc is the current balance as a decimal string (e.g. "25.00").
  • If balance_unavailable is present and true, the balance could not be read right now — treat it as “unknown”, not “$0”.

Authorizations

Authorization
string
header
required

A platform access token. Get one on the Create an access token endpoint by exchanging your client_id + client_secret, then send it as Authorization: Bearer <token>. Tokens live one hour.

Query Parameters

user_id
string
required

The connected user's id.

Response

The wallet.

object
string
Allowed value: "wallet"
user_id
string
address
string

The wallet's on-chain address.

balance_usdc
string

Current balance in USD, as a decimal string.

balance_unavailable
boolean

Present and true when the balance could not be read right now — distinguish "no funds" from "couldn't read".

status
string