# Customer Balance Inquiry

This request retrieves the account balance based on the provided account number. You will need to pass the customer's `accountNumber` in the request query, you also provide a `request-refrence` to the query.

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

\
This endpoint is valuable for applications requiring real-time account balance data access and is particularly useful for financial systems and account management tools.

**Headers**

<table><thead><tr><th width="368">Name</th><th>Value</th></tr></thead><tbody><tr><td>Content-Type<mark style="color:red;">*</mark></td><td><code>application/json</code></td></tr><tr><td>Authorization<mark style="color:red;">*</mark></td><td><code>Bearer &#x3C;token></code></td></tr><tr><td>Request-Reference</td><td><code>{unique-reference}</code></td></tr></tbody></table>

**Query Parameter**

<table><thead><tr><th width="185">Name</th><th width="173">Data Type (length)</th><th width="104" data-type="checkbox">Required</th><th>Description</th></tr></thead><tbody><tr><td><code>accountNumber</code></td><td>string <a data-footnote-ref href="#user-content-fn-1"><em>(10)</em></a></td><td>true</td><td>Customer's account number</td></tr></tbody></table>

<details>

<summary>Sample Request</summary>

```json
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 ''
```

</details>

<details>

<summary>Response : <code>200</code></summary>

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

</details>

[^1]: This is the maximum number of characters allowed.