Transfer funds for a judicial deposit

Issues a PAG0121 “IF requisita Transferência de recursos para depósito judicial” to the Câmara PAG (Catálogo de Serviços do SFN v5.13, Vol II). Requests a transfer of funds between financial institutions for a federal, state or labour judicial deposit, and for the judicial and extrajudicial deposits of Lei 9703/98 where the credited institution has pre-registered the depositor. The instruction is minted, built, signed, encrypted and durably recorded BEFORE anything reaches the queue, so this returns 202 with the control number the câmara will echo; the answer (PAG0121R1) arrives asynchronously and is read back with getPAG0121. Every amount is a decimal STRING carried to the wire exactly as written. A deployment with no send leg configured answers 503 with SILOC-0023; one whose dispatcher is not running, or whose Núclea queue manager is unreachable or refuses this rail’s configuration, answers 503 with SILOC-0024. A DtMovto whose day already ended in Brasília answers 422 with SILOC-0025; nothing is stored.

POST /api/v1/siloc/outbound/judicial-deposit-transfers

Transfer funds for a judicial deposit

cURL

curl --request POST \
  --url https://api.example.com/api/v1/siloc/outbound/judicial-deposit-transfers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "CNPJ_CPFCliDebtd": "<string>",
  "DtMovto": "<string>",
  "ISPBIFCredtd": "<string>",
  "IdentcDep": "<string>",
  "NomCliDebtd": "<string>",
  "TpPessoaDebtd": "<string>",
  "VlrLanc": "<string>",
  "AgDebtd": "<string>",
  "CtDebtd": "<string>",
  "CtPgtoDebtd": "<string>",
  "DtAgendt": "<string>",
  "NivelPrefPAG": "<string>",
  "TpCtDebtd": "<string>"
}
'

202

{
  "attempts": 123,
  "codMsg": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "numCtrlIF": "<string>",
  "nuop": "<string>",
  "request": {
    "CNPJ_CPFCliDebtd": "<string>",
    "DtMovto": "<string>",
    "ISPBIFCredtd": "<string>",
    "IdentcDep": "<string>",
    "NomCliDebtd": "<string>",
    "TpPessoaDebtd": "<string>",
    "VlrLanc": "<string>",
    "AgDebtd": "<string>",
    "CtDebtd": "<string>",
    "CtPgtoDebtd": "<string>",
    "DtAgendt": "<string>",
    "NivelPrefPAG": "<string>",
    "TpCtDebtd": "<string>"
  },
  "status": "SUBMITTED",
  "submittedAt": "2023-11-07T05:31:56Z",
  "answer": {
    "codMsg": "<string>",
    "movementDate": "2023-12-25",
    "numCtrlPAG": "<string>",
    "sitLancPAG": "<string>",
    "situationAt": "2023-11-07T05:31:56Z"
  },
  "answerAbsent": true,
  "answeredAt": "2023-11-07T05:31:56Z",
  "dispatchedAt": "2023-11-07T05:31:56Z",
  "lastError": "<string>"
}

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

Corpo

application/json

CNPJ_CPFCliDebtd · string · obrigatório

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

DtMovto · string · obrigatório

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

ISPBIFCredtd · string · obrigatório

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

IdentcDep · string · obrigatório

Identificação Depósito (IdentcDeposito, [1..1]).

NomCliDebtd · string · obrigatório

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

TpPessoaDebtd · string · obrigatório

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

VlrLanc · string · obrigatório

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

AgDebtd · string

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

CtDebtd · string

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

CtPgtoDebtd · string

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

DtAgendt · string

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

NivelPrefPAG · string

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

TpCtDebtd · string

Tipo Conta Debitada (TpCt, [0..1]).

Resposta

202

application/json

Accepted

attempts · integer<int64> · obrigatório

Queue-put attempts made so far.

codMsg · string · obrigatório

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

id · string<uuid> · obrigatório

Outbound message id.

numCtrlIF · string · obrigatório

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

nuop · string · obrigatório

The BCMSG operation number of the frame.

request · object · obrigatório

The request exactly as it was submitted, projected verbatim.

Show child attributes

status · enum<string> · obrigatório

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.

Opções disponíveis: SUBMITTED, DISPATCHED, ANSWERED, REFUSED, FAILED

submittedAt · string<date-time> · obrigatório

When the instruction was recorded.

answer · object

What the câmara answered; omitted until it has answered. Never on the submit (POST) receipt, which states the message and its current status only: read the answer with GET.

Show child attributes

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, and always on the submit (POST) receipt.

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, and always on the submit (POST) receipt.