Approve the close of a held outbound message as failed

The second operator’s step: ends the message FAILED (or as declared), writes its fact for the client’s ledger, closes the card command behind it and records both operators in the audit trail, in one transaction. A declaration with typed values (numCtrl, situation) is approved only with the same values and settledAt in the body (422 otherwise, the request stays pending). 403 for the operator who made the request and for a machine credential; 409 when no request awaits approval, while the message’s LBTR cycle is open by the close recorded now (the request stays pending), or when the câmara’s answer reached the message first (the request is then closed as superseded and the message stays as the answer left it).

POST /api/v1/siloc/outbound/messages/{id}/close-request/approve

Approve the close of a held outbound message as failed

cURL

curl --request POST \
  --url https://api.example.com/api/v1/siloc/outbound/messages/{id}/close-request/approve \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "numCtrl": "<string>",
  "settledAt": "2023-11-07T05:31:56Z",
  "situation": "<string>"
}
'

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "messageId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "reason": "<string>",
  "requestedAt": "2023-11-07T05:31:56Z",
  "requestedBy": "<string>",
  "status": "PENDING",
  "numCtrl": "<string>",
  "outcome": "SETTLED",
  "parkedAnswerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "settledAt": "2023-11-07T05:31:56Z",
  "situation": "<string>"
}

Autorizaciones

Authorization · string · header · requerido

JWT bearer token issued by the identity provider.

Encabezados

X-Idempotency · string · requerido

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

Maximum string length: 255

Parámetros de ruta

id · string<uuid> · requerido

Outbound message id.

Cuerpo

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.

Respuesta

200

application/json

OK

id · string<uuid> · requerido

Close request id.

messageId · string<uuid> · requerido

The outbound message the request is about.

reason · string · requerido

The evidence the first operator gave.

requestedAt · string<date-time> · requerido

When the request was made.

requestedBy · string · requerido

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

status · enum<string> · requerido

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

Opciones disponibles: 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.

Opciones disponibles: 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.