Get the balance of a wallet | Solvimon

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

{
  "balance": {
    "credits": {
      "quantity": "1500",
      "credit_type_id": "carbon-offset"
    },
    "amount": {
      "quantity": "7500.00",
      "currency": "AED"
    }
  },
  "reserved_balance": {
    "credits": {
      "quantity": "300",
      "credit_type_id": "carbon-offset"
    },
    "amount": {
      "quantity": "1500.00",
      "currency": "AED"
    }
  },
  "open_balance": {
    "credits": {
      "quantity": "1200",
      "credit_type_id": "carbon-offset"
    },
    "amount": {
      "quantity": "6000.00",
      "currency": "AED"
    }
  },
  "balance_at": "2024-06-01T12:00:00Z"
}

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.

Headers

x-platform-idstringOptional

Platform ID.

Request

This endpoint expects an object.

balance_atdatetimeOptional

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

Response

balanceobject or null

reserved_balanceobject or null

open_balanceobject or null

balance_atstring or nullRead-only

Errors

401

Unauthorized Error

403

Forbidden Error