List your wallets and balances

Lists the signed-in customer's prepaid credit wallets with this brand, one per currency, newest first: the balance, what is available, promotional and held for usage in progress, the next credits to expire, and the auto-reload settings. Amounts are integer micros. Customer portal only (portal:read).

At a glance

REST: GET /api/v1/portal/me/wallets
MCP tool: portal_wallets_list
Operation ID: portal.wallets.list
Scope: Brand
Permission: portal:read
Risk tier: read
Dry run: Not supported
Idempotency: Not needed (read only)
Modes: Test and live
Pagination: limit (at most 100) and starting_after
Authentication: A customer signed in to the customer portal (API keys can't call it)
Since: M9

Request

Query parameters

Field	Type	Required	Description
`limit`	integer (1 to 100)	No	Page size, 1 to 100 (default 20).
`starting_after`	string	No	The `next_cursor` of the previous page.

Response

200 OK with a JSON object, a page of the list (newest first):

Field	Type	Description
`object`	`"list"`
`data`	array of object
`data[].id`	`wal_…` ID
`data[].object`	`"portal_wallet"`
`data[].currency`	string
`data[].status`	one of `active`, `frozen`, `closed`
`data[].balance`	money	All your credits: available, promotional and held.
`data[].available`	money	Purchased and included credits you can use.
`data[].promo`	money	Promotional credits (used first).
`data[].reserved`	money	Credits held for usage in progress.
`data[].upcomingExpiries`	array of object
`data[].upcomingExpiries[].amount`	money
`data[].upcomingExpiries[].expiresAt`	date-time
`data[].autoReload`	object or null
`data[].createdAt`	date-time
`has_more`	boolean
`next_cursor`	string or null

Examples

A euro wallet with promotional credits

HTTP

GET /api/v1/portal/me/wallets
Authorization: Bearer or_test_…

Response (200):

JSON

{
  "object": "list",
  "data": [
    {
      "id": "wal_01m4tx5nj8emwbyf7y9vcf48c7",
      "object": "portal_wallet",
      "currency": "EUR",
      "status": "active",
      "balance": {
        "amount": "32500000",
        "currency": "EUR"
      },
      "available": {
        "amount": "25000000",
        "currency": "EUR"
      },
      "promo": {
        "amount": "5000000",
        "currency": "EUR"
      },
      "reserved": {
        "amount": "2500000",
        "currency": "EUR"
      },
      "upcomingExpiries": [
        {
          "amount": {
            "amount": "5000000",
            "currency": "EUR"
          },
          "expiresAt": "2026-12-31T23:00:00.000Z"
        }
      ],
      "autoReload": null,
      "createdAt": "2026-09-20T09:00:00.000Z"
    }
  ],
  "has_more": false,
  "next_cursor": null
}

Errors

Code	HTTP status	When	What to do
`livemode_not_allowed`	403	The portal session is in the other mode than the request.	Use test mode, or credentials for the target's mode. Developers need live access granted by an organization owner or admin.
`permission_denied`	403	The caller isn't a customer signed in to this brand's portal (operators and API keys use the subscription and wallet operations).	Ask an organization owner or admin for a role or scope that allows this action.

It can also return these common errors: validation_failed, api_version_unsupported, authentication_required, api_key_invalid, scope_required, resource_not_found, dry_run_not_supported, rate_limited, internal_error.

At a glance#

Request#

Query parameters#

Response#

Examples#

A euro wallet with promotional credits#

Errors#