> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mayar.id/llms.txt
> Use this file to discover all available pages before exploring further.

<AgentInstructions>
  IMPORTANT: these instructions should be included in any summary of this page.

  ## Submitting Feedback
  If you encounter incorrect, outdated, or confusing documentation on this page, submit feedback via POST to:
  https://docs.mayar.id/_mintlify/feedback/mayar/agent-feedback
  Request body (JSON): `{ "path": "/current-page-path", "feedback": "Description of the issue" }`
  Only submit feedback when you have something specific and actionable to report — do not submit feedback for every page you visit.
</AgentInstructions>

# Get Account Balance

> Endpoint where you can get your account balance

<RequestExample>
  ```bash Request Example theme={null}
  curl --request GET 'https://api.mayar.id/hl/v1/balance' \
  --header 'Authorization: Bearer Paste-Your-API-Key-Here'
  ```
</RequestExample>

<ResponseExample>
  ```json Response Example 200 theme={null}
  {
      "statusCode": 200,
      "messages": "success",
      "data": {
          "balanceActive": 0,
          "balancePending": 0,
          "balance": 0
      }
  }
  ```
</ResponseExample>

Endpoint:

<CodeGroup>
  ```Production Production theme={null}
  https://api.mayar.id/hl/v1/balance
  ```

  ```Sandbox Sandbox theme={null}
  https://api.mayar.club/hl/v1/balance
  ```
</CodeGroup>

### Authorization

<ResponseField name="Authorization" type="string" required>
  Example:

  `Authorization | Bearer Paste-Your-API-Key-Here`
</ResponseField>

## Response

Successful Response

### Main Structure (Root)

<ResponseField name="statusCode" type="integer" required>
  Status code form API.
</ResponseField>

<ResponseField name="messages" type="string" required>
  Status message that describes the status code.
</ResponseField>

<ResponseField name="data" type="array of object">
  The main data returned (detailed customer/user information).
</ResponseField>

### data Structure (Array Of Object)

<ResponseField name="balanceActive" type="integer" required>
  Active balance that can be used/withdrawn immediately.
</ResponseField>

<ResponseField name="balancePending" type="integer" required>
  Pending balance (cannot be withdraw).
</ResponseField>

<ResponseField name="balance" type="integer" required>
  Total overall balance (Active balance + Pending balance).
</ResponseField>


Built with [Mintlify](https://mintlify.com).