> ## Documentation Index
> Fetch the complete documentation index at: https://docs.bukiopay.com/llms.txt
> Use this file to discover all available pages before exploring further.

# BukioPay para Desenvolvedores

> A BukioPay é uma plataforma de e-commerce. Use a API para gerenciar catálogo, pedidos e pagamentos da sua loja.

## Como funciona

A BukioPay cuida da sua loja de ponta a ponta: vitrine, catálogo, carrinho, checkout, cobrança e entrega. Você vende sem montar infraestrutura de pagamento, e usa esta API para conectar a loja ao seu sistema — cadastrar produtos, criar pedidos, receber pagamentos e sacar o dinheiro.

Principais características:

* **Liquidação instantânea**: os pagamentos Pix são confirmados em segundos e caem na carteira da loja.
* **QR Code dinâmico**: cada cobrança gera um QR Code único, pronto para exibir ao cliente.
* **Copia e Cola**: além do QR Code, a API retorna o código Pix em texto para pagamentos manuais.
* **API REST**: todas as operações usam JSON sobre HTTPS, com semântica clara de verbos HTTP (`GET`, `POST`, `PATCH`, `DELETE`).

## Recursos disponíveis

A BukioPay cobre os principais fluxos de um negócio digital. Explore cada módulo abaixo:

<CardGroup cols={2}>
  <Card title="Cobranças Pix" icon="qrcode" href="/api-reference/pix-charges/create">
    Crie cobranças Pix com QR Code e Copia e Cola, e acompanhe a confirmação do pagamento.
  </Card>

  <Card title="Pedidos" icon="bag-shopping" href="/api-reference/orders/list">
    Visualize e gerencie os pedidos da sua loja, com rastreamento completo do ciclo de vida de cada venda.
  </Card>

  <Card title="Produtos" icon="box" href="/api-reference/products/list">
    Cadastre, atualize e liste os produtos disponíveis no seu catálogo.
  </Card>

  <Card title="Categorias" icon="tags" href="/api-reference/categories/list">
    Organize seus produtos em categorias para facilitar a navegação e a gestão do catálogo.
  </Card>

  <Card title="Cupons" icon="ticket" href="/api-reference/coupons/list">
    Crie e aplique cupons de desconto para suas campanhas promocionais.
  </Card>

  <Card title="Loja" icon="store" href="/api-reference/store/details">
    Consulte e atualize as informações e configurações da sua loja.
  </Card>
</CardGroup>

## URL Base

Todas as requisições à API devem ser enviadas para a seguinte URL base:

```text theme={null}
https://api.bukiopay.com/api/v1
```

Os endpoints são construídos a partir desta URL. Por exemplo, para listar pedidos, a URL completa seria:

```text theme={null}
https://api.bukiopay.com/api/v1/orders
```

## Formato das respostas

A BukioPay retorna todas as respostas no formato **JSON**. Abaixo estão as convenções adotadas:

* **Valores monetários**: sempre em reais, com decimais. Exemplo: `49.90` representa R\$ 49,90.
* **Datas e horários**: padrão ISO 8601, em UTC. Exemplo: `2026-05-22T14:30:00.000Z`.
* **Estrutura de erro**: respostas de erro incluem um campo `message` com a descrição do problema.

## Status dos recursos

Os recursos da API usam códigos de status textuais para indicar o estado atual de cada registro.

**Cobranças Pix**

| Código | Descrição |
| - | - |
| `pending` | Cobrança criada, aguardando pagamento |
| `paid` | Pagamento confirmado |
| `cancelled` | Cobrança cancelada |

**Pedidos**

| Código | Descrição |
| - | - |
| `pending` | Pedido criado, aguardando pagamento |
| `paid` | Pagamento do pedido confirmado |
| `cancelled` | Pedido cancelado |

<Note>
  Nunca exponha sua API Key em código frontend (JavaScript no navegador, aplicativos móveis, etc.). Ela deve ser usada exclusivamente em ambientes de servidor. Qualquer pessoa que obtiver sua chave terá acesso completo à sua conta.
</Note>

<Tip>
  Pronto para começar? Siga o [Quickstart](/quickstart) e faça sua primeira cobrança Pix em minutos.
</Tip>


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