Skip to main content
POST
Query the entries the Câmara PAG holds

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Headers

X-Idempotency
string
required

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

Maximum string length: 255

Body

application/json
DtMovto
string
required

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

DtAgendt
string

Data Agendamento (xs:date, [0..1]). A filter on the date an entry was scheduled to settle (RSTR0011).

HrIni
string

Hora Início (xs:time, HH:MM:SS, [0..1]). A filter: omitting it means the câmara's opening time that day (RPAG0006).

NumCtrlPAGOr
string

Número Controle PAG Original (ControleIF, [0..1]). A filter: naming it returns only that entry (RPAG0005).

SitLancPAG
string

Situação Lançamento PAG (SitLancPAG, [0..1]). A filter, checked against the live set BACEN's Dicionário de Domínios publishes: AGE, CAN, COM, ENF or REJ (PEC and PED retired in 2002).

TpDeb_Cred
string

Tipo Débito ou Crédito (TpDebCred, [0..1]). A filter: C (crédito) or D (débito). Omit to ask for both.

Response

Accepted

attempts
integer<int64>
required

Queue-put attempts made so far.

codMsg
string
required

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

id
string<uuid>
required

Outbound message id.

numCtrlIF
string
required

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

nuop
string
required

The BCMSG operation number of the frame.

request
object
required

The request exactly as it was submitted, projected verbatim.

status
enum<string>
required

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.

Available options:
SUBMITTED,
DISPATCHED,
ANSWERED,
REFUSED,
FAILED
submittedAt
string<date-time>
required

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.