> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stablemint.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Accounts and balances

> Where your money sits, and what the balance figures actually mean.

An **account** is a currency-denominated place your money sits with StableMint. You hold one per
currency — today EUR and USD. Each account carries an IBAN, the bank behind it, its balance, and a
summary of your customers' activity on it.

```bash theme={null}
curl "https://api.stablemint.net/v1/accounts?startDate=2026-08-01T00:00:00Z&endDate=2026-09-01T00:00:00Z" \
  -H "ApiKey: $STABLEMINT_API_KEY" \
  -H "Timestamp: $TIMESTAMP" \
  -H "Nonce: $NONCE" \
  -H "Signature: $SIGNATURE"
```

<ParamField query="startDate" type="string">
  Optional ISO 8601 timestamp. Bounds the activity window. Omit both to get the default window.
</ParamField>

<ParamField query="endDate" type="string">
  Optional ISO 8601 timestamp.
</ParamField>

The response is an array — one entry per currency account you hold.

```json theme={null}
[
  {
    "currency": "EUR",
    "accountHolder": "Acme Payments Ltd",
    "bankName": "Example Bank",
    "iban": "MT00XXXX00000000000000000000",
    "totalBalance": 184320.55,
    "balance": {
      "businessBalance": 42180.55,
      "customerBalance": 142140.00,
      "totalDeposits": 903412.00,
      "totalWithdrawals": 761272.00,
      "netDeposit": 142140.00
    },
    "customerActivity": {
      "customerBalance": 142140.00,
      "depositTotal": 903412.00,
      "depositAverage": 214.60,
      "depositTrend": 4.2,
      "withdrawalTotal": 761272.00,
      "withdrawalAverage": 188.30,
      "withdrawalTrend": -1.8,
      "netDepositTrend": 6.0,
      "depositWithdrawalRatio": 1.19
    }
  }
]
```

<Note>
  **One call gives you the account, its balance and the activity summary.** There is no separate
  balance endpoint — `balance` and `customerActivity` are nested on each account, so you never have
  to make a second call to find out what the account is worth.
</Note>

## The account itself

| Field           | Meaning                                                                                |
| --------------- | -------------------------------------------------------------------------------------- |
| `currency`      | The currency this account is denominated in.                                           |
| `accountHolder` | The registered name on the account.                                                    |
| `bankName`      | The bank holding it.                                                                   |
| `iban`          | The account's own IBAN. See [virtual IBANs](#virtual-ibans-do-not-hold-balance) below. |
| `totalBalance`  | Everything on the account: `businessBalance` + `customerBalance`.                      |

## Reading `balance`

You hold **one balance per currency**. `businessBalance` and `customerBalance` split that single
pool by who the money is attributable to — they are an accounting view over one balance, not two
separate pots.

<CardGroup cols={2}>
  <Card title="businessBalance" icon="building">
    Money attributable to you. Fees you have earned, float you have funded, working capital.
  </Card>

  <Card title="customerBalance" icon="users">
    The sum of what your customers hold with you, in aggregate.
  </Card>
</CardGroup>

<Warning>
  **Payouts and conversions draw on `totalBalance`, not on `businessBalance`.** There is no
  technical control stopping you from spending past your own funds: a payout is admitted whenever
  `totalBalance` covers it, and `businessBalance` will go **negative** when it does not. A negative
  `businessBalance` is a real signal — it means your own outflows are being funded by money
  attributable to your customers. Track it yourself if that matters to you; the API will not stop
  you.
</Warning>

| Field              | Meaning                                                                                                                                                                  |
| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `businessBalance`  | Money attributable to you. Can go negative — see above.                                                                                                                  |
| `customerBalance`  | Money attributable to your customers, in aggregate.                                                                                                                      |
| `totalDeposits`    | Completed deposits **into your own funds** — your fundings and conversions in. Deposits made by your customers are **not** counted here; they land in `customerBalance`. |
| `totalWithdrawals` | **Completed** withdrawals and conversions out of your own funds, on the same basis. Pending ones are already deducted from `businessBalance` but are not counted here.   |
| `netDeposit`       | `totalDeposits` − `totalWithdrawals`, so also business-scoped.                                                                                                           |

<Warning>
  **Reconcile against `totalBalance`, never against `netDeposit`.** `netDeposit` is a business-scoped
  lifetime flow figure, so it will not agree with a balance that also holds customer money — and it
  goes negative as soon as you pay out more than you funded. It is a reporting number, not an
  accounting one.
</Warning>

## Reading `customerActivity`

`customerActivity` is a **reporting summary**, not a ledger. It describes how your customers have
behaved on this account over the requested window.

| Field                    | Meaning                                                                                                                                             |
| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------- |
| `customerBalance`        | Aggregate customer holdings. Same figure as `balance.customerBalance`.                                                                              |
| `depositTotal`           | Value deposited by customers in the window.                                                                                                         |
| `depositAverage`         | `depositTotal` divided by the **number of days in the window** — a daily rate, not the size of a typical deposit.                                   |
| `depositTrend`           | `depositTotal` as a **percentage of** the preceding window, not the change between them. `100` means flat, `0` when the preceding window was empty. |
| `withdrawalTotal`        | Value withdrawn by customers in the window.                                                                                                         |
| `withdrawalAverage`      | `withdrawalTotal` divided by the number of days in the window, as `depositAverage`.                                                                 |
| `withdrawalTrend`        | `withdrawalTotal` as a percentage of the preceding window, as `depositTrend`.                                                                       |
| `netDepositTrend`        | Net flow as a percentage of the preceding window's net flow. `0` when that nets to zero.                                                            |
| `depositWithdrawalRatio` | Deposits divided by withdrawals, **as a percentage**. `100` when there were no withdrawals — not infinity, and not an error.                        |

<Warning>
  **Do not reconcile against these figures.** They are shaped for dashboards — trends, averages and
  ratios over a window you chose. Use [Transactions](/guides/transactions) when you need the
  individual movements that make up a number.
</Warning>

## Virtual IBANs do not hold balance

You may have several IBANs pointing at one account — a partner IBAN, and a virtual IBAN for each
customer you provision one for. These are **entry points, not accounts**. Money arriving at any of
them lands on the same underlying currency account.

This matters when you reconcile: a virtual IBAN tells you *who sent it*, not *where it is held*.
There is one balance per currency, regardless of how many IBANs feed it.

See [Customers](/guides/customers) for how virtual IBANs attribute an incoming payment to a
specific customer.

## What is not here yet

<Note>
  There is no per-customer spendable balance. You can see deposit, withdrawal and net figures in
  aggregate, but StableMint does not compute an authoritative balance for an individual customer.
  If you credit or debit your customers for anything that is not a deposit or a withdrawal —
  yield, winnings, losses, fees — that movement is invisible to us and you must hold the balance
  yourself. [Customers](/guides/customers) covers this in full.
</Note>
