Skip to main content
POST
Transfer funds for a judicial release

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
CNPJ_CPFCliCredtd
string
requerido

CNPJ ou CPF Cliente Creditado (CNPJ_CPF, [1..1]).

CodTribl
string
requerido

Código Tribunal (CodTribl, [1..1]).

DtMovto
string
requerido

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

ISPBIFCredtd
string
requerido

ISPB IF Creditada (ISPB, [1..1]).

NomCliCredtd
string
requerido

Nome Cliente Creditado (Nome, [1..1]).

NomTribl
string
requerido

Nome Tribunal (NomEstend, [1..1]).

NumProcJud
string
requerido

Número Processo Judicial (NumProcJud, [1..1]).

TpCtCredtd
string
requerido

Tipo Conta Creditada (TpCt, [1..1]).

TpPessoaCredtd
string
requerido

Tipo Pessoa Creditada (TpPessoa, [1..1]).

VlrLanc
string
requerido

Valor Lançamento (Valor, [1..1]).

AgCredtd
string

Agência Creditada (Agencia, [0..1]).

AgDebtd
string

Agência Debitada (Agencia, [0..1]).

CNPJ_CPFCliDebtd
string

CNPJ ou CPF Cliente Debitado (CNPJ_CPF, [0..1]).

CtCredtd
string

Conta Creditada (CtBancaria, [0..1]). Exactly one of CtCredtd or CtPgtoCredtd is required.

CtDebtd
string

Conta Debitada (CtBancaria, [0..1]). At most one of CtDebtd or CtPgtoDebtd.

CtPgtoCredtd
string

Conta Pagamento Creditada (CtPgto, [0..1]). Exactly one of CtCredtd or CtPgtoCredtd is required.

CtPgtoDebtd
string

Conta Pagamento Debitada (CtPgto, [0..1]). At most one of CtDebtd or CtPgtoDebtd.

DtAgendt
string

Data Agendamento (xs:date, [0..1]).

Hist
string

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

NivelPrefPAG
string

Nível Preferência PAG (PrefPAG, [0..1]).

NomAutor
string

Nome Autor (Nome, [0..1]).

NomCliDebtd
string

Nome Cliente Debitado (Nome, [0..1]).

NomReu
string

Nome Réu (Nome, [0..1]).

TpPessoaDebtd
string

Tipo Pessoa Debitada (TpPessoa, [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. PAG0107.

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.