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

# Rotas da API pública

> Todas as rotas /v1 disponíveis com chave gp_live_

Esta documentação cobre **somente** a API pública autenticada com chave de API:

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

O header `Authorization: Bearer gp_live_...` ainda é aceito por compatibilidade. Prefira `X-API-Key` em integrações novas.

## Rotas por módulo

Base URL de produção: `https://api.goatpay.com.br/v1` (todas as rotas abaixo são relativas a esse prefixo).

| Recurso                    | Prefixo `/v1`                                                          | Uso                                                                                                                         |
| -------------------------- | ---------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
| Receber PIX                | `payment-pix/*`                                                        | QR Code dinâmico                                                                                                            |
| Enviar PIX                 | `transfer-pix/*`                                                       | Saque para chave ou BR Code                                                                                                 |
| Transferências programadas | `transfer-scheduled/*`                                                 | Agendar, repetir ou por saldo — [guia](/api-reference/guides/pix#transferencias-programadas)                                |
| Saque (alias)              | `payouts/*`                                                            | Mesmo que `transfer-pix/*`                                                                                                  |
| Reembolso PIX              | `refunds/*`                                                            | Estorno de depósito (trilho PADRAO)                                                                                         |
| Transferência interna      | `transfer-internal/*`                                                  | Entre contas por e-mail GoatPay                                                                                             |
| Cripto                     | `payment-crypto/*`, `transfer-crypto/*`, `transfer-crypto-auto/create` | Depósito, saque, cotação                                                                                                    |
| Conta                      | `account/balance`, `account/transactions`                              | Saldo e extrato                                                                                                             |
| MED                        | `meds/*`                                                               | Disputas e evidências                                                                                                       |
| Webhooks                   | `webhooks/*`                                                           | Cadastro de URL de eventos                                                                                                  |
| **Loja**                   | —                                                                      | [Visão geral loja](/api-reference/guides/loja)                                                                              |
| Clientes                   | `customers/*`                                                          | Pagadores — [loja](/api-reference/guides/loja#clientes) · [cobranças](/api-reference/guides/cobrancas-assinaturas#clientes) |
| Produtos                   | `products/*`                                                           | Catálogo — [guia](/api-reference/guides/loja#produtos)                                                                      |
| Cupons                     | `coupons/*`                                                            | Descontos — [guia](/api-reference/guides/loja#cupons)                                                                       |
| Links de pagamento         | `payment-links/*`                                                      | Checkout PIX e cripto — [guia](/api-reference/guides/loja#links-de-pagamento)                                               |
| Cobranças avulsas          | `billings/*`                                                           | Pagamento único (boleto, cartão, PIX) — [guia](/api-reference/guides/cobrancas-assinaturas)                                 |
| Assinaturas                | `subscriptions/*`                                                      | Recorrência com ciclo fixo — [guia](/api-reference/guides/cobrancas-assinaturas)                                            |
| PIX automático             | `pix-automatic/*`                                                      | Débito recorrente com consentimento — [guia](/api-reference/guides/pix#pix-automatico)                                      |
| Recarga móvel              | `mobile-recharge/*`                                                    | Recarga pré-paga — [guia](/api-reference/guides/conta#recarga-movel)                                                        |
| Bureau de crédito          | `serasa/*`                                                             | Negativação e relatórios — [guia](/api-reference/guides/cobrancas-assinaturas#bureau-de-credito)                            |
| Subcontas                  | `subaccount/*`                                                         | Carteiras lógicas — [guia](/api-reference/guides/subcontas)                                                                 |

## Cobrança avulsa × assinatura

|         | Cobrança avulsa         | Assinatura                       |
| ------- | ----------------------- | -------------------------------- |
| Prefixo | `billings/*`            | `subscriptions/*`                |
| Uso     | Um pagamento            | Cobrança automática a cada ciclo |
| Criar   | `POST /billings/create` | `POST /subscriptions/create`     |

<Note>
  Receber PIX direto continua em `payment-pix/*`, independente de `billings`.
</Note>

## Nomes para não confundir

| Nome na doc     | Rota                                            | O que é                                    |
| --------------- | ----------------------------------------------- | ------------------------------------------ |
| Receber PIX     | `POST /v1/payment-pix/create`                   | QR Code dinâmico                           |
| Enviar PIX      | `POST /v1/transfer-pix/create`                  | Saída PIX                                  |
| Pagar contas    | `POST /v1/transfer-pix/create` + `pixCopyPaste` | [Guia](/api-reference/guides/pagar-contas) |
| Cobrança avulsa | `POST /v1/billings/create`                      | Boleto, cartão ou PIX (pagamento único)    |
| Assinatura      | `POST /v1/subscriptions/create`                 | Plano recorrente (mensal, etc.)            |
| Reembolso       | `POST /v1/refunds/create`                       | Devolução de depósito recebido             |
| Depósito cripto | `POST /v1/payment-crypto/create`                | Endereço on-chain                          |
| PIX na subconta | `POST /v1/payment-pix/create` + `subaccountId`  | Crédito na subconta                        |
| Link pago       | Webhook `payment_link.paid`                     | Checkout de link confirmado                |

## Trilho PADRAO

O trilho **PADRAO** é o único trilho da API pública. Não envie `pixRail` no body.

| Trilho   | Uso                                                                                 |
| -------- | ----------------------------------------------------------------------------------- |
| `PADRAO` | Conta verificada (CPF ou CNPJ); PIX regulado; cobranças; reembolso PIX e MED no SPI |

## Próximo passo

[Criar chave e primeira requisição](/tutorials/api-key)