Pular para o conteúdo principal
POST
Ask to close a held outbound message, or to declare its outcome

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Cabeçalhos

X-Idempotency
string
obrigatório

Idempotency key for this state-changing request (required, max 255 characters).

Maximum string length: 255

Parâmetros de caminho

id
string<uuid>
obrigatório

Outbound message id.

Corpo

application/json
reason
string
obrigatório

The evidence that the câmara will not answer: what was checked and with whom.

Required string length: 1 - 500
numCtrl
string

The 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.

outcome
enum<string>

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.

Opções disponíveis:
SETTLED,
FAILED
parkedAnswerId
string<uuid>

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.

settledAt
string<date-time>

The settlement instant the operator confirmed, in the past; required for SETTLED, refused otherwise.

situation
string

The situation (SitLancPAG, up to 3 characters) the operator read in the refused R1; required for SETTLED of a PAG transfer, refused otherwise.

Resposta

Created

id
string<uuid>
obrigatório

Close request id.

messageId
string<uuid>
obrigatório

The outbound message the request is about.

reason
string
obrigatório

The evidence the first operator gave.

requestedAt
string<date-time>
obrigatório

When the request was made.

requestedBy
string
obrigatório

The operator who asked, as the audit trail names them.

status
enum<string>
obrigatório

PENDING until a second operator approves; APPROVED once the message is closed.

Opções disponíveis:
PENDING,
APPROVED
numCtrl
string

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.

outcome
enum<string>

What the operators declared from that answer; omitted for a close with no parked answer.

Opções disponíveis:
SETTLED,
FAILED
parkedAnswerId
string<uuid>

The refused câmara answer the operators declared the outcome from; omitted for a close with no parked answer.

settledAt
string<date-time>

The settlement instant the operators confirmed for a SETTLED declaration; omitted otherwise.

situation
string

The situation (SitLancPAG) the first operator read in the answer, for a SETTLED declaration of a PAG transfer; omitted otherwise.