Primeiros Passos

Integre sua aplicacao com a API da Owem Pay e realize sua primeira operacao PIX em poucos minutos.

1. Obtenha suas credenciais

Solicite ao administrador da sua conta Owem Pay:

• Client ID -- identificador da sua API Key
• Client Secret -- chave secreta para autenticacao e assinatura HMAC

Seguranca

Nunca exponha o client_secret em codigo frontend ou repositorios publicos. Utilize variaveis de ambiente no seu servidor.

2. Obtenha um token de acesso

Todas as requisicoes exigem um token Bearer. Gere um token com suas credenciais:

curl -X POST https://api.owem.com.br/api/v2/external/auth-token \
  -H "Content-Type: application/json" \
  -d '{
    "client_id": "sua-api-key-id",
    "client_secret": "sua-api-key-secret"
  }'

Resposta:

{
  "worked": true,
  "access_token": "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9...",
  "token_type": "Bearer",
  "expires_in": 3600
}

O token expira em 60 minutos. Implemente renovacao automatica antes da expiracao.

3. Consulte o saldo

Teste a integracao consultando o saldo da conta:

curl -X GET https://api.owem.com.br/api/v2/external/balance \
  -H "Authorization: Bearer $TOKEN"

Resposta:

{
  "worked": true,
  "balance": 150000,
  "available": 150000,
  "pending": 0,
  "currency": "BRL"
}

Valores em centavos

Todos os valores monetarios sao inteiros em centavos. 150000 = R$ 1.500,00.

4. Gere uma cobranca PIX (Cash-In)

Crie um QR Code para receber um pagamento:

BODY='{"amount":10000,"description":"Pedido #1234"}'
HMAC=$(echo -n "$BODY" | openssl dgst -sha512 -hmac "$CLIENT_SECRET" | awk '{print $2}')

curl -X POST https://api.owem.com.br/api/v2/external/pix/cash-in \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -H "hmac: $HMAC" \
  -d "$BODY"

Resposta:

{
  "worked": true,
  "transaction_id": "PIXIN20260307a1b2c3d4e5f6",
  "end_to_end_id": "E37839059202603071234000001",
  "qr_code": "00020126580014br.gov.bcb.pix...",
  "qr_code_image": "data:image/png;base64,...",
  "amount": 10000,
  "status": "pending"
}

Exiba o qr_code_image ou o codigo copia-e-cola (qr_code) ao pagador.

5. Consulte o status

Acompanhe o pagamento consultando pelo transaction_id:

curl -X GET https://api.owem.com.br/api/v2/external/transactions/PIXIN20260307a1b2c3d4e5f6 \
  -H "Authorization: Bearer $TOKEN"

Quando o pagamento for confirmado, o status muda para completed.

6. Receba notificacoes (Webhooks)

Para receber notificacoes em tempo real (recomendado em vez de polling):

BODY='{"url":"https://seusite.com.br/webhook","events":["pix.received","pix.completed"]}'
HMAC=$(echo -n "$BODY" | openssl dgst -sha512 -hmac "$CLIENT_SECRET" | awk '{print $2}')

curl -X POST https://api.owem.com.br/api/v2/external/webhooks \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -H "hmac: $HMAC" \
  -d "$BODY"

Proximos Passos

• Autenticacao -- detalhes do fluxo de token
• HMAC-SHA512 -- como assinar requisicoes transacionais
• PIX Cash-In -- gerar cobrancas
• Extrato -- consultar transacoes
• Webhooks -- notificacoes em tempo real
• Conceitos -- valores, status e chaves PIX