Wallet balance

GET /api/v1/wallet/balance wallet:read

The USDC balance backing custodial purchases for one end-user. available is what a new purchase can reserve; reserved is held by in-flight purchases and released on refund. Balances are integer micros as strings, with *_usdc decimal twins for display.

Try it GET /api/v1/wallet/balance?external_user_id=demo-explorer

These inputs are shared across all docs pages, so an id entered here carries over.

response
403 23ms preloaded server-side with the default context
object · 3 keys
{
  "success": false,
  "message": "Mystery partner API key required",
  "error": "This endpoint requires an API key linked to a mystery partner account"
}
tracks the inputs above
curl -X GET 'https://service.rip.fun/api/v1/wallet/balance?external_user_id=demo-explorer' \
  -H 'X-API-Key: rip_…'

Request fields

FieldTypeRequiredDescription
external_user_id / wallet_addressquery stringyesWhich end-user (one of the two)

Response fields (data)

FieldDescription
end_user.id / external_user_id / wallet_addressThe resolved end-user
wallet.available / reserved / balanceUSDC micros as strings
wallet.available_usdc / reserved_usdc / balance_usdcThe same three as decimal strings

Errors

StatusCodeWhen
400missing_user_identifierneither identifier given

See Errors for the response envelope and the full code list.