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

# Saldo da Conta

> Quanto a conta tem para usar agora (available) e quanto está separado (reserved)

```json 200 theme={null}
{
  "account": {
    "id": "11111111-1111-1111-1111-111111111111",
    "available": 1250.4300,
    "reserved": 0.0000,
    "currency": "BRL"
  },
  "wallets": []
}
```

`wallets` vem sempre vazio nesta versão: o saldo é da conta, em `account`.


## OpenAPI

````yaml GET /api/v1/billing/Balance
openapi: 3.0.4
info:
  title: MessageFy API
  description: >-
    API de mensageria multi-canal do MessageFy. Envie e receba mensagens via
    WhatsApp, HTTP, Telegram e outros canais com uma API unificada.
  version: v1
servers:
  - url: https://api-dev.messagefy.io
security:
  - apiKey: []
tags:
  - name: Me
  - name: Configure
  - name: DeleteMessage
  - name: EditMessage
  - name: MessageOutbox
  - name: SearchMessage
  - name: SendMessage
  - name: BillingAccount
  - name: Account
  - name: ApiKey
  - name: Channel
  - name: GoogleChatRoute
  - name: Outbox
paths:
  /api/v1/billing/Balance:
    get:
      tags:
        - BillingAccount
      parameters:
        - name: currency
          in: query
          schema:
            type: string
        - name: accountId
          in: query
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            text/plain; v=1.0:
              schema:
                $ref: '#/components/schemas/BillingAccountBalanceDTO'
            application/json; v=1.0:
              schema:
                $ref: '#/components/schemas/BillingAccountBalanceDTO'
            text/json; v=1.0:
              schema:
                $ref: '#/components/schemas/BillingAccountBalanceDTO'
        '400':
          description: Bad Request
          content:
            text/plain; v=1.0:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            application/json; v=1.0:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            text/json; v=1.0:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '401':
          description: Unauthorized
          content:
            text/plain; v=1.0:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            application/json; v=1.0:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            text/json; v=1.0:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '404':
          description: Not Found
          content:
            text/plain; v=1.0:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            application/json; v=1.0:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            text/json; v=1.0:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
components:
  schemas:
    BillingAccountBalanceDTO:
      type: object
      properties:
        account:
          $ref: '#/components/schemas/BillingAccountBalanceSummaryDTO'
        wallets:
          type: array
          items:
            $ref: '#/components/schemas/BillingClientWalletDTO'
    ProblemDetails:
      type: object
      properties:
        type:
          type: string
          nullable: true
        title:
          type: string
          nullable: true
        status:
          type: integer
          format: int32
          nullable: true
        detail:
          type: string
          nullable: true
        instance:
          type: string
          nullable: true
    BillingAccountBalanceSummaryDTO:
      type: object
      properties:
        id:
          type: string
          format: uuid
        available:
          type: number
          format: double
        reserved:
          type: number
          format: double
        currency:
          type: string
    BillingClientWalletDTO:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        channelId:
          type: string
          format: uuid
          nullable: true
        currency:
          type: string
        available:
          type: number
          format: double
        reserved:
          type: number
          format: double
  securitySchemes:
    apiKey:
      type: apiKey
      description: >-
        Chave de API fornecida pelo painel administrativo do MessageFy. Enviada
        no header de cada requisição. O gateway APISIX valida a chave e injeta
        os headers X-Consumer-* automaticamente.
      name: API-KEY
      in: header

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.