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

# Obter detalhes da loja

> Permite que você recupere os detalhes da sua conta/loja, incluindo informações de saldo.

<Card horizontal>
  Requer a permissão `STORE:READ`.
</Card>

<Note>
  Este endpoint permite que você recupere todas as informações da sua loja, incluindo saldos disponíveis, pendentes e bloqueados.
</Note>

## Exemplo de uso

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET "https://api.abacatepay.com/v2/store/get" \
    -H "Authorization: Bearer YOUR_API_KEY" \
    -H "Content-Type: application/json"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch('https://api.abacatepay.com/v2/store/get', {
    method: 'GET',
    headers: {
      'Authorization': 'Bearer YOUR_API_KEY',
      'Content-Type': 'application/json'
    }
  });

  const data = await response.json();
  console.log(data);
  ```

  ```python Python theme={null}
  import requests

  headers = {
      'Authorization': 'Bearer YOUR_API_KEY',
      'Content-Type': 'application/json'
  }

  response = requests.get('https://api.abacatepay.com/v2/store/get', headers=headers)
  data = response.json()
  print(data)
  ```

  ```php PHP theme={null}
  <?php
  $headers = [
      'Authorization: Bearer YOUR_API_KEY',
      'Content-Type: application/json'
  ];

  $ch = curl_init();
  curl_setopt($ch, CURLOPT_URL, 'https://api.abacatepay.com/v2/store/get');
  curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
  curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

  $response = curl_exec($ch);
  $data = json_decode($response, true);
  curl_close($ch);

  print_r($data);
  ?>
  ```
</CodeGroup>

## Resposta de sucesso

```json theme={null}
{
  "data": {
    "id": "store_abc123xyz",
    "name": "Minha Loja",
    "balance": {
      "available": 50000,
      "pending": 10000,
      "blocked": 0
    }
  },
  "success": true,
  "error": null
}
```

## Resposta de erro

```json theme={null}
{
  "success": false,
  "error": "Erro ao recuperar dados da loja.",
  "data": null
}
```

## Casos de uso

<AccordionGroup>
  <Accordion title="Verificar saldo disponível">
    Use este endpoint para verificar quanto dinheiro você tem disponível para saque antes de criar uma nova transação de saque.
  </Accordion>

  <Accordion title="Dashboard da loja">
    Ideal para exibir informações da loja em dashboards administrativos, mostrando saldos e identificação da conta.
  </Accordion>

  <Accordion title="Reconciliação de contas">
    Útil para processos de reconciliação, permitindo verificar o estado atual dos saldos da sua conta.
  </Accordion>
</AccordionGroup>

<Warning title="Autenticação obrigatória" icon="lock" horizontal>
  Este endpoint requer autenticação via Bearer token. Certifique-se de incluir sua chave de API no cabeçalho Authorization.
</Warning>


## OpenAPI

````yaml GET /store/get
openapi: 3.1.0
info:
  title: API AbacatePay
  description: API para gerenciamento de cobranças e pagamentos usando o AbacatePay.
  version: 1.0.0
servers:
  - url: https://api.abacatepay.com/v1
    description: Único servidor para os ambientes de produção e sandbox.
security: []
paths:
  /store/get:
    get:
      summary: Obter detalhes da loja
      description: >-
        Permite que você recupere os detalhes da sua conta/loja, incluindo
        informações de saldo.
      responses:
        '200':
          description: Detalhes da loja retornados com sucesso.
          content:
            application/json:
              schema:
                oneOf:
                  - type: object
                    properties:
                      error:
                        type: string
                        description: Mensagem de erro caso ocorra algum problema.
                        example: Erro ao recuperar dados da loja.
                      data:
                        type: 'null'
                        example: null
                    required:
                      - error
                  - type: object
                    properties:
                      error:
                        type: 'null'
                        example: null
                      data:
                        $ref: '#/components/schemas/Store'
                    required:
                      - error
                      - data
        '401':
          description: Não autorizado. Falha na autenticação.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: >-
                      Mensagem de erro descrevendo o motivo da falha na
                      autenticação.
                    example: Token de autenticação inválido ou ausente.
      security:
        - bearerAuth: []
components:
  schemas:
    Store:
      type: object
      description: Dados da loja/conta do usuário.
      required:
        - id
        - name
        - balance
      additionalProperties: false
      properties:
        id:
          type: string
          description: Identificador único da loja.
          example: store_123456
        name:
          type: string
          description: Nome da loja.
          example: Minha Loja Online
        balance:
          type: object
          description: Informações de saldo da loja.
          required:
            - available
            - pending
            - blocked
          additionalProperties: false
          properties:
            available:
              type: number
              description: Saldo disponível para saque em centavos.
              example: 15000
            pending:
              type: number
              description: Saldo pendente de confirmação em centavos.
              example: 5000
            blocked:
              type: number
              description: Saldo bloqueado em disputas em centavos.
              example: 2000
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Cabeçalho de autenticação Bearer no formato `Bearer
        <abacatepay-api-key>` onde `<abacatepay-api-key>` é a sua chave de API.

````