Skip to main content
POST
Resolve a stuck return-file transmission

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Parâmetros de caminho

id
string
obrigatório

The return file id (UUID).

Exemplo:

"dddddddd-dddd-dddd-dddd-dddddddddddd"

Corpo

application/json
action
enum<string>
obrigatório

probe_now asks Lerian STA whether a transfer for this file already exists; attach_transfer binds one you located, after Lerian STA confirms it is this file's; force_fail gives up on a stuck submission so the file becomes reconsolidable; cancel_now retries cancelling a size-mismatched transfer that is still live.

Opções disponíveis:
probe_now,
attach_transfer,
force_fail,
cancel_now
Exemplo:

"probe_now"

institutionId
string
obrigatório

The institution the return file belongs to (UUID).

Exemplo:

"44444444-4444-4444-4444-444444444444"

reason
string
obrigatório

Why this remedy is being applied, in your own words. MUST NOT contain personal data (CPF/CNPJ, names, process numbers) or monetary values: it is written verbatim into a permanent, append-only audit record. Text carrying a run of more than 10 digits is refused with 422 — that is a floor against pasting an identifier, not a check that recognises a name.

Exemplo:

"Lerian STA unavailable since 14:00; response deadline at 19:00"

transferId
string

Required by attach_transfer; ignored otherwise. Lerian STA is asked to confirm it belongs to this file before anything is bound.

Exemplo:

"eeeeeeee-eeee-eeee-eeee-eeeeeeeeeeee"

Resposta

OK

outcome
string
obrigatório

A token from the closed set: reconciled_by_list, still_absent, attached, forced_failed, cancelled, cancel_refused.

Exemplo:

"reconciled_by_list"

transferId
string

The transfer the file ended up bound to, when the action produced one.

Exemplo:

"eeeeeeee-eeee-eeee-eeee-eeeeeeeeeeee"