Skip to main content
POST
Withdraw a situação change registered in the Câmara PAG

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

Cuerpo

application/json
DtMovto
string
requerido

Data Movimento (xs:date, [1..1]).

NumCtrlPAGOr
string
requerido

Número Controle PAG Original (ControleIF, [1..1]): the câmara's own control number for the situação change being withdrawn, as it answered on that change.

Hist
string

Histórico (Historico, [0..1]).

Respuesta

Accepted

attempts
integer<int64>
requerido

Queue-put attempts made so far.

codMsg
string
requerido

The SFN instruction code this row carries, e.g. PAG0112.

id
string<uuid>
requerido

Outbound message id.

numCtrlIF
string
requerido

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

nuop
string
requerido

The BCMSG operation number of the frame.

request
object
requerido

The request exactly as it was submitted, projected verbatim.

status
enum<string>
requerido

Lifecycle state. REFUSED means the câmara received the instruction and returned its E twin; FAILED means this rail could not deliver it. Both are terminal and they are different facts.

Opciones disponibles:
SUBMITTED,
DISPATCHED,
ANSWERED,
REFUSED,
FAILED
submittedAt
string<date-time>
requerido

When the instruction was recorded.

answer
object

What the câmara answered; omitted until it has answered.

answerAbsent
boolean

True only on an ANSWERED message whose answer body this rail does not hold. The câmara did answer; what it wrote is not here, and the missing answer block is that absence, never an empty answer. Omitted otherwise.

answeredAt
string<date-time>

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

dispatchedAt
string<date-time>

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

lastError
string

Why the last queue put failed, or — on REFUSED — the CodErro values the câmara marked, verbatim. Omitted when neither applies.