Get Environment Balance

Returns the account credit balance for the pool matching the caller’s environment mode (sandbox or live). The pool is shared across all environments of the same mode - this endpoint exists so environment keys can read “what can I spend?” without needing an account key. For both pools at once, use GET /account/balance. Requires an environment key (mfx_test_... or mfx_live_...).

GET /environment/balance

Get Environment Balance

cURL

curl --request GET \
  --url https://api.mintfax.com/v1/environment/balance \
  --header 'Authorization: Bearer <token>'

200

Example

{
  "available": 123,
  "held": 123,
  "auto_top_up": {
    "enabled": true,
    "threshold_amount": 123,
    "package_id": 123
  }
}

Authorizations

Authorization · string · header · required

API key as Bearer token. Use an account key (mfx_acct_...) for /account/* endpoints, and an environment key (mfx_test_... for sandbox, mfx_live_... for live) for /environment/*, /faxes, /webhooks, and /events.

Response

200

application/json

BalanceResource

type · enum<string> · required

Balance type.

Available options: live, sandbox

Example:

"sandbox"

available · integer · required

Credits available for new faxes, in cents.

Example:

4550

held · integer · required

Credits held for in-flight faxes, in cents.

Example:

450

auto_top_up · object · required

Show child attributes