Ask to close a held outbound message, or to declare its outcome
A message whose time ran out after a put whose outcome is unknown stays SUBMITTED, held for an answer the câmara may never send, and the rail never fails it alone. Records this operator’s request, with the evidence in reason, to close it as failed. Nothing changes until a second, different operator approves. 403 for a machine credential: the close is for people. A câmara answer parked for the message blocks the plain close, since it may say the message settled. When the rail refused that answer on content (it never replays; see the DLQ status SEMANTIC_REJECTED), the operator reads it and declares the outcome it states by passing its id in parkedAnswerId: outcome FAILED for the message’s E twin (the approval ends the send REFUSED and emits the refusal fact), outcome SETTLED with settledAt for the R1 of an LTR0002 or LTR0008 (the approval ends it ANSWERED and emits the answered fact the câmara’s own answer would have). For the R1 of a PAG transfer the operator also types numCtrl (NumCtrlPAG) and situation (SitLancPAG), read in the answer, and settledAt is its DtHrSit; the second operator types the same values to approve, and the answered fact carries declaredByOperators. The other R1 legs (queries, lists and the LDL answers) cannot be declared. 409 when the message is not held, a request already awaits its approval, an answer that can still replay is parked, or parkedAnswerId does not name a refused answer of this message that states the declared outcome. 422 when outcome, settledAt, numCtrl or situation is missing, misplaced, outside the answer’s official facets or (settledAt) in the future.
Authorizations
JWT bearer token issued by the identity provider.
Headers
Idempotency key for this state-changing request (required, max 255 characters).
255Path Parameters
Outbound message id.
Body
The evidence that the câmara will not answer: what was checked and with whom.
1 - 500The câmara's control number the operator read in the refused R1 (NumCtrlPAG, 1 to 20 characters); required for SETTLED of a PAG transfer, refused otherwise.
What that answer states: FAILED for the message's E twin, SETTLED for the R1 of an LTR0002, LTR0008 or a PAG transfer. Required with parkedAnswerId, refused without it.
SETTLED, FAILED The id of the refused (SEMANTIC_REJECTED) câmara answer parked for this message, which the operator read; required when such an answer blocks the close.
The settlement instant the operator confirmed, in the past; required for SETTLED, refused otherwise.
The situation (SitLancPAG, up to 3 characters) the operator read in the refused R1; required for SETTLED of a PAG transfer, refused otherwise.
Response
Created
Close request id.
The outbound message the request is about.
The evidence the first operator gave.
When the request was made.
The operator who asked, as the audit trail names them.
PENDING until a second operator approves; APPROVED once the message is closed.
PENDING, APPROVED The câmara's own control number (NumCtrlPAG) the first operator read in the answer, for a SETTLED declaration of a PAG transfer; omitted otherwise.
What the operators declared from that answer; omitted for a close with no parked answer.
SETTLED, FAILED The refused câmara answer the operators declared the outcome from; omitted for a close with no parked answer.
The settlement instant the operators confirmed for a SETTLED declaration; omitted otherwise.
The situation (SitLancPAG) the first operator read in the answer, for a SETTLED declaration of a PAG transfer; omitted otherwise.

