# BukioPay

> Documentação oficial da BukioPay: crie cobranças Pix, gerencie pedidos e produtos, e receba a confirmação de pagamento por webhook.

- [BukioPay para Desenvolvedores](https://docs.bukiopay.com/introduction.md): A BukioPay é uma plataforma de e-commerce. Use a API para gerenciar catálogo, pedidos e pagamentos da sua loja.
- [Visão Geral](https://docs.bukiopay.com/authentication.md): URL base, autenticação, valores em reais e formato das respostas da API da BukioPay.
- [Primeira Cobrança Pix na BukioPay](https://docs.bukiopay.com/quickstart.md): Crie sua primeira cobrança Pix, exiba o QR Code e receba a confirmação do pagamento por webhook.
- [Transações PIX na BukioPay: Ciclo de Vida e QR Code](https://docs.bukiopay.com/concepts/pix.md): Entenda o ciclo de vida de uma transação PIX na BukioPay: status PENDING, COMPLETED, CANCELLED e FAILED, campos da resposta, exibição do QR Code e boas práticas.
- [Pedidos e Checkout Público](https://docs.bukiopay.com/concepts/orders.md): Estrutura dos pedidos, checkout público com Pix, valores em reais, idempotência e confirmação por webhook.
- [Configurar Sua Loja BukioPay e Gerenciar a API Key](https://docs.bukiopay.com/concepts/store.md): Entenda como sua loja BukioPay funciona, como consultar seus dados via API, onde encontrar sua API Key e como substituí-la caso seja comprometida.
- [Visão Geral](https://docs.bukiopay.com/api-reference/overview.md): URL base, autenticação, valores em reais e formato das respostas da API da BukioPay.
- [Criar Cobrança](https://docs.bukiopay.com/api-reference/pix-charges/create.md): Cria uma cobrança Pix avulsa e retorna o QR Code e o código Copia e Cola. Valor em reais, mínimo de R$ 1,00.
- [Listar Cobranças](https://docs.bukiopay.com/api-reference/pix-charges/list.md): Lista as cobranças da sua loja com filtro por tipo, situação, busca e intervalo de datas.
- [Obter Cobrança](https://docs.bukiopay.com/api-reference/pix-charges/get.md): Retorna os detalhes de uma cobrança: situação, valores com taxa e líquido, QR Code e data do pagamento.
- [Cancelar Cobrança](https://docs.bukiopay.com/api-reference/pix-charges/cancel.md): Cancela uma cobrança Pix que ainda não foi paga.
- [Consultar Taxa](https://docs.bukiopay.com/api-reference/withdrawals/quote.md): Retorna a taxa de saque e os valores mínimo e máximo permitidos para a sua loja.
- [Criar Saque](https://docs.bukiopay.com/api-reference/withdrawals/create.md): Envia um saque Pix por chave ou código Pix Copia e Cola (BR Code); o valor solicitado é o que o destinatário recebe.
- [Listar Saques](https://docs.bukiopay.com/api-reference/withdrawals/list.md): Lista os saques Pix da sua loja com situação, valores e datas.
- [Webhooks](https://docs.bukiopay.com/api-reference/webhooks/introducao.md): Receba avisos automáticos quando um pagamento é confirmado, um reembolso acontece ou um saque é concluído.
- [Eventos](https://docs.bukiopay.com/api-reference/webhooks/eventos.md): Catálogo dos eventos de pagamento, reembolso, mediação e transferência, com o payload de cada um.
- [Validar a assinatura](https://docs.bukiopay.com/api-reference/webhooks/assinatura.md): Confira o HMAC-SHA256 do header X-Webhook-Signature antes de confiar no conteúdo de um webhook.
- [Listar Pedidos](https://docs.bukiopay.com/api-reference/orders/list.md): Lista os pedidos da sua loja com paginação, filtro por situação, busca e intervalo de datas.
- [Criar Pedido](https://docs.bukiopay.com/api-reference/orders/create.md): Cria um pedido com produtos do catálogo usando a API key (escopo transaction.create) e retorna o QR Code Pix e o Copia e Cola.
- [Obter Pedido](https://docs.bukiopay.com/api-reference/orders/get.md): Retorna os detalhes de um pedido: itens, situação, dados do cliente e valores em reais.
- [Listar Produtos](https://docs.bukiopay.com/api-reference/products/list.md): Lista os produtos do catálogo da sua loja, com preço em reais, estoque disponível e variações.
- [Criar Produto](https://docs.bukiopay.com/api-reference/products/create.md): Cria um produto no catálogo da sua loja com nome, preço em reais, categoria e tipo.
- [Atualizar Produto](https://docs.bukiopay.com/api-reference/products/update.md): Atualiza nome, preço em reais, descrição, categoria ou tipo de um produto. Envie apenas os campos que quer mudar.
- [Deletar Produto](https://docs.bukiopay.com/api-reference/products/delete.md): Remove um produto do catálogo da sua loja. Pedidos já feitos com o produto não são afetados.
- [GET /api/v1/categories: Listar Categorias da Loja](https://docs.bukiopay.com/api-reference/categories/list.md): Lista todas as categorias da loja autenticada com id, nome, descrição e campo order que controla a ordem de exibição no catálogo de produtos.
- [POST /api/v1/categories: Nova Categoria de Produtos](https://docs.bukiopay.com/api-reference/categories/create.md): Cria uma nova categoria na loja com nome obrigatório, descrição opcional e campo order para controlar a sequência de exibição no catálogo de produtos.
- [PUT /api/v1/categories/:id: Editar Dados da Categoria](https://docs.bukiopay.com/api-reference/categories/update.md): Atualiza nome, descrição ou ordem de exibição de uma categoria existente. Envie apenas os campos que deseja modificar — os demais permanecem inalterados.
- [Remover Categoria — DELETE /api/v1/categories/:id](https://docs.bukiopay.com/api-reference/categories/delete.md): Remove permanentemente uma categoria da loja pelo ID. Verifique se há produtos vinculados antes de excluir. A operação é irreversível e imediata.
- [GET /api/v1/coupons: Listar Todos os Cupons da Loja](https://docs.bukiopay.com/api-reference/coupons/list.md): Lista todos os cupons de desconto da loja com código, tipo (percentage ou fixed), valor, limite de uso, contagem de usos e data de expiração.
- [POST /api/v1/coupons: Criar Novo Cupom de Desconto](https://docs.bukiopay.com/api-reference/coupons/create.md): Cria um cupom de desconto percentual ou de valor fixo na loja, com código único, limite de usos e data de expiração configuráveis.
- [PUT /api/v1/coupons/:id: Atualizar Cupom Existente](https://docs.bukiopay.com/api-reference/coupons/update.md): Atualiza valor, limite de usos, status ativo/inativo ou data de expiração de um cupom. Envie apenas os campos que deseja alterar na requisição.
- [DELETE /api/v1/coupons/:id: Remover Cupom da Loja](https://docs.bukiopay.com/api-reference/coupons/delete.md): Remove permanentemente um cupom da loja pelo ID. Para suspender temporariamente, use active: false no endpoint de atualização em vez de deletar.
- [Validar Cupom de Desconto](https://docs.bukiopay.com/api-reference/coupons/validate.md): Endpoint público que valida um código de cupom e devolve o desconto em reais calculado sobre o total do pedido.
- [GET /api/v1/stores/me/store: Dados Completos da Loja](https://docs.bukiopay.com/api-reference/store/details.md): Retorna nome, slug, API Key, descrição e imagem da loja autenticada. Use o campo id como storeId nos endpoints que exigem identificação da loja.
- [Introdução ao Editor](https://docs.bukiopay.com/editor/introducao.md): Conheça o editor de código da BukioPay e aprenda a personalizar o visual da sua loja.
- [Estrutura de Arquivos](https://docs.bukiopay.com/editor/estrutura.md): Como os arquivos do template estão organizados em pastas e o que vai em cada uma.
- [Sintaxe](https://docs.bukiopay.com/editor/sintaxe.md): Como exibir dados, usar condições, repetir listas e incluir componentes nos templates EJS.
- [Variáveis](https://docs.bukiopay.com/editor/variaveis.md): Os dados disponíveis nos templates: loja, produto, usuário, paginação e busca.
- [Páginas e Rotas](https://docs.bukiopay.com/editor/paginas.md): Qual arquivo do template responde por cada endereço da sua loja.

## OpenAPI Specs

- [openapi](/openapi.json)


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