Miracle Docs
Balance

Get current balance

Returns the calling account’s current balance grouped by scope and currency. Each balance has 6 buckets (available, pending, reserved, payable, collateral, operational) representing the lifecycle of funds. Use the optional scopeLevel / scopeEntityId query params to narrow to a specific entity (e.g. one merchant when called from a tenant-level key).

GET
/v1/balance

Authorization

bearer
AuthorizationBearer <token>

In: header

Response Body

application/json

curl -X GET "https://api.miracle.com/v1/balance"
{
  "data": [
    {
      "currency": "string",
      "buckets": [
        {
          "type": "available",
          "amount": {
            "currency": "string",
            "valueMinor": 0
          }
        }
      ],
      "updatedAt": "string",
      "scope": {
        "level": "terminal",
        "terminalId": "57e69e1b-2c00-4a26-b5e3-44617c6cc659"
      }
    }
  ]
}
Empty
Empty

List balance entries

Cursor-paginated list of balance entries (the immutable ledger of every credit and debit that affects the caller’s balance). Ordered by `occurredAt` descending (newest first). Filter by scope, currency, bucket, entry type, status, or a time range.

On this page

AuthorizationResponse Body