> ## 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.

# Visão geral

> Base URL, chave de API e formato das respostas

A API pública GoatPay cobre receber e enviar PIX, cripto, transferência interna, saldo e extrato, disputas MED, webhooks e subcontas (quando habilitadas).

## Base URL

```
https://api.goatpay.com.br/v1
```

## Autenticação (API key)

Crie a chave no dashboard: **Integrações → Chaves de API**.

Envie em **todas** as requisições:

```
X-API-Key: gp_live_SUA_CHAVE
Content-Type: application/json
```

<Note>
  `Authorization: Bearer gp_live_...` ainda é aceito, mas use `X-API-Key` em integrações novas.
</Note>

Sem chave válida: `401`. Sem permissão na rota: `403`.

## Envelope de resposta

Sucesso:

```json theme={null}
{
  "success": true,
  "message": "Pagamento PIX criado com sucesso",
  "data": {},
  "requestId": "req_..."
}
```

Erro (rotas `/v1/*`):

```json theme={null}
{
  "success": false,
  "message": "Mensagem para integração",
  "error": {
    "code": "Bad Request",
    "statusCode": 400
  },
  "requestId": "req_..."
}
```

Valores monetários são em **reais** (`100` = R\$ 100,00).

Use `externalReference` no body quando precisar correlacionar cobranças com o ID do seu sistema.

### Campos na resposta

A API pública retorna apenas dados úteis para integração. Não são expostos: identificadores internos de conta, nome de processador de pagamento, status bruto do PSP, trilho da chave, metadados técnicos nem histórico operacional de webhooks na listagem.

Em transações PIX, `referenceId` (quando existir) substitui o ID técnico do processador.

## Rate limiting

100 requisições por minuto **por API key**. Veja [Rate limiting](/api-reference/rate-limiting).

Erros HTTP e `requestId`: [Erros e códigos](/api-reference/guides/errors).

## Mapa rápido

<CardGroup cols={2}>
  <Card title="Rotas da API" icon="list-check" href="/api-reference/escopo-api-publica">
    Todos os prefixos `/v1`
  </Card>

  <Card title="Loja (vendas)" icon="store" href="/api-reference/guides/loja">
    Clientes, produtos, cupons e links
  </Card>

  <Card title="Criar cobrança PIX" icon="qrcode" href="/api-reference/endpoint/payment-pix/create">
    Primeiro QR Code
  </Card>

  <Card title="Chave de API" icon="key" href="/tutorials/api-key">
    Tutorial passo a passo
  </Card>

  <Card title="Webhooks" icon="bell" href="/api-reference/guides/webhooks">
    Eventos e assinatura HMAC
  </Card>
</CardGroup>