Ogmma Revenue

Faturamento

GET/v1/lotes/{id}/mensagem

A mensagem TISS que foi transmitida, em bytes

O recurso Lote não carrega o XML de propósito: o que se precisa dele é em que pé está, qual o protocolo e o que fazer. Mas a mensagem é prova — é o que se confere quando a operadora diz ter recebido outra coisa. Sai em ISO-8859-1, que é como foi gerada e como a operadora a recebeu: reconverter entregaria bytes diferentes dos transmitidos. Lote em formação, que nunca gerou mensagem, responde 404 — e não um XML vazio, que pareceria lote transmitido sem conteúdo.

Escopo:
lote:ler
Resposta:
200

Pedido

Caminho

{id}*Identificador do recurso no Miydas. Opaco e estável — NÃO é o número que a operadora ou o seu sistema usam para a mesma coisa. Guarde-o como veio e não derive significado do formato.

Exemplo de chamada

curl -X GET https://api.miydas.com.br/v1/lotes/cmf3k2x9a0001aut/mensagem \
  -H "Authorization: Bearer $MIYDAS_CHAVE"

Resposta 200

Esta rota devolve o arquivo em bytes, com o Content-Type que a operadora produziu — não JSON. Só o erro vem no formato padrão.

Erros

CódigoHTTPQuandoO que fazer
RECURSO_NAO_ENCONTRADO404O id não existe — ou é de outra empresa, o que a API não distingue de propósito. Também a rota inexistente na v1.Confira o id.

Toda falha tem o mesmo formato: { "error": "CODIGO", "message": "…", "details": { … } }. error é estável e serve para lógica; message é para gente e pode mudar. Erros comuns a toda rota com chave (lista completa) não se repetem aqui.