Query Account Balance

Request URL

https://api.xiaomimimo.com/v1/platform/balance

Request Header

This interface supports the following two authentication methods. Please select one of them and add it to the request header (this interface requires a regular API Key sk-):

api-key: $MIMO_API_KEY

Response

objectstring
Object type.
Optional values: balance
is_availableboolean
Whether the account has an available balance: this is true when total_available - frozen_balanceis greater than 0.
balance_infosarray
Balance detail array, which currently returns a fixed single element.
Hide child attributes
balance_infos.currencystring
Currency type.
balance_infos.cash_balancestring
Cash balance, 2 decimal places.
balance_infos.gift_balancestring
Bonus balance, with 2 decimal places.
balance_infos.frozen_balancestring
Frozen amount, with 2 decimal places.
balance_infos.credit_limitstring
Credit limit, 2 decimal places.
balance_infos.credit_availablestring
Available credit limit, 2 decimal places.
balance_infos.total_availablestring
Total available balance = cash balance + bonus balance + available credit limit (added back to frozen portion), 2 decimal places.

curl --location --request GET 'https://api.xiaomimimo.com/v1/platform/balance' \
--header 'Authorization: Bearer $MIMO_API_KEY'

response

{
  "object": "balance",
  "is_available": true,
  "balance_infos": [
    {
      "currency": "CNY",
      "cash_balance": "100.50",
      "gift_balance": "20.00",
      "frozen_balance": "0.00",
      "credit_limit": "500.00",
      "credit_available": "380.00",
      "total_available": "500.50"
    }
  ]
}

Update Time November 03, 2026

curl --location --request GET 'https://api.xiaomimimo.com/v1/platform/balance' \
--header 'Authorization: Bearer $MIMO_API_KEY'

response

{
  "object": "balance",
  "is_available": true,
  "balance_infos": [
    {
      "currency": "CNY",
      "cash_balance": "100.50",
      "gift_balance": "20.00",
      "frozen_balance": "0.00",
      "credit_limit": "500.00",
      "credit_available": "380.00",
      "total_available": "500.50"
    }
  ]
}