Skip to main content
GET
Consultar operação

Authorizations

Authorization
string
header
required

Chave de API do workspace (prefixo slhk_), enviada no header: Authorization: Bearer slhk_sua_chave_aqui

Headers

x-request-id
string

Identificador de rastreio opcional fornecido pelo cliente. Ecoado no header da resposta (nunca no body).

Path Parameters

id
string<uuid>
required

UUID da operação (campo operation_id da resposta do POST).

Response

Estado atual da operação.

Envelope de status da operação. Todos os campos estão sempre presentes; as contagens são null até status completed.

id
string<uuid>
required

UUID da operação.

status
enum<string>
required

Estado do ciclo de vida da operação. Em failed, os tokens são estornados automaticamente.

Available options:
queued,
processing,
completed,
failed
file_name
string
required

Nome do arquivo CNAB enviado.

engine_id
string
required

Engine de borderô efetivamente usada (explícita ou o template do sistema).

created_at
string<date-time>
required

Timestamp ISO 8601 de criação.

queued_at
string<date-time>
required

Timestamp ISO 8601 do enfileiramento.

file_size
number | null

Tamanho do arquivo em bytes. Pode ser null em operações antigas.

titulo_count
number | null

Total de títulos do borderô. null até status completed.

approved_count
number | null

Títulos aprovados. null até status completed.

blocked_count
number | null

Títulos bloqueados. null até status completed.

alert_count
number | null

Títulos em alerta, incluindo os com análise incompleta (fonte indisponível). null até status completed. approved_count + blocked_count + alert_count = titulo_count.

processing_at
string<date-time> | null

Timestamp ISO 8601 do início do processamento; null enquanto queued.

completed_at
string<date-time> | null

Timestamp ISO 8601 da conclusão. Preenchido apenas em completed.

error
string | null

Mensagem de erro. Preenchida apenas em failed.