Docs

API reference / Wallets

List the wallets of a user

GET/v1/users/{id}/wallets

API key required

In sandbox, simulated wallets (balance computed from simulated transactions). In live, real wallets; balance_usdc is the real balance when live balance reading is enabled for the platform, read with a short timeout and a short cache. It is null when reading is not enabled or temporarily unavailable (the call never fails because of it). balance_as_of tells when the balance was read.

Authentication#

Send a secret API key as Authorization: Bearer <key>. Both tp_test_… and tp_live_… keys work; the key decides which environment you read and write. See Authentication.

Parameters#

Path

Path parameters
NameTypeDescription
idrequiredstringIdentifier of the user.Pattern ^\d{1,9}$

Responses#

200Wallets of the user.

Headers

  • X-Request-Id Request identifier.
  • X-RateLimit-Limit Quota of the current window.
  • X-RateLimit-Remaining Requests remaining in the window.
  • X-RateLimit-Reset Seconds before the quota renews.

Body

  • objectstringrequired

    always "list"

    Example "list"

  • dataarray of Walletrequired
    • idstringrequired

      Opaque identifier.

      Example "3310"

    • objectstringrequired

      always "wallet"

      Example "wallet"

    • addressstringrequired

      Public address of the wallet.

      Example "7gH3pQeVx2mT9bKfLr4WnYcZs8dAuJ1oEiXvBq5RtCkM"

    • networkstringrequired

      Network.

      One ofsolana

      Example "solana"

    • balance_usdcnumber | nullrequired

      USDC balance. Computed from simulated transactions in sandbox. In live, the real balance when balance reading is enabled; null when it is not enabled or temporarily unavailable (never an error).

      Example 75

    • balance_as_ofstring | nullrequired

      Moment the balance was read (freshness of balance_usdc).

      format: date-time

      Example "2026-10-08T09:31:00.000Z"

    • livemodebooleanrequired

      true for a live key, false for a sandbox key.

      Example false

    • created_atstringrequired

      Creation date.

      format: date-time

      Example "2026-10-08T09:30:00.000Z"

  • has_morebooleanrequired

    More items remain: call again with starting_after set to the id of the last item.

    Example false

Example 200 response
{
  "object": "list",
  "data": [
    {
      "id": "3310",
      "object": "wallet",
      "address": "7gH3pQeVx2mT9bKfLr4WnYcZs8dAuJ1oEiXvBq5RtCkM",
      "network": "solana",
      "balance_usdc": 75,
      "balance_as_of": "2026-10-08T09:31:00.000Z",
      "livemode": false,
      "created_at": "2026-10-08T09:30:00.000Z"
    }
  ],
  "has_more": false
}
401Missing, invalid or revoked API key.

Example: missing_api_key

Example 401 response
{
  "error": {
    "type": "authentication_error",
    "code": "missing_api_key",
    "message": "Provide your API key as \"Authorization: Bearer <key>\"",
    "request_id": "0b2c8f6e-41f9-4c0a-8d55-6f6a3c1d9e21"
  }
}

Example: invalid_api_key

Example 401 response
{
  "error": {
    "type": "authentication_error",
    "code": "invalid_api_key",
    "message": "The API key is invalid",
    "request_id": "0b2c8f6e-41f9-4c0a-8d55-6f6a3c1d9e21"
  }
}

Example: api_key_revoked

Example 401 response
{
  "error": {
    "type": "authentication_error",
    "code": "api_key_revoked",
    "message": "This API key has been revoked",
    "request_id": "0b2c8f6e-41f9-4c0a-8d55-6f6a3c1d9e21"
  }
}
403Organization suspended, live access not enabled, or sandbox-only route.

Example: organization_suspended

Example 403 response
{
  "error": {
    "type": "permission_error",
    "code": "organization_suspended",
    "message": "Your organization is suspended. Contact Tilt Pay support.",
    "request_id": "0b2c8f6e-41f9-4c0a-8d55-6f6a3c1d9e21"
  }
}

Example: live_not_enabled

Example 403 response
{
  "error": {
    "type": "permission_error",
    "code": "live_not_enabled",
    "message": "Live access has not been enabled for your organization yet",
    "request_id": "0b2c8f6e-41f9-4c0a-8d55-6f6a3c1d9e21"
  }
}

Example: sandbox_only

Example 403 response
{
  "error": {
    "type": "permission_error",
    "code": "sandbox_only",
    "message": "This route is only available with a sandbox API key",
    "request_id": "0b2c8f6e-41f9-4c0a-8d55-6f6a3c1d9e21"
  }
}
404Resource not found (or belonging to another project or environment).

Example: user_not_found

Example 404 response
{
  "error": {
    "type": "invalid_request_error",
    "code": "user_not_found",
    "message": "User not found",
    "request_id": "0b2c8f6e-41f9-4c0a-8d55-6f6a3c1d9e21"
  }
}
429Rate limit exceeded. Retry after the Retry-After delay (seconds).

Example: rate_limit_exceeded

Example 429 response
{
  "error": {
    "type": "rate_limit_error",
    "code": "rate_limit_exceeded",
    "message": "Too many requests. Slow down and retry after the delay in Retry-After.",
    "request_id": "0b2c8f6e-41f9-4c0a-8d55-6f6a3c1d9e21"
  }
}
500Internal error. Retry; give request_id to support if it persists.

Example: internal_error

Example 500 response
{
  "error": {
    "type": "api_error",
    "code": "internal_error",
    "message": "Internal server error",
    "request_id": "0b2c8f6e-41f9-4c0a-8d55-6f6a3c1d9e21"
  }
}

Headers on every response

  • X-Request-Id Identifier of the request, also present in error bodies. Give it to support.
  • X-API-Version Version of the API that answered.
  • X-RateLimit-Limit / -Remaining / -Reset Quota of your key for the current window. See Rate limits.

Errors#

Errors share one format, described in Errors. Branch your code on error.code.

Errors this route can return
StatusCodeMeaning
401missing_api_keyMissing, invalid or revoked API key.
401invalid_api_keyMissing, invalid or revoked API key.
401api_key_revokedMissing, invalid or revoked API key.
403organization_suspendedOrganization suspended, live access not enabled, or sandbox-only route.
403live_not_enabledOrganization suspended, live access not enabled, or sandbox-only route.
403sandbox_onlyOrganization suspended, live access not enabled, or sandbox-only route.
404user_not_foundUnknown user (or belonging to another project or environment).
429rate_limit_exceededRate limit exceeded. Retry after the Retry-After delay (seconds).
500internal_errorInternal error. Retry; give request_id to support if it persists.