> For the complete documentation index, see [llms.txt](https://docs.udara360.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.udara360.io/udara360-docs-1/account/editor/balance-inquiry.md).

# Balance Inquiry

To retrieve an account's balance, make a GET request to this endpoint, passing the account number as the `AccountNumber` query parameter.

A successful request returns the account's `ledgerBalance`, `availableBalance`, `withdrawableBalance`, and any `lienAmount` currently placed on it.

This process allows you to check exactly how much of an account's balance is usable before processing a transaction.

<mark style="color:blue;">`GET`</mark> `/api/account/v1/getaccountbalancebyaccountnumber`

**Headers**

| Name                                                | Value                |
| --------------------------------------------------- | -------------------- |
| Content-Type<mark style="color:red;">\*</mark>      | `application/json`   |
| Authorization<mark style="color:red;">\*</mark>     | `bearer <token>`     |
| Request-reference<mark style="color:red;">\*</mark> | `{unique_reference}` |

**Params**

| Name            | Data Type (Length) | Required | Description                                        |
| --------------- | ------------------ | -------- | -------------------------------------------------- |
| `AccountNumber` | string             | Required | The account number to retrieve balance details for |

**Body**

| Name                  | Data Type | Description                            |
| --------------------- | --------- | -------------------------------------- |
| accountNumber         | string    | The account number                     |
| `ledgerBalance`       | number    | Full balance including uncleared funds |
| `availableBalance`    | number    | Balance currently available for use    |
| `withdrawableBalance` | number    | Balance that can actually be withdrawn |
| `lienAmount`          | number    | Amount currently placed on lien        |

**Sample API Request**

{% tabs %}
{% tab title="Curl" %}

```javascript
curl --location -g '{{baseurl}}/api/account/v1/getaccountbalancebyaccountnumber?AccountNumber=1100029938' \
--header 'Authorization: bearer {token}' \
--header 'request-reference: {unique_reference}' \
--header 'Content-Type: application/json' \
--data ''
```

{% endtab %}
{% endtabs %}

**Response**

{% tabs %}
{% tab title="json" %}

```json
{
  "status": true,
  "message": "string",
  "data": {
    "accountNumber": "string",
    "ledgerBalance": 0,
    "availableBalance": 0,
    "withdrawableBalance": 0,
    "lienAmount": 0
  }
}
```

{% endtab %}
{% endtabs %}