# Alpha Gateway

> API de pagamentos do Alpha Gateway: PIX, boleto, links de pagamento e saques.

- [Introdução](https://docs.alphagateway.com.br/introducao.md): Receba por PIX, boleto e links de pagamento e faça saques pela API do Alpha Gateway.
- [Início rápido](https://docs.alphagateway.com.br/inicio-rapido.md): Da API Key à primeira cobrança em quatro passos.
- [Autenticação e escopos](https://docs.alphagateway.com.br/autenticacao.md): Header x-api-key, escopos da chave e formato das respostas.
- [Cobranças PIX](https://docs.alphagateway.com.br/guias/cobrancas-pix.md): QR Code PIX, expiração, devoluções e idempotência.
- [Boletos](https://docs.alphagateway.com.br/guias/boletos.md): Emissão, vencimento, juros e multa.
- [Links de pagamento](https://docs.alphagateway.com.br/guias/links-de-pagamento.md): Checkout hospedado para PIX, boleto e cartão.
- [Saques PIX](https://docs.alphagateway.com.br/guias/saques.md): Saques por chave PIX, limites e acompanhamento.
- [Conta e saldo](https://docs.alphagateway.com.br/guias/conta-e-saldo.md): Ambiente, permissões da chave e saldo da carteira.
- [Produtos](https://docs.alphagateway.com.br/guias/produtos.md): Catálogo usado nos links de pagamento.
- [Configurar webhooks](https://docs.alphagateway.com.br/webhooks/configurar.md): Cadastro do endpoint, eventos disponíveis e assinatura HMAC.
- [Cobrança (PIX_IN_UPDATE)](https://docs.alphagateway.com.br/webhooks/cobranca.md): Pagamento, expiração e devolução de cobranças PIX.
- [Saque (PIX_OUT_UPDATE)](https://docs.alphagateway.com.br/webhooks/saque.md): Confirmação e recusa de saques.
- [Devoluções](https://docs.alphagateway.com.br/webhooks/devolucoes.md): Como as devoluções chegam no webhook.
- [Checkout (CHECKOUT_UPDATE)](https://docs.alphagateway.com.br/webhooks/checkout.md): Pagamentos feitos pelo link de pagamento.
- [Boleto (BOLETO_UPDATE)](https://docs.alphagateway.com.br/webhooks/boleto.md): Registro, pagamento e baixa de boletos.
- [Fatura](https://docs.alphagateway.com.br/webhooks/fatura.md): Parcelas pagas, fatura quitada e parcela vencida.
- [Infração MED (INFRACTION_UPDATE)](https://docs.alphagateway.com.br/webhooks/infracao.md): Contestações MED PIX e saldo bloqueado.
- [Servidor MCP](https://docs.alphagateway.com.br/ia/servidor-mcp.md): Use a API como ferramentas em agentes de IA (Claude, Cursor, VS Code).
- [Para agentes de IA](https://docs.alphagateway.com.br/ia/agentes.md): OpenAPI, llms.txt e llms-full.txt.
- [Gerar QR Code PIX](https://docs.alphagateway.com.br/api-reference/cobranças--pix/gerar-qr-code-pix.md): Gera uma cobrança PIX e retorna o código copia e cola do QR Code para exibir ao cliente.
- [Consultar cobrança](https://docs.alphagateway.com.br/api-reference/cobranças--pix/consultar-cobrança.md): Consulta o status e detalhes de uma cobrança PIX utilizando a chave de idempotência.
- [Efetivar pagamento (Ambiente de teste)](https://docs.alphagateway.com.br/api-reference/cobranças--pix/efetivar-pagamento-ambiente-de-teste.md): Efetiva um pagamento manualmente para testes. Disponível apenas no ambiente de homologação.
- [Criar boleto](https://docs.alphagateway.com.br/api-reference/cobranças--boleto/criar-boleto.md): Registra um boleto bancário para o pagador informado. Multa, juros e desconto são aplicados automaticamente conforme a configuração da organização.
- [Consultar boleto](https://docs.alphagateway.com.br/api-reference/cobranças--boleto/consultar-boleto.md): Consulta o estado atual de um boleto pelo idempotency informado na criação.
- [Cancelar boleto](https://docs.alphagateway.com.br/api-reference/cobranças--boleto/cancelar-boleto.md): Cancela (baixa) um boleto registrado e ainda não pago.
- [Segunda via do boleto (PDF)](https://docs.alphagateway.com.br/api-reference/cobranças--boleto/segunda-via-do-boleto-pdf.md): Emite o PDF do boleto. Retorna o arquivo binário (application/pdf).
- [Efetivar pagamento de boleto (Ambiente de teste)](https://docs.alphagateway.com.br/api-reference/cobranças--boleto/efetivar-pagamento-de-boleto-ambiente-de-teste.md): Efetiva o pagamento de um boleto manualmente para testes. Disponível apenas no ambiente de homologação.
- [Criar link de pagamento](https://docs.alphagateway.com.br/api-reference/cobranças--links/criar-link-de-pagamento.md): Cria um link de pagamento compartilhável. Informe ao menos um produto, referenciado pelo `externalId` ou criado na hora (inline com `name` e `value`). Ao vincular um `customer`, os dados dele já vêm preenchidos automaticamente na página de checkout, agilizando o pagamento. É possível também informar…
- [Consultar link de pagamento](https://docs.alphagateway.com.br/api-reference/cobranças--links/consultar-link-de-pagamento.md): Retorna os detalhes de um link de pagamento, incluindo status, produtos vinculados e contagem de pagamentos realizados.
- [Solicitar saque](https://docs.alphagateway.com.br/api-reference/saques/solicitar-saque.md): Cria uma solicitação de saque via PIX para o destinatário informado. O saldo é reservado automaticamente e o processamento ocorre de forma assíncrona.
- [Consultar saque](https://docs.alphagateway.com.br/api-reference/saques/consultar-saque.md): Consulta o status e detalhes de um saque utilizando a chave de idempotência.
- [Consultar contexto da conta](https://docs.alphagateway.com.br/api-reference/conta/consultar-contexto-da-conta.md): Informa a organização dona da API Key, o ambiente (produção movimenta dinheiro de verdade; homologação é só teste), os escopos da chave e os meios de pagamento habilitados. Use antes de criar cobranças ou saques para saber em que ambiente e com que permissões a chave opera.
- [Consultar saldo](https://docs.alphagateway.com.br/api-reference/conta/consultar-saldo.md): Retorna os saldos disponível, bloqueado e pendente da carteira da organização.
- [Criar produto](https://docs.alphagateway.com.br/api-reference/produtos/criar-produto.md): Cadastra um novo produto no catálogo da organização. O `externalId` pode ser informado ou será gerado automaticamente.
- [Listar produtos](https://docs.alphagateway.com.br/api-reference/produtos/listar-produtos.md): Retorna a lista de produtos da organização com paginação e busca por nome ou externalId.
- [Consultar produto](https://docs.alphagateway.com.br/api-reference/produtos/consultar-produto.md): Retorna os detalhes de um produto pelo seu `externalId`.
- [Atualizar produto](https://docs.alphagateway.com.br/api-reference/produtos/atualizar-produto.md): Atualiza os dados de um produto existente pelo seu `externalId`. Apenas os campos enviados serão alterados.
- [Listar eventos de webhook](https://docs.alphagateway.com.br/api-reference/webhooks--endpoints/listar-eventos-de-webhook.md): Lista os eventos que podem ser assinados por um endpoint de webhook, considerando os módulos de pagamento habilitados para a organização.
- [Listar endpoints de webhook](https://docs.alphagateway.com.br/api-reference/webhooks--endpoints/listar-endpoints-de-webhook.md): Lista os endpoints de webhook da organização, do mais recente para o mais antigo. A credencial de assinatura não é retornada.
- [Criar endpoint de webhook](https://docs.alphagateway.com.br/api-reference/webhooks--endpoints/criar-endpoint-de-webhook.md): Cadastra uma URL para receber os eventos escolhidos. A URL precisa ser pública (http ou https) e única na organização. A credencial de assinatura HMAC é retornada só nesta resposta.
- [Consultar endpoint de webhook](https://docs.alphagateway.com.br/api-reference/webhooks--endpoints/consultar-endpoint-de-webhook.md): Consulta um endpoint de webhook da organização pelo ID. A credencial de assinatura não é retornada.
- [Atualizar endpoint de webhook](https://docs.alphagateway.com.br/api-reference/webhooks--endpoints/atualizar-endpoint-de-webhook.md): Altera a URL, a descrição, os eventos ou pausa/reativa um endpoint de webhook. Envie só os campos que vão mudar (ao menos um). A lista de eventos enviada substitui a anterior. A mudança vale para as próximas notificações; as já criadas seguem para a URL de quando foram geradas. Trocar a URL gera uma…
- [Remover endpoint de webhook](https://docs.alphagateway.com.br/api-reference/webhooks--endpoints/remover-endpoint-de-webhook.md): Remove um endpoint de webhook da organização. Ele não recebe novas notificações; as já criadas seguem as tentativas e o histórico de entregas continua disponível. Para só pausar, use a atualização com enabled = false.
- [Rotacionar credencial do webhook](https://docs.alphagateway.com.br/api-reference/webhooks--endpoints/rotacionar-credencial-do-webhook.md): Gera uma nova credencial de assinatura HMAC para o endpoint. As próximas notificações são assinadas com a nova; as criadas antes da rotação (inclusive as que estão em nova tentativa) continuam assinadas com a anterior. Aceite as duas durante a troca.
- [Listar entregas de webhook](https://docs.alphagateway.com.br/api-reference/webhooks--endpoints/listar-entregas-de-webhook.md): Lista as notificações de webhook enviadas (ou a enviar) para a organização, da mais recente para a mais antiga, com status e tentativas; o corpo enviado (payload) vem só com includePayload=true. O período tem no máximo 7 dias (sem datas, as últimas 24 horas) e a página vai até 100. Para as entregas…
- [Reenviar entrega de webhook](https://docs.alphagateway.com.br/api-reference/webhooks--endpoints/reenviar-entrega-de-webhook.md): Coloca de novo na fila uma entrega com status FAILED (tentativas esgotadas). O envio sai em instantes, para a mesma URL e assinado com a mesma credencial da notificação original (o header Alpha-Signature é recalculado com o horário do reenvio), e recomeça a contagem de tentativas.

## OpenAPI Specs

- [openapi](/openapi.json)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.