Skip to main content
GET
Read one outbound message, whatever its code

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Parâmetros de caminho

id
string
obrigatório

Outbound message id.

Resposta

OK

attempts
integer<int64>
obrigatório

Queue-put attempts made so far.

codMsg
string
obrigatório

The SFN message code this row carries, e.g. LDL0023.

id
string<uuid>
obrigatório

Outbound message id.

numCtrlIF
string
obrigatório

The control number this institution issued. The câmara echoes it on the answer, which is what correlates the two.

nuop
string
obrigatório

The BCMSG operation number of the frame.

status
enum<string>
obrigatório

Lifecycle state. REFUSED and FAILED are both terminal and are different facts: REFUSED means the câmara received the message and returned its E twin, FAILED means this rail could not deliver it and will not retry.

Opções disponíveis:
SUBMITTED,
DISPATCHED,
ANSWERED,
REFUSED,
FAILED
submittedAt
string<date-time>
obrigatório

When the message was recorded.

answeredAt
string<date-time>

When the câmara's answer was applied; omitted until it is.

codProdt
string

The SILOC product, OT or SLC; omitted when the message's layout carries no product element.

dispatchedAt
string<date-time>

When the frame reached the send queue; omitted until it has.

lastError
string

Why the last attempt failed; omitted when none has.

nextAttemptAt
string<date-time>

When the next queue put comes due; omitted once the row is terminal or answered.