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

# Referência da API

> Visão geral da API Beehive Pay — autenticação, base URL e formato de respostas.

## Base URL

Todos os endpoints utilizam a seguinte URL base:

```
https://api.conta.paybeehive.com.br/v1
```

## Autenticação

A API utiliza **Basic Access Authentication**. Você deve enviar sua **chave secreta** codificada em Base64 no header `Authorization`.

```
Authorization: Basic <base64(SECRET_KEY:x)>
```

> A senha é sempre `x` — não é utilizada, mas é exigida pelo padrão Basic Auth.

**Onde encontrar sua chave secreta:**
Acesse [Configurações → Credenciais de API](https://app.conta.paybeehive.com.br/settings/credentials) ou clique em **Credenciais** no canto superior direito.

## Formato das respostas

Todas as respostas são retornadas em **JSON**.

```json theme={null}
{
  "id": 12345,
  "status": "paid",
  "amount": 500
}
```

## Códigos de status HTTP

| Código | Significado                                  |
| ------ | -------------------------------------------- |
| `200`  | Sucesso                                      |
| `400`  | Requisição inválida                          |
| `401`  | Não autorizado — verifique sua chave secreta |
| `404`  | Recurso não encontrado                       |
| `500`  | Erro interno do servidor                     |

## Endpoints disponíveis

Explore os endpoints organizados por recurso no menu lateral:

* **Transações** — criar, listar e buscar transações (cartão, Pix e boleto)
* **Reembolsos** — estornar transações
* **Clientes** — criar, listar e buscar clientes
* **Transferências** — criar e consultar transferências
* **Saldo** — consultar saldo disponível
* **Recebedores** — criar e consultar recebedores
* **Contas Bancárias** — adicionar e consultar contas bancárias
* **Empresa** — consultar e atualizar dados da empresa
* **Payment Links** — criar e atualizar payment links
* **Webhooks** — modelo de payloads dos eventos