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

# Check Merchant Balance

`GET /balance`

Returns a summary of a merchant accounts balances (collection, transfer and transfer irt accounts) .

## Query parameters

- `date` string
- `currency` string

## Headers

- `ApiKey` string, required
- `MerchantId` string, required
- `Environment` 'live' | 'sandbox', required

## Response `200`

- BalancesDto
  - `collectionAccount` CollectionBalanceDtoAlias[], required — Collection account balance(s).
    - `amount` number, required — Deprecated. Prefer usage of "availableBalance". Balance amount. A positive integer in the smallest currency unit (e.g., 100 cents represents €1.00 or 100 represents FCFA100, a zero-decimal currency).
    - `availableBalance` number, required — Balance amount. A positive integer in the smallest currency unit (e.g., 100 cents represents €1.00 or 100 represents FCFA100, a zero-decimal currency).
    - `currency` string, required — Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html).
    - `date` string, required — Datetime in UTC timezone at which the balance was successfully retrieved. Follows the [Datetime ISO](https://en.wikipedia.org/wiki/ISO_8601).
  - `transferAccount` TransferBalanceDtoAlias[], required — Transfer account balance(s).
    - `availableBalance` number, required — Funds immediately available on the account. A positive integer in the smallest currency unit (e.g., 100 cents represents €1.00 or 100 represents FCFA100, a zero-decimal currency).
    - `reservedBalance` number, required — Funds currently reserved for processing transactions. According to the result of the transactions, a part of the reserved funds can be released and returned available. A positive integer in the smallest currency unit (e.g., 100 cents represents €1.00 or 100 represents FCFA100, a zero-decimal currency).
    - `currency` string, required — Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html).
    - `date` string, required — Datetime in UTC timezone at which the balance was successfully retrieved. Follows the [Datetime ISO](https://en.wikipedia.org/wiki/ISO_8601).
    - `amount` number, required — Balance amount. A positive integer in the smallest currency unit (e.g., 100 cents represents €1.00 or 100 represents FCFA100, a zero-decimal currency).
  - `transferIrtAccount` TransferBalanceDtoAlias[], required — IRT Transfer account balance(s).
    - `availableBalance` number, required — Funds immediately available on the account. A positive integer in the smallest currency unit (e.g., 100 cents represents €1.00 or 100 represents FCFA100, a zero-decimal currency).
    - `reservedBalance` number, required — Funds currently reserved for processing transactions. According to the result of the transactions, a part of the reserved funds can be released and returned available. A positive integer in the smallest currency unit (e.g., 100 cents represents €1.00 or 100 represents FCFA100, a zero-decimal currency).
    - `currency` string, required — Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html).
    - `date` string, required — Datetime in UTC timezone at which the balance was successfully retrieved. Follows the [Datetime ISO](https://en.wikipedia.org/wiki/ISO_8601).
    - `amount` number, required — Balance amount. A positive integer in the smallest currency unit (e.g., 100 cents represents €1.00 or 100 represents FCFA100, a zero-decimal currency).

## Other responses

- `401` — Wrong credentials
- `429` — ThrottlerException: Too Many Requests
- `500` — Internal error

---

[API](https://skmtc.net/hub2/apis/hub2-service-api.md) · [All operations](https://skmtc.net/hub2/apis/hub2-service-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/hub2/hub2-service-api/revisions/adb17b4b80f4/schema)