---
title: "Account Balance"
method: GET
path: "/ws/v1/account/balance"
tags: ["Account"]
---

# Account Balance

`GET /ws/v1/account/balance`

## Request

- Base URL: `https://api.iranpayamak.com`
- URL: `https://api.iranpayamak.com/ws/v1/account/balance`
- Auth: API key in header `Api-Key`

## Headers

- `Accept` string

## Response `200`

- object
  - `status` 'success' | 'error', required
  - `message` union, required
    - string
    - string[]
    - object
  - `data` object, required
    - `balanceAmount` integer, required
    - `balanceCount` integer, required
    - `details` object[], required
      - `count` integer, required: تعداد پیامک
      - `rate` integer, required: تعرفه پیامک
      - `amount` integer, required: موجودی تومانی

## Other responses

- `401`

---

[API](https://skmtc.dev/farazsms/apis/farazsms-public-apis.md) - [All operations](https://skmtc.dev/farazsms/apis/farazsms-public-apis/llms.txt) - [OpenAPI document](https://skmtc.dev/farazsms/apis/farazsms-public-apis/revisions/e80a7c5dea3f?raw)