Skip to content

Consultar Cash In por ID

Consulta o status e detalhes de uma transacao PIX pelo ID da transacao.

Endpoint

GET /api/v2/external/transactions/:id

Headers

HeaderTipoObrigatorioDescricao
AuthorizationStringSimBearer {access_token}

Path Parameters

ParametroTipoObrigatorioDescricao
idStringSimID da transacao (transaction_id)

Exemplo

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

Resposta de Sucesso (200)

json
{
  "worked": true,
  "data": {
    "id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
    "transaction_id": "PIXIN20260307a1b2c3d4e5f6",
    "end_to_end_id": "E37839059202603071530000001",
    "type": "pix",
    "status": "completed",
    "amount": 10000,
    "fee_amount": 0,
    "net_amount": 10000,
    "description": "Pedido #1234",
    "direction": "inbound",
    "counterparty_name": "Maria Santos",
    "created_at": "2026-03-07T15:30:00Z",
    "completed_at": "2026-03-07T15:30:02Z"
  }
}
CampoTipoDescricao
workedBooleantrue indica sucesso na operacao
data.idStringUUID interno da transacao
data.transaction_idStringIdentificador publico da transacao
data.end_to_end_idStringID ponta-a-ponta do BACEN (E2E)
data.typeStringTipo da transacao (pix)
data.statusStringStatus atual (veja tabela abaixo)
data.amountIntegerValor em centavos
data.fee_amountIntegerValor da tarifa em centavos
data.net_amountIntegerValor liquido em centavos
data.descriptionStringDescricao da transacao
data.directionStringinbound para recebimentos
data.counterparty_nameStringNome do pagador
data.created_atStringData de criacao (ISO 8601)
data.completed_atStringData de conclusao (ISO 8601), null se pendente

Status Possiveis

StatusDescricao
pendingAguardando pagamento
processingPagamento em processamento
completedPagamento confirmado
failedPagamento falhou
cancelledCobranca cancelada ou expirada

Resposta de Erro (404)

json
{
  "worked": false,
  "detail": "Transacao nao encontrada"
}

Resposta de Erro (401)

json
{
  "worked": false,
  "detail": "Token invalido ou expirado"
}

Polling vs Webhook

Para acompanhar o status de uma cobranca, prefira utilizar Webhooks em vez de polling. Caso precise consultar, use intervalos de no minimo 5 segundos.

Owem Pay Instituição de Pagamento — ISPB 37839059