Pular para o conteúdo principal

​
Termos da API

Identificador público da sua credencial de acesso à API Owem. Usado junto com o API Secret para autenticação.
Chave secreta usada para autenticação. Exibida apenas uma vez no momento da criação. Nunca compartilhe ou exponha em código.
Identificador único da sua conta bancária Owem. Usado em operações de saldo e transferências.
Método de autenticação HTTP que usa API_KEY:API_SECRET codificado em Base64 no header Authorization.
URL específica da API que executa uma operação. Exemplo: /v4/i/pix/in/dynamic-qrcode.
Identificador único fornecido por você para correlacionar transações com seu sistema interno. Garante idempotência.
Propriedade que garante que múltiplas requisições idênticas produzam o mesmo resultado. Implementada via externalId.
Registro contábil de todas as movimentações financeiras da sua conta. Usado para conciliação e auditoria.
Limite de requisições permitidas por período. Ao exceder, recebe status 429.
UUID único gerado pela API para cada requisição. Use para rastreio e suporte.
Notificação HTTP enviada pela Owem para sua URL quando eventos importantes ocorrem.

​
Termos PIX

Sistema de pagamentos instantâneos do Banco Central do Brasil. Permite transferências 24/7 em segundos.
Recebimento de pagamento PIX. Na API Owem, feito via QR Code dinâmico.
Envio de pagamento PIX. Transferência para qualquer chave PIX.
Identificador para receber PIX. Pode ser CPF, CNPJ, email, telefone ou chave aleatória (EVP).
QR Code com valor e informações pré-definidas. Usado para cobranças específicas.
QR Code reutilizável sem valor definido. O pagador informa o valor.
Identificador único de 32 caracteres gerado pelo Banco Central para cada transação PIX. Formato: `E`.
Identificador interno da Owem para uma entrada no Ledger. Diferente do End-to-End ID.
Identificador da transação do QR Code dinâmico. Equivale ao entryId no Ledger.
Padrão de payload do QR Code PIX. String usada para “copia e cola”.
Identificador do Sistema de Pagamentos Brasileiro. Código de 8 dígitos de cada instituição financeira.
Devolução de um PIX recebido ao pagador original.

​
Termos de Disputas

Mecanismo Especial de Devolução. Processo do Banco Central para devolução de PIX em casos de fraude ou erro.
Notificação de MED recebida. Pode ser por suspeita de fraude, duplicidade ou erro operacional.
Resposta formal a uma notificação de MED, apresentando argumentos e evidências.
Prestador de Serviços de Pagamento. Instituição que oferece serviços PIX (como a Owem).
Tempo disponível para responder a um MED. Varia conforme o tipo de infração.

​
Termos Técnicos

Codificação binária para texto. Usada para codificar credenciais no header Authorization.
Tipo de token de autenticação (não usado pela Owem, que usa Basic Auth).
HTTP seguro com criptografia TLS. Obrigatório para todas as requisições à API.
JavaScript Object Notation. Formato de dados usado em requisições e respostas da API.
Transport Layer Security. Protocolo de criptografia usado no HTTPS. Mínimo: TLS 1.2.
Universally Unique Identifier. Formato usado para IDs na API (ex: requestId).
Marcação de tempo. Na API Owem, geralmente em milissegundos desde epoch (1970-01-01).
Padrão internacional para representação de datas. Exemplo: 2025-12-26T15:30:00.000Z.

​
Status de Transações

StatusDescrição
processingEm processamento
succeededConcluída com sucesso
failedFalhou
refundedEstornada
cancelledCancelada
pendingAguardando processamento

​
Eventos de Webhook

EventoDescrição
pix_in:qrcode_paidQR Code foi pago
pix_in:refund_succeededEstorno de PIX IN concluído
pix_in:refund_failedEstorno de PIX IN falhou
pix_out:succeededTransferência PIX OUT concluída
pix_out:failedTransferência PIX OUT falhou
med:createdNovo MED recebido
med:updatedStatus de MED atualizado