Get the balance of a wallet | Solvimon

curl -X POST https://test.api.solvimon.com/v1/wallets/wall_TwDeeN0tYSY3F7BkeN1v/balance \
     -H "X-API-KEY: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "include_customer_details": true
}'

{
  "balance": {
    "credits": {
      "quantity": "6000",
      "credit_type_id": "crty_hwDeeN0vcYJaBLAc0C1W"
    }
  },
  "reserved_balance": {
    "credits": {
      "quantity": "1750",
      "credit_type_id": "crty_hwDeeN0vcYJaBLAc0C1W"
    }
  },
  "open_balance": {
    "credits": {
      "quantity": "4250",
      "credit_type_id": "crty_hwDeeN0vcYJaBLAc0C1W"
    }
  },
  "balance_at": "2026-09-07T10:00:00Z",
  "customer_details": [
    {
      "customer_id": "cust_MwDR9l0vsgwcV6CRqw14",
      "reserved_balance": {
        "credits": {
          "quantity": "1200",
          "credit_type_id": "crty_hwDeeN0vcYJaBLAc0C1W"
        }
      }
    },
    {
      "customer_id": "cust_qwDRHT0vsJoJuFCkPm1A",
      "reserved_balance": {
        "credits": {
          "quantity": "550",
          "credit_type_id": "crty_hwDeeN0vcYJaBLAc0C1W"
        }
      }
    }
  ]
}

Requires the WALLET.VIEW permission.

Authentication

X-API-KEYstring

API Key authentication via header

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

versionstringRequiredDefaults to 1

version

resourceIdOrReferencestringRequiredDefaults to

The ID or reference of the resource.

Request

This endpoint expects an object.

balance_atdatetimeOptional

The date of the balance determination. Default is now().

include_customer_detailsbooleanOptional

Include the per-customer breakdown of the reserved balance. Default is false.

Response

balanceobject or nullOptional

reserved_balanceobject or nullOptional

open_balanceobject or nullOptional

balance_atstring or nullOptionalRead-only

over_grantedobject or nullOptional

The part of this balance the periods behind it were not entitled to.

customer_detailslist of objects or nullOptionalRead-only

The reserved balance split over the customers whose usage produced it, requested with include_customer_details. Stored when an invoice is built/ refreshed.

Errors

401

Unauthorized Error

403

Forbidden Error

Authentication

Path parameters

Headers

Request

Response

Errors