Detalhe da Transacao

Consultar detalhe da transacao

GET /api/v1/transacoes/{id}

Retorna as informacoes completas de uma transacao PIX/CNAB a partir do seu identificador unico (UUID).

Request

Path Parameters

Parametro	Tipo	Obrigatorio	Validacao	Descricao
`id`	UUID	sim	UUID valido	Identificador unico da transacao

Exemplo de requisicao

GET /api/v1/transacoes/550e8400-e29b-41d4-a716-446655440000

Response

`200 OK`

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "numeroDocumento": "123456",
  "dataVencimento": "2026-04-26",
  "status": "SETTLED",
  "valor": 150.00,
  "formaLancamento": "PIX_TRANSFERENCIA",
  "moeda": "BRL",
  "tipoMovimento": "INCLUSAO",
  "favorecido": {
    "nome": "Joao da Silva",
    "tipoInscricao": "CPF",
    "numeroInscricao": "12345678901",
    "codigoBanco": "001",
    "agencia": "1234",
    "digitoAgencia": "0",
    "conta": "123456",
    "digitoConta": "7"
  },
  "chavePix": "favorecido@empresa.com",
  "tipoChavePix": "CHAVE_PIX_EMAIL",
  "identificacaoPagamento": "PAG-2026-001",
  "qrCodeUrl": "https://pix.example.com/qr/abc123",
  "qrCodeTxid": "txid-abc123",
  "autenticacaoPagamento": "AUTH-789",
  "dataEfetivacao": "2026-04-26",
  "valorEfetivado": 150.00,
  "arquivo": {
    "nomeArquivo": "CNAB240_20260426.rem",
    "caminhoS3": "s3://bucket/cnab/2026/04/CNAB240_20260426.rem",
    "loteServico": 1
  },
  "createdAt": "2026-04-26T14:30:01.234",
  "sentAt": "2026-04-26T14:31:00.000",
  "settledAt": "2026-04-26T14:35:00.000",
  "updatedAt": "2026-04-26T14:35:00.000"
}

Campos da response

Campo	Tipo	Descricao
`id`	UUID	Identificador unico da transacao
`numeroDocumento`	string	Numero do documento
`dataVencimento`	date	Data de vencimento
`status`	string	Status da transacao
`valor`	number	Valor em reais
`formaLancamento`	string	Forma de lancamento
`moeda`	string	Codigo da moeda (3 caracteres)
`tipoMovimento`	string	`INCLUSAO` ou `EXCLUSAO`
`favorecido`	objeto	Dados completos do favorecido
`chavePix`	string	Chave PIX utilizada
`tipoChavePix`	string	Tipo da chave PIX
`identificacaoPagamento`	string	Identificador do pagamento
`qrCodeUrl`	string	URL do QR Code PIX
`qrCodeTxid`	string	ID da transacao do QR Code
`autenticacaoPagamento`	string	Codigo de autenticacao do pagamento
`dataEfetivacao`	date	Data de liquidacao
`valorEfetivado`	number	Valor efetivamente liquidado
`motivoFalha`	string	Motivo da falha (quando rejeitada — veja codigos de rejeicao)
`arquivo`	objeto	Informacoes do arquivo CNAB
`createdAt`	datetime	Timestamp de criacao
`sentAt`	datetime	Timestamp de envio ao banco
`settledAt`	datetime	Timestamp de liquidacao
`updatedAt`	datetime	Timestamp da ultima atualizacao

Dados do favorecido (`favorecido`)

Campo	Tipo	Descricao
`nome`	string	Nome do favorecido
`tipoInscricao`	string	`CPF` ou `CNPJ`
`numeroInscricao`	string	Numero do documento
`codigoBanco`	string	Codigo do banco
`agencia`	string	Numero da agencia
`digitoAgencia`	string	Digito da agencia
`conta`	string	Numero da conta
`digitoConta`	string	Digito da conta

Informacoes do arquivo (`arquivo`)

Campo	Tipo	Descricao
`nomeArquivo`	string	Nome do arquivo CNAB
`caminhoS3`	string	Caminho do arquivo no S3
`loteServico`	integer	Numero do lote de servico

Erros

`404 Not Found`

Transacao nao encontrada.

{
  "code": "NOT_FOUND",
  "message": "Transacao nao encontrada: 550e8400-e29b-41d4-a716-446655440000",
  "traceId": "abc123def456",
  "timestamp": "2026-04-26T14:30:01.234Z"
}

`400 Bad Request`

Identificador invalido.

{
  "code": "VALIDATION_ERROR",
  "message": "Falha de validacao",
  "details": [
    { "campo": "identificador", "erro": "deve ser um UUID valido" }
  ],
  "traceId": "abc123def456",
  "timestamp": "2026-04-26T14:30:01.234Z"
}

`500 Internal Server Error`

Erro interno. Inclua o traceId ao reportar.

Detalhe da Transacao

On this page