Skip to content

Payloads dos Webhooks

Exemplos dos payloads enviados para cada tipo de evento. Todos os webhooks sao enviados como HTTP POST com Content-Type: application/json.

Headers de seguranca

Cada notificacao inclui os headers X-Owem-Signature, X-Owem-Timestamp, X-Owem-Event-Id e X-Owem-Event-Type. Consulte Webhooks -- Visao Geral para detalhes sobre validacao.


pix.received

Enviado quando um PIX e recebido na conta (cash-in confirmado).

json
{
  "event": "pix.received",
  "event_id": "evt_a1b2c3d4e5f6g7h8",
  "timestamp": "2026-03-07T15:30:02Z",
  "data": {
    "transaction_id": "PIXIN20260307a1b2c3d4e5f6",
    "end_to_end_id": "E37839059202603071530000001",
    "amount": 10000,
    "status": "completed",
    "payer_name": "Maria Santos",
    "payer_document": "***456.789-**",
    "description": "Pagamento pedido #1234"
  }
}
CampoTipoDescricao
data.transaction_idStringID da transacao na Owem Pay
data.end_to_end_idStringE2E ID do BACEN
data.amountIntegerValor recebido em centavos
data.statusStringSempre completed
data.payer_nameStringNome do pagador
data.payer_documentStringCPF/CNPJ do pagador (parcialmente mascarado)
data.descriptionStringDescricao informada pelo pagador

pix.completed

Enviado quando uma transferencia PIX (cash-out) e concluida com sucesso.

json
{
  "event": "pix.completed",
  "event_id": "evt_e5f6g7h8i9j0k1l2",
  "timestamp": "2026-03-07T15:30:05Z",
  "data": {
    "transaction_id": "PIXOUT20260307a1b2c3d4e5f6",
    "end_to_end_id": "E37839059202603071530000002",
    "amount": 5000,
    "status": "completed",
    "recipient_key": "12345678901",
    "recipient_name": "Joao Silva"
  }
}
CampoTipoDescricao
data.transaction_idStringID da transacao na Owem Pay
data.end_to_end_idStringE2E ID do BACEN
data.amountIntegerValor enviado em centavos
data.statusStringSempre completed
data.recipient_keyStringChave PIX do destinatario
data.recipient_nameStringNome do destinatario

pix.failed

Enviado quando uma transferencia PIX falha.

json
{
  "event": "pix.failed",
  "event_id": "evt_i9j0k1l2m3n4o5p6",
  "timestamp": "2026-03-07T15:30:05Z",
  "data": {
    "transaction_id": "PIXOUT20260307x9y8z7w6v5u4",
    "amount": 10000,
    "status": "failed",
    "error_reason": "Conta destinatario nao encontrada"
  }
}
CampoTipoDescricao
data.transaction_idStringID da transacao na Owem Pay
data.amountIntegerValor da tentativa em centavos
data.statusStringSempre failed
data.error_reasonStringDescricao do erro

pix.refund

Enviado quando uma devolucao PIX e processada.

json
{
  "event": "pix.refund",
  "event_id": "evt_m3n4o5p6q7r8s9t0",
  "timestamp": "2026-03-07T15:30:10Z",
  "data": {
    "refund_id": "PIXRET20260307a1b2c3d4e5f6",
    "original_transaction_id": "PIXIN20260307a1b2c3d4e5f6",
    "amount": 10000,
    "status": "completed",
    "return_code": "MD06"
  }
}
CampoTipoDescricao
data.refund_idStringID da devolucao
data.original_transaction_idStringID da transacao PIX original
data.amountIntegerValor devolvido em centavos
data.statusStringStatus da devolucao
data.return_codeStringCodigo BACEN da devolucao

pix.med

Enviado quando uma notificacao MED e recebida do BACEN.

json
{
  "event": "pix.med",
  "event_id": "evt_q7r8s9t0u1v2w3x4",
  "timestamp": "2026-03-07T18:00:00Z",
  "data": {
    "med_id": "MED20260307001",
    "type": "FRAUDE",
    "amount": 50000,
    "original_end_to_end_id": "E37839059202603071530000001",
    "status": "pending"
  }
}
CampoTipoDescricao
data.med_idStringID do processo MED
data.typeStringTipo: FRAUDE ou FALHA_OPERACIONAL
data.amountIntegerValor em centavos
data.original_end_to_end_idStringE2E da transacao PIX original
data.statusStringStatus inicial do MED

Estrutura Comum

Todos os payloads seguem a mesma estrutura base:

json
{
  "event": "tipo.do.evento",
  "event_id": "evt_identificador_unico",
  "timestamp": "2026-03-07T15:30:00Z",
  "data": { }
}
CampoTipoDescricao
eventStringTipo do evento
event_idStringID unico para deduplicacao
timestampStringMomento do evento (ISO 8601, UTC)
dataObjectDados especificos do evento

Owem Pay Instituição de Pagamento — ISPB 37839059