Read API account credit

Requires BILLING_READ. Returns exact posted, reserved and available USD credit. Set include_rails=1 only when the FIAT, TNK and TAP split is needed.

get/balance

Request

  • Base URL: https://api.openmayhem.ai/v1
  • URL: https://api.openmayhem.ai/v1/balance
  • Auth: HTTP bearer

Query parameters

include_railsboolean

Response

Current account balance.

object'balance' required
postedstring required

Non-negative decimal USD string with at most 6 decimal places, parsed with exact fixed-point arithmetic.

reservedstring required

Non-negative decimal USD string with at most 6 decimal places, parsed with exact fixed-point arithmetic.

availablestring required

Non-negative decimal USD string with at most 6 decimal places, parsed with exact fixed-point arithmetic.

railsobject

Example response

{
  "posted": "0.50",
  "reserved": "0.50",
  "available": "0.50"
}

Changes

No recorded changes to this operation across all 1 revision of this API.