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

# Saldo da conta

> Saldo disponível e pendente no trilho PADRAO.

<RequestExample>
  ```bash cURL theme={null}
  curl -X GET 'https://api.goatpay.com.br/v1/account/balance' \
    -H 'X-API-Key: gp_live_SUA_CHAVE'
  ```
</RequestExample>

<ResponseExample>
  ```json Success theme={null}
  {
    "success": true,
    "message": "Saldo consultado com sucesso",
    "data": {
      "currency": "BRL",
      "availableAmount": 1000,
      "pendingAmount": 0,
      "padrao": { "available": 1000, "pending": 0, "withdrawable": 1000, "locked24h": 0, "nextUnlockAt": null }
    },
    "requestId": "req_abc"
  }
  ```
</ResponseExample>


## OpenAPI

````yaml GET /account/balance
openapi: 3.1.0
info:
  title: GoatPay API
  description: >
    API pública merchant da GoatPay. Autenticação via header `X-API-Key:
    gp_live_...`.

    Respostas de sucesso usam o envelope `{ success, message, data, requestId
    }`.

    Campos internos (`accountId`, `metadata`, histórico de entregas de webhook,
    etc.) não são expostos.

    `providerTransactionId` aparece como `referenceId`; `providerInfractionId`
    como `infractionId`.

    Rate limit global: 100 requisições por minuto por API key (HTTP 429). Sem
    chave, limite por IP.
  version: 1.0.0
servers:
  - url: https://api.goatpay.com.br/v1
    description: Produção
security:
  - apiKeyAuth: []
tags:
  - name: pix
    description: >-
      Cobranças PIX (receber), reembolsos de depósito recebido e transferências
      PIX (enviar). Alias legado em payouts/* para envios.
  - name: transfer-internal
    description: Transferências entre contas GoatPay
  - name: transfer-scheduled
    description: Transferências programadas (agendar, repetir ou por saldo)
  - name: crypto
    description: Depósitos e transferências em criptomoeda
  - name: billings
    description: >-
      Cobranças avulsas (pagamento único) — boleto, cartão ou PIX na Conta
      Padrão (PF ou PJ)
  - name: subscriptions
    description: >-
      Assinaturas recorrentes com ciclo fixo — boleto, cartão ou PIX na Conta
      Padrão (PF ou PJ)
  - name: account
    description: Saldo e extrato
  - name: subaccount
    description: Subcontas merchant (carteiras lógicas sob a conta principal)
  - name: meds
    description: Disputas MED
  - name: webhooks
    description: Endpoints de webhook de saída
  - name: payouts
    description: Alias de transfer-pix para saques PIX
  - name: customers
    description: Clientes da loja (CRM)
  - name: products
    description: Produtos e entregas digitais
  - name: coupons
    description: Cupons de desconto para links
  - name: payment-links
    description: Links de pagamento e checkout hospedado
paths:
  /account/balance:
    get:
      tags:
        - account
      summary: Consultar saldo
      operationId: getAccountBalance
      responses:
        '200':
          $ref: '#/components/responses/AccountBalanceSuccess'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  responses:
    AccountBalanceSuccess:
      description: Saldo da conta.
      content:
        application/json:
          schema:
            type: object
            required:
              - success
              - message
              - data
            properties:
              success:
                type: boolean
              message:
                type: string
              data:
                $ref: '#/components/schemas/PublicAccountBalance'
              requestId:
                type: string
          examples:
            balance:
              summary: Saldo consultado
              value:
                success: true
                message: Saldo consultado com sucesso
                data:
                  currency: BRL
                  availableAmount: 1000
                  pendingAmount: 50
                  blockedAmount: 0
                  totalAmount: 1050
                  status: ACTIVE
                  padrao:
                    available: 1000
                    pending: 50
                    withdrawable: 950
                    locked24h: 50
                    nextUnlockAt: '2026-06-02T10:00:00.000Z'
                requestId: req_bal001
    Unauthorized:
      description: Chave ausente, inválida ou revogada.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
  schemas:
    PublicAccountBalance:
      type: object
      properties:
        currency:
          type: string
          example: BRL
        availableAmount:
          type: number
        pendingAmount:
          type: number
        blockedAmount:
          type: number
        totalAmount:
          type: number
        status:
          type: string
        padrao:
          type: object
          properties:
            available:
              type: number
            pending:
              type: number
            withdrawable:
              type: number
            locked24h:
              type: number
            nextUnlockAt:
              type: string
              format: date-time
    ErrorEnvelope:
      type: object
      required:
        - success
        - message
        - error
      properties:
        success:
          type: boolean
          example: false
        message:
          type: string
          example: Subconta inativa
        error:
          type: object
          properties:
            code:
              type: string
              example: Bad Request
            statusCode:
              type: integer
              example: 400
        requestId:
          type: string
          example: req_abc123
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: Chave `gp_live_...` criada em Integrações → Chaves de API no dashboard.

````