# PlugToPay

> Documentação para desenvolvedores da PlugToPay — orquestração de pagamentos multi-gateway.

## Docs

- [Cadastrar empresa (headless)](https://docs.plugtopay.com/api-reference/autenticação/cadastrar-empresa-headless.md): Cria uma empresa programaticamente e retorna as credenciais de API. A `api_key` é exibida uma única vez.
- [Cadastrar usuário e provisionar empresa](https://docs.plugtopay.com/api-reference/autenticação/cadastrar-usuário-e-provisionar-empresa.md): Cria um usuário e provisiona automaticamente uma empresa associada. Retorna JWT + credenciais de API em uma única chamada. A `api_key` é exibida uma única vez.
- [Definir nova senha](https://docs.plugtopay.com/api-reference/autenticação/definir-nova-senha.md): Define uma nova senha usando o token de reset.
- [Login de usuário](https://docs.plugtopay.com/api-reference/autenticação/login-de-usuário.md): Autentica um usuário e retorna um JWT para uso nas rotas do painel.
- [Solicitar recuperação de senha](https://docs.plugtopay.com/api-reference/autenticação/solicitar-recuperação-de-senha.md): Inicia o fluxo de recuperação de senha e retorna um token de reset.
- [Verificar credenciais de API](https://docs.plugtopay.com/api-reference/autenticação/verificar-credenciais-de-api.md): Valida os headers `X-Client-ID` + `X-API-Key`.
- [Atualizar configuração da empresa](https://docs.plugtopay.com/api-reference/configuração/atualizar-configuração-da-empresa.md): Atualiza a configuração da empresa, incluindo a URL de destino dos webhooks.
- [Configurar credenciais de gateway](https://docs.plugtopay.com/api-reference/gateways/configurar-credenciais-de-gateway.md): Registra ou rotaciona as credenciais de um gateway. As credenciais são armazenadas criptografadas e nunca retornadas nas respostas da API.
- [Listar gateways conectados](https://docs.plugtopay.com/api-reference/gateways/listar-gateways-conectados.md): Lista os gateways disponíveis para a empresa, incluindo o suporte a split de cada um.
- [Referência da API](https://docs.plugtopay.com/api-reference/introduction.md): Base URL, autenticação, idempotência, paginação e modelo de erros.
- [Buscar pagamento por ID](https://docs.plugtopay.com/api-reference/pagamentos/buscar-pagamento-por-id.md): Retorna um único `PaymentResource` com o mesmo shape da listagem, incluindo o array `webhooks` com as tentativas de entrega associadas à transação.
- [Criar pagamento com cartão](https://docs.plugtopay.com/api-reference/pagamentos/criar-pagamento-com-cartão.md): Cria uma transação com cartão. O backend usa coroutines para processar em paralelo: se o gateway não responder dentro do `time_to_wait_sync` (padrão 5s), retorna `202` imediatamente e o resultado final chega via webhook. Use o header `Idempotency-Key` para evitar cobranças duplicadas.
- [Criar pagamento PIX](https://docs.plugtopay.com/api-reference/pagamentos/criar-pagamento-pix.md): Cria uma transação PIX. O campo `payment_method` é injetado automaticamente pelo backend. O objeto `pix` na resposta contém tudo que é necessário para renderizar o QR ao cliente. Use o header `Idempotency-Key` para evitar cobranças duplicadas.
- [Listar pagamentos (integração)](https://docs.plugtopay.com/api-reference/pagamentos/listar-pagamentos-integração.md): Lista pagamentos da empresa autenticada via API Key. Retorna o mesmo shape paginado de `GET /user/payments`.
- [Listar pagamentos (painel)](https://docs.plugtopay.com/api-reference/pagamentos/listar-pagamentos-painel.md): Lista pagamentos da empresa autenticada via JWT do painel. Mesmo shape paginado e mesmos filtros de `GET /payments`.
- [Criar sub-conta](https://docs.plugtopay.com/api-reference/sub-contas/criar-sub-conta.md): Cria uma sub-conta (recebedor) para uso em splits de pagamento. Referencie o `id` retornado no campo `splits` ao criar um pagamento.
- [Autenticação](https://docs.plugtopay.com/authentication.md): Credenciais, JWT e recuperação de senha.
- [Gateways](https://docs.plugtopay.com/gateways.md): Gateways suportados, métodos aceitos e lógica de roteamento.
- [Idempotência](https://docs.plugtopay.com/idempotency.md): Processe pagamentos com segurança em redes instáveis.
- [Introdução](https://docs.plugtopay.com/index.md): O que é a PlugToPay, para quem é e como começar.
- [Pagamentos](https://docs.plugtopay.com/payments.md): Criação, consulta e detalhe de transações com cartão e PIX.
- [Status das transações](https://docs.plugtopay.com/status-codes.md): Estados possíveis de um pagamento e o que fazer em cada um.
- [Sub-contas](https://docs.plugtopay.com/sub-accounts.md): Splits de pagamento para plataformas e marketplaces.
- [Webhooks](https://docs.plugtopay.com/webhooks.md): Receba notificações em tempo real sobre eventos de pagamento.

## OpenAPI Specs

- [openapi](https://docs.plugtopay.com/api-reference/openapi.json)