# Owem API

> Owem é uma plataforma de pagamentos PIX no Brasil. Esta documentação cobre a API completa para integração de pagamentos.

## Informações Gerais

- Base URL: `https://api.owem.com.br`
- Autenticação: Basic Auth com `API_KEY:API_SECRET` em Base64
- Documentação: `https://docs.owem.com.br`

## Guias (pt-BR)

- [Introdução](https://docs.owem.com.br/pt-BR): Visão geral da plataforma Owem e como começar a integração com PIX
- [Quickstart](https://docs.owem.com.br/pt-BR/quickstart): Guia rápido para configurar sua primeira integração em minutos
- [Receber Pagamentos (PIX IN)](https://docs.owem.com.br/pt-BR/guides/receber-pagamentos): Como gerar QR Codes dinâmicos e receber pagamentos PIX
- [Enviar Pagamentos (PIX OUT)](https://docs.owem.com.br/pt-BR/guides/enviar-pagamentos): Como realizar transferências PIX para qualquer chave
- [Webhooks](https://docs.owem.com.br/pt-BR/guides/webhooks): Como configurar e receber notificações em tempo real
- [Conciliação Financeira](https://docs.owem.com.br/pt-BR/guides/conciliacao): Como usar o Ledger para reconciliar transações
- [MEDs - Disputas](https://docs.owem.com.br/pt-BR/guides/meds): Como gerenciar Mecanismos Especiais de Devolução

## Guides (EN)

- [Introduction](https://docs.owem.com.br/en): Overview of Owem platform and how to start PIX integration
- [Quickstart](https://docs.owem.com.br/en/quickstart): Quick guide to set up your first integration in minutes
- [Receive Payments (PIX IN)](https://docs.owem.com.br/en/guides/receive-payments): How to generate dynamic QR Codes and receive PIX payments
- [Send Payments (PIX OUT)](https://docs.owem.com.br/en/guides/send-payments): How to make PIX transfers to any key
- [Webhooks](https://docs.owem.com.br/en/guides/webhooks): How to configure and receive real-time notifications
- [Reconciliation](https://docs.owem.com.br/en/guides/reconciliation): How to use Ledger for transaction reconciliation
- [MEDs - Disputes](https://docs.owem.com.br/en/guides/meds): How to manage Special Return Mechanisms

## API Reference - Autenticação

- [Ping](https://docs.owem.com.br/pt-BR/api-reference/autenticacao/ping): `GET /v4/i/ping` - Testa conectividade e autenticação com a API

## API Reference - Conta Bancária

- [Consultar Saldo](https://docs.owem.com.br/pt-BR/api-reference/conta/consultar-saldo): `GET /v4/i/bank-accounts/{accountId}/balance` - Retorna o saldo disponível da conta

## API Reference - Ledger (Extrato)

- [Listar Movimentações](https://docs.owem.com.br/pt-BR/api-reference/ledger/consulta-ledger): `GET /v4/i/ledger` - Lista todas as movimentações financeiras com filtros e paginação
- [Consultar por External ID](https://docs.owem.com.br/pt-BR/api-reference/ledger/consultar-por-external-id): `GET /v4/i/ledger/external-id/{externalId}` - Busca movimentação pelo ID externo do cliente
- [Consultar por End-to-End ID](https://docs.owem.com.br/pt-BR/api-reference/ledger/consultar-por-endtoendid): `GET /v4/i/ledger/end-to-end/{endToEndId}` - Busca movimentação pelo ID de rastreio PIX
- [Consultar por Entry ID](https://docs.owem.com.br/pt-BR/api-reference/ledger/consultar-por-entry-id): `GET /v4/i/ledger/entry-id/{entryId}` - Busca movimentação pelo ID interno do Ledger

## API Reference - PIX IN (Recebimentos)

- [Gerar QR Code Dinâmico](https://docs.owem.com.br/pt-BR/api-reference/pix-in/gerar-qrcode): `POST /v4/i/pix/in/dynamic-qrcode` - Cria uma cobrança PIX com QR Code dinâmico
- [Buscar QR Code](https://docs.owem.com.br/pt-BR/api-reference/pix-in/buscar-qrcode): `GET /v4/i/pix/in/dynamic-qrcode/{txId}` - Consulta status de um QR Code criado
- [Estornar PIX](https://docs.owem.com.br/pt-BR/api-reference/pix-in/estornar): `POST /v4/i/pix/in/refund/{endToEndId}` - Solicita estorno de um PIX recebido
- [Consultar Estorno](https://docs.owem.com.br/pt-BR/api-reference/pix-in/consultar-estorno): `GET /v4/i/pix/in/refund/{endToEndId}` - Consulta status de um estorno

## API Reference - PIX OUT (Pagamentos)

- [Transferência Externa](https://docs.owem.com.br/pt-BR/api-reference/pix-out/transferencia-externa): `POST /v4/i/bank-accounts/{accountId}/transfer/external` - Realiza transferência PIX para qualquer chave
- [Consultar Transferência](https://docs.owem.com.br/pt-BR/api-reference/pix-out/consultar-transferencia): `GET /v4/i/bank-accounts/{accountId}/transfer/external/{endToEnd}` - Consulta status de uma transferência

## API Reference - Webhooks

- [Criar Webhook](https://docs.owem.com.br/pt-BR/api-reference/webhooks/criar-webhook): `POST /v4/i/webhooks/config` - Registra um novo endpoint de webhook
- [Atualizar Webhook](https://docs.owem.com.br/pt-BR/api-reference/webhooks/atualizar-webhook): `PUT /v4/i/webhooks/config/{configId}` - Atualiza configuração de webhook existente
- [Consultar Webhook](https://docs.owem.com.br/pt-BR/api-reference/webhooks/consultar-webhook): `GET /v4/i/webhooks/config/{configId}` - Retorna detalhes de um webhook
- [Listar Webhooks](https://docs.owem.com.br/pt-BR/api-reference/webhooks/listar-webhooks): `GET /v4/i/webhooks/config` - Lista todos os webhooks configurados
- [Ativar Webhook](https://docs.owem.com.br/pt-BR/api-reference/webhooks/ativar-webhook): `POST /v4/i/webhooks/config/{configId}/activate` - Ativa um webhook desativado
- [Desativar Webhook](https://docs.owem.com.br/pt-BR/api-reference/webhooks/desativar-webhook): `POST /v4/i/webhooks/config/{configId}/deactivate` - Desativa um webhook ativo
- [Excluir Webhook](https://docs.owem.com.br/pt-BR/api-reference/webhooks/excluir-webhook): `DELETE /v4/i/webhooks/config/{configId}` - Remove permanentemente um webhook

## API Reference - MEDs (Disputas)

- [Listar MEDs](https://docs.owem.com.br/pt-BR/api-reference/meds/listar-meds): `GET /v4/i/meds` - Lista todos os MEDs (Mecanismos Especiais de Devolução) recebidos
- [Enviar Defesa](https://docs.owem.com.br/pt-BR/api-reference/meds/enviar-defesa): `POST /v4/i/meds/{medId}/defense` - Envia defesa para um MED

## Eventos de Webhook

| Evento | Descrição |
|--------|-----------|
| `pix_in:qrcode_paid` | QR Code foi pago pelo cliente |
| `pix_in:refund_succeeded` | Estorno de PIX IN concluído |
| `pix_in:refund_failed` | Estorno de PIX IN falhou |
| `pix_out:succeeded` | Transferência PIX OUT concluída |
| `pix_out:failed` | Transferência PIX OUT falhou |
| `med:created` | Novo MED recebido |
| `med:updated` | Status de MED atualizado |

## Códigos de Status HTTP

| Código | Descrição |
|--------|-----------|
| 200 | Sucesso |
| 201 | Criado com sucesso |
| 400 | Requisição inválida |
| 401 | Não autorizado (credenciais inválidas) |
| 403 | Proibido (IP não na allowlist) |
| 404 | Recurso não encontrado |
| 409 | Conflito (idempotência) |
| 429 | Rate limit excedido |
| 500 | Erro interno do servidor |

## Contato

- Suporte: suporte@owem.com.br
- Status: https://status.owem.com.br
- Documentação: https://docs.owem.com.br