HEhevn-inc
accounts

Read a client's balances

Changed on

One row per account the client holds: the tokens on the smart wallet of the client selected by X-Hevn-Account, plus any custodial balance. USDC_ARB is USDC on Arbitrum at the same wallet address; it is turned on with the client's first balance read. A custodial row is read live from the provider that holds it and is left out when that provider cannot be reached.

get/client/balance

Request

Headers

X-Hevn-Accountstring required

The selected client account, as a cl_… id.

Example:cl_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41

Response

Successful Response

clientIdstring required

Account associated with this balance.

baseSmartWalletstring nullable

Base smart-wallet address controlled by the account.

totalUsdstring required

Indicative total balance converted to USD.

Example response

{
  "clientId": "cl_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41",
  "accounts": [
    {
      "balance": "500.00",
      "usdValue": "500.00"
    }
  ],
  "totalUsd": "500.00"
}

Changes

  • 299a3aa6f521Revision changes
    • warning

      added the new FDIC_EUR enum value to the // response property for the response status

    • warning

      added the new verification_not_applicable enum value to the / response property for the response status

    • info

      removed the phone_required enum value from the / response property for the response status

    • info

      removed the rail_requirements_unmet enum value from the / response property for the response status

  • a02795de2d2bRevision changes
    • warning

      deleted the header request parameter x-api-key

    • warning

      added the new KYC_CARDS enum value to the // response property for the response status

    • warning

      added the new RD enum value to the // response property for the response status

    • warning

      added the new USDC_ARB enum value to the // response property for the response status

    • warning

      added the new client_already_linked enum value to the / response property for the response status

    • warning

      added the new kyb_documents_processing enum value to the / response property for the response status

    • warning

      added the new link_code_expired enum value to the / response property for the response status

    • warning

      added the new link_code_invalid enum value to the / response property for the response status

    • warning

      added the new payout_not_awaiting_signature enum value to the / response property for the response status

    • warning

      added the new redirect_uri_not_allowed enum value to the / response property for the response status

    • warning

      added the new sandbox_amount_limit_exceeded enum value to the / response property for the response status

    • warning

      added the new sandbox_faucet_balance_too_high enum value to the / response property for the response status

    • info

      removed the client_policy_not_enabled enum value from the / response property for the response status

    • info

      removed the client_request_conflict enum value from the / response property for the response status

    • info

      removed the email_in_use enum value from the / response property for the response status

    • info

      removed the integrator_inactive enum value from the / response property for the response status

    • info

      removed the name_in_use enum value from the / response property for the response status