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

# Obter Loja

> Retorna os dados e o saldo da sua loja.

- `id` — identificador da loja (o `id` do seu merchant).
- `name` — nome da loja. É derivado dos seus dados de cadastro (KYC),
  na ordem: nome fantasia → razão social → nome completo → nome do
  usuário. Pode ser `null` enquanto o cadastro não estiver completo.
- `balance` — saldo da loja em **centavos**: `available` (disponível
  para saque), `pending` (aguardando confirmação) e `blocked`
  (retido para análise/disputa).


Retorna os dados e o saldo da sua loja.

**Exemplo de resposta:**

```json theme={null}
{
  "data": {
    "id": "clx1a2b3c4d5e6f7g8h9i0j",
    "name": "Minha Loja LTDA",
    "balance": {
      "available": 12500,
      "pending": 3000,
      "blocked": 0
    }
  },
  "error": null,
  "success": true
}
```

<Note>
  Os valores de `balance` estão em **centavos** (`12500` = R\$ 125,00) — mesma
  convenção de `GET /me/balance`.
</Note>

<Note>
  `name` pode vir `null` enquanto o cadastro (KYC) não estiver completo. Ver
  [Referência](/pages/store/reference) para a ordem de derivação do nome.
</Note>


## OpenAPI

````yaml GET /me/store
openapi: 3.1.0
info:
  title: API Liquerapay
  description: |
    API pública da Liquerapay para criar cobranças PIX, processar saques,
    gerenciar clientes e receber eventos via webhooks.

    ## Versão Beta

    A v1 está em **beta**. Endpoints e payloads podem sofrer pequenas
    alterações antes da versão estável (1.0). Recomendamos travar a versão
    da sua integração no `package.json` / `requirements.txt` enquanto
    estivermos em beta.

    Não há ambiente de sandbox — todas as chamadas acontecem contra o
    ambiente de produção.

    ## Como começar

    1. Crie sua conta em [app.liquerapay.com](https://app.liquerapay.com)
    2. Gere uma chave de API no painel (`liq_...`)
    3. Faça sua primeira chamada em `https://api.liquerapay.com`
  version: 1.0.0-beta
  contact:
    name: Suporte Liquerapay
    url: https://liquerapay.com
  license:
    name: Proprietary
servers:
  - url: https://api.liquerapay.com
    description: Produção
security:
  - bearerAuth: []
tags:
  - name: Customers
    description: Cadastre e gerencie os clientes da sua loja para reutilizar em cobranças.
  - name: Checkout Transparente
    description: >-
      Crie cobranças PIX (QR Code copia-e-cola) direto pela API e gerencie
      devoluções.
  - name: Withdrawals
    description: Solicite saques do saldo disponível para uma chave PIX.
  - name: Webhooks
    description: Cadastre URLs para receber eventos da Liquerapay em tempo real.
  - name: Loja
    description: Consulte os dados e o saldo da sua loja.
paths:
  /me/store:
    get:
      tags:
        - Loja
      summary: Obter loja
      description: |
        Retorna os dados e o saldo da sua loja.

        - `id` — identificador da loja (o `id` do seu merchant).
        - `name` — nome da loja. É derivado dos seus dados de cadastro (KYC),
          na ordem: nome fantasia → razão social → nome completo → nome do
          usuário. Pode ser `null` enquanto o cadastro não estiver completo.
        - `balance` — saldo da loja em **centavos**: `available` (disponível
          para saque), `pending` (aguardando confirmação) e `blocked`
          (retido para análise/disputa).
      responses:
        '200':
          description: Dados da loja.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StoreResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
components:
  schemas:
    StoreResponse:
      type: object
      required:
        - data
        - error
        - success
      properties:
        data:
          $ref: '#/components/schemas/Store'
        error:
          type: 'null'
          example: null
        success:
          type: boolean
          enum:
            - true
          example: true
    Store:
      type: object
      required:
        - id
        - name
        - balance
      properties:
        id:
          type: string
          description: Identificador da loja (o `id` do merchant).
          example: clx1a2b3c4d5e6f7g8h9i0j
        name:
          type: string
          nullable: true
          description: |
            Nome da loja, derivado do cadastro (KYC), na ordem: nome fantasia →
            razão social → nome completo → nome do usuário. `null` enquanto o
            cadastro não estiver completo.
          example: Minha Loja LTDA
        balance:
          $ref: '#/components/schemas/StoreBalance'
    Error:
      type: object
      required:
        - error
        - message
        - success
      properties:
        error:
          type: string
          description: >-
            Código do erro (ex.: `VALIDATION_ERROR`, `UNAUTHORIZED`,
            `NOT_FOUND`).
          example: VALIDATION_ERROR
        message:
          type: string
          description: Mensagem amigável descrevendo o erro.
          example: 'amount: deve ser um número inteiro positivo'
        success:
          type: boolean
          enum:
            - false
          example: false
    StoreBalance:
      type: object
      required:
        - available
        - pending
        - blocked
      properties:
        available:
          type: integer
          description: Saldo disponível para saque, em centavos.
          example: 12500
        pending:
          type: integer
          description: Saldo aguardando confirmação, em centavos.
          example: 3000
        blocked:
          type: integer
          description: Saldo retido para análise ou disputa, em centavos.
          example: 0
  responses:
    Unauthorized:
      description: Falha de autenticação (token inválido, ausente ou revogado).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: UNAUTHORIZED
            message: Token inválido ou ausente
            success: false
    Forbidden:
      description: Acesso negado para esta operação.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: FORBIDDEN
            message: Saques estão temporariamente bloqueados para este merchant
            success: false
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key ou JWT
      description: |
        Autentique suas requisições enviando o token no header
        `Authorization: Bearer <token>`.

        O token pode ser:

        - Uma **API key** com prefixo `liq_`, gerada em
          [Dashboard Liquerapay → Configurações → API Keys](https://app.liquerapay.com).
        - Um **JWT** retornado pelo login do dashboard (uso interno).

        Não há distinção de ambiente — toda chave vale para o único
        ambiente disponível (produção).

````