---
title: "Get Settlement Account Balance API Reference"
description: "Fetch the settlement-account (wallet) balance for a user."
canonical: "https://eps.eko.in/docs/get-wallet-balance"
---


> **Canonical URL:** https://eps.eko.in/docs/get-wallet-balance
> This is a machine-readable Markdown version of the page for AI agents and LLMs. The primary (HTML) version lives at the canonical URL above.

# Get Settlement Account Balance API Reference

`GET https://staging.eko.in/ekoapi/v3/user/account/balance`

Fetch the settlement-account (wallet) balance for a user.

Returns the current settlement-account balance for the given registered mobile number.

> View product & pricing details: [User & Agent Management](https://eps.eko.in/products/user-management-api.md)

## Query parameters

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| initiator_id | string | yes | Registered mobile number of the API user (see Platform Credentials). e.g. 9962981729 |
| customer_id_type | string | yes | Identifier type. Fixed value: mobile_number. e.g. mobile_number |
| customer_id | string | yes | Registered mobile number for the wallet. e.g. 9910028267 |

## Headers

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| developer_key | string | yes | Static API key issued to your account after KYC. |
| secret-key | string | yes | Dynamic per-request signature: base64(HMAC-SHA256(timestamp, base64(access_key))). |
| secret-key-timestamp | string | yes | Current time in milliseconds since UNIX epoch, used to compute secret-key. Must match server time. |
| content-type | string | yes | application/json e.g. application/json |

## Response

⭐ marks fields highlighted as verifiable.

| Field | Type | Description |
| --- | --- | --- |
| status | number | Primary success indicator (0 = success). |
| message | string | Human-readable response / error message. |
| response_status_id | number | Granular status id; see the shared error-codes table. |
| response_type_id | number | A unique id for every possible response shape (success or error) — useful for client logic branching and analytics. |
| data | object | API-specific response payload. |
| data.balance ⭐ | string | Settlement-account balance (INR). |
| data.currency | string | Currency. |
| data.customer_id | string | Registered mobile number (echoed back). |

## Example response

```json
{
  "response_status_id": -1,
  "data": {
    "last_used_okekey": "0",
    "balance": "2.20834002375E9",
    "currency": "INR",
    "customer_id": "9910028267"
  },
  "response_type_id": 1,
  "message": "SUCCESS",
  "status": 0
}
```