Skip to main content

​
Pré-requisitos

Antes de começar, você precisa:
1

Conta Owem aprovada

Conta com onboarding finalizado e aprovado pelo time de Compliance.
2

Credenciais de API

API Key e Secret gerados em Owem › Configurações › Credenciais.
3

IP na allowlist

Seu IP público fixo deve estar cadastrado na allowlist.
O API Secret é exibido apenas uma vez no momento da criação. Guarde-o em local seguro (ex: Secret Manager, variáveis de ambiente).

​
Passo 1: Testar autenticação

Faça uma requisição ao endpoint /ping para validar suas credenciais: 
# Substitua API_KEY e API_SECRET pelas suas credenciais
curl -X GET "https://api.owem.com.br/v4/i/ping" \
  -u "API_KEY:API_SECRET" \
  -H "Content-Type: application/json"
Resposta esperada: 
{
  "requestId": "abc123...",
  "success": true,
  "size": 1,
  "message": "Ping OK",
  "data": "pong"
}
Se receber 401, verifique as credenciais. Se receber 403, seu IP não está na allowlist.

​
Passo 2: Consultar saldo

Verifique o saldo da sua conta: 
curl -X GET "https://api.owem.com.br/v4/i/bank-accounts/{ACCOUNT_ID}/balance" \
  -u "API_KEY:API_SECRET" \
  -H "Content-Type: application/json"

​
Passo 3: Gerar seu primeiro QR Code

Crie uma cobrança PIX: 
curl -X POST "https://api.owem.com.br/v4/i/pix/in/dynamic-qrcode" \
  -u "API_KEY:API_SECRET" \
  -H "Content-Type: application/json" \
  -d '{
    "accountId": "SEU_ACCOUNT_ID",
    "userId": "SEU_USER_ID",
    "amount": 10.00,
    "description": "Teste de integração"
  }'
Resposta: 
{
  "requestId": "...",
  "success": true,
  "size": 1,
  "data": {
    "txId": "abc123def456...",
    "dueDate": "2025-12-26T18:00:00.000Z",
    "emv": "00020101021226840014br.gov.bcb.pix..."
  }
}
O campo emv é o copia-e-cola do PIX. Use-o para gerar o QR Code visualmente.

​
Próximos passos

Receber Pagamentos

Fluxo completo de PIX IN

Enviar Pagamentos

Fluxo completo de PIX OUT

Configurar Webhooks

Receba notificações em tempo real

API Reference

Documentação completa dos endpoints