Pular para o conteúdo principal
POST
Approve the close of a held outbound message as failed

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
numCtrl
string

The control number the second operator read in the answer; must equal the request's when it carries one.

settledAt
string<date-time>

The settlement instant the second operator confirmed; must equal the request's when it carries typed values.

situation
string

The situation the second operator read in the answer; must equal the request's when it carries one.

Resposta

OK

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.