Skip to content

Consultar Cash-In por E2E ID

Consulta uma transação PIX pelo End-to-End ID (identificador único do BACEN).

Endpoint

GET /api/external/transactions/e2e/:e2e_id

Headers

HeaderTipoObrigatórioDescrição
AuthorizationStringSimApiKey {client_id}:{client_secret}
X-Key-CaseStringNãoDefina como camelCase para receber os campos da resposta em camelCase (padrão é snake_case)

Path Parameters

ParâmetroTipoObrigatórioDescrição
e2e_idStringSimEnd-to-End ID da transação (formato BACEN, regex ^E\d{8}[a-zA-Z0-9]{22,26}$)

Formato do E2E ID (BACEN)

O E2E ID segue o padrão do BACEN: E + ISPB (8 dígitos numéricos) + timestamp UTC (13 dígitos numéricos) + identificador alfanumérico (9-13 caracteres, pode conter letras e números).

Exemplos válidos:

  • E37839059202603071530000001 -- todo numérico (gerado por sistemas que usam só dígitos)
  • E18236120202604221900s1218936740 -- contém letras (gerado por Nubank, ISPB 18236120)
  • E60746948202604091234A2004l6Agm0 -- alfanumérico típico (letras maiúsculas e minúsculas são válidas)

Atenção: nunca assuma que o E2E é todo numérico -- bancos emissores podem usar letras. Sua integração deve aceitar a regex ^E\d{8}[a-zA-Z0-9]{22,26}$.

Exemplo

bash
curl -X GET https://api.owem.com.br/api/external/transactions/e2e/E37839059202603071530000001 \
  -H "Authorization: ApiKey $CLIENT_ID:$CLIENT_SECRET"

Resposta de Sucesso (200)

json
{
  "worked": true,
  "data": {
    "id": "a1b2c3d4e5f64a7b8c9d0e1f2a3b4c5d",
    "transaction_id": "7popu57v6us7p6pcicgq12345",
    "end_to_end_id": "E37839059202603071530000001",
    "external_id": "order-9876",
    "type": "pix",
    "status": "settled",
    "amount": 300000,
    "fee_amount": 0,
    "net_amount": 300000,
    "description": "Pedido #1234",
    "direction": "inbound",
    "counterparty_name": "Maria Santos",
    "payer_document": "12345678901",
    "recipient_document": "37839059000188",
    "recipient_key": "contato@empresa.com.br",
    "payer_ispb": "60701190",
    "payer_bank_name": "ITAU UNIBANCO S.A.",
    "created_at": "2026-03-07T15:30:00Z",
    "completed_at": "2026-03-07T15:30:02Z"
  }
}

Este endpoint retorna o mesmo objeto de transação descrito em Consultar por ID -- incluindo as formas alternativas processing (PIX OUT em voo, com objeto recipient aninhado) e failed (com reason_code + reason_description). Todos os valores monetários estão em unidades base (÷ 10.000 para reais).

Resposta de Erro (404)

json
{
  "worked": false,
  "detail": "Transação não encontrada para o E2E informado"
}

Resposta de Erro (401)

json
{
  "error": {
    "status": 401,
    "message": "Missing API key credentials. Use Authorization: ApiKey <client_id>:<client_secret>"
  }
}

Cash-In e Cash-Out

Este endpoint retorna tanto transações de entrada quanto de saída. Use o campo direction para diferenciar: inbound (recebimento) ou outbound (envio).

Owem Pay Instituição de Pagamento — ISPB 37839059