---
title: "Balance:Dashboard"
method: GET
path: "/balance"
tags: ["Balance"]
---

# Balance:Dashboard

`GET /balance`

Gives an overview of the active balance of a merchant, including information about the next and the previous clearing. You can supply a merchant code. If you are a partner and you have access to that merchant code we will provide you the data. If no merchant code is provided your own balance information returned

## Query parameters

- `merchant` Code — unresolved $ref

## Response `200`

Ok.

- object
  - `balance` object, required
    - `amount` integer, required
    - `currency` string, required
  - `invoices` object, nullable, required
    - `amount` integer, required
    - `currency` string, required
  - `costs` object, nullable, required
    - `amount` integer, required
    - `currency` string, required
  - `availableBalance` object, nullable
    - `amount` integer, required
    - `currency` string, required
    - `turnoverGroups` object[]
      - `code` string
      - `name` string
      - `amount` integer
      - `currency` string
  - `nextClearing` object, required
    - `state` string, required
    - `date` integer, nullable, required
    - `amount` integer, required
    - `currency` string, required
  - `lastClearing` object, required
    - `date` integer, nullable, required
    - `amount` integer, required
    - `currency` string, required
  - `_links` Link[], required
    - `href` string, required
    - `rel` string, required
    - `type` string, required

## Other responses

- `401` — Unauthorized. Supplied credentials are invalid
- `403` — Forbidden. Supplied credentials have no rights
- `405` — Used HTTP method is not allowed
- `406` — Not acceptable. The supplied content type in the accept parameter in the header is not supported
- `429` — Rate limit reached.
- `500` — An internal error occurred

---

[API](https://skmtc.dev/pay/apis/pay-transaction-gateway-unit-api.md) · [All operations](https://skmtc.dev/pay/apis/pay-transaction-gateway-unit-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/pay/pay-transaction-gateway-unit-api/revisions/2bc260c7bdfc/schema)