Wallet

Every booking is charged against your office wallet. Read its balance to check you can cover an issuance before you make one.

Get the balance

GET/v3/HAPI/wallet

Requires the wallet:read scope. A test token reports the sandbox wallet; a live token reports the real office.

curl https://api.hermeseus.com/v3/HAPI/wallet \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Response

{
  "object": "wallet",
  "environment": "live",
  "balance":   { "amount": "1240.00", "currency": "USD" },
  "held":      { "amount": "150.00",  "currency": "USD" },
  "available": { "amount": "1090.00", "currency": "USD" }
}

Field	Description
`balance`	The total funds on the wallet.
`held`	Funds reserved by orders that are held but not yet issued.
`available`	What you can still spend: balance minus held.

Holds and issuance. Creating an order moves money from available into held. Issuing draws it down from balance; cancelling releases the hold back to available. A create that would exceed available returns 402 insufficient_balance.

Was this page helpful?

Rate limits

Versioning