---
title: "Retrieve merchant balance"
method: GET
path: "/balance/me"
tags: ["Balance"]
---

# Retrieve merchant balance

`GET /balance/me`

This API endpoint is used to  retrieve current balance

## Response `200`

The balance is retrieved

- BalanceObject
  - `id` string, uuid — Unique identifier of the balance Object
  - `type` 'payment' | 'transfer' | 'refund' | 'settlement' — type of transaction
  - `amount` integer — correspond to available balance, available for transfer
  - `pendingAmount` integer — correspond to pending balance, usually correspond to card checkout.
  - `currency` string — The currency associated to the amount. If you don't specify a value, we'll assume 'XOF'
  - `timestamp` string, date-time — The time and date that the the transaction was recorded in our system. Note that this doesn't describe when payments were executed, only when they were submitted

## Other responses

- `400` — Bad Request
- `401` — The caller is unauthenticated
- `403` — Access rights not sufficient
- `500` — Internal Server Error.

---

[API](https://skmtc.dev/bictorys/apis/pay.md) · [All operations](https://skmtc.dev/bictorys/apis/pay/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/bictorys/pay/revisions/b85cce14340b/schema)