Skip to main content
POST
Transfer funds for a payroll-loan credit

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
AgCredtd
string
required

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

CPFCliCredtd
string
required

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

DtMovto
string
required

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

Hist
string
required

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

ISPBIFCredtd
string
required

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

NomCliCredtd
string
required

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

NumBenfcINSSCliCredtd
string
required

Número Benefício INSS Cliente Creditado (NumBenfcINSS, [1..1]).

NumContrtoOpCred
string
required

Número Contrato Operação Crédito (NumContrtoOpCred, [1..1]).

NumProtAvebcINSS
string
required

Número Protocolo Averbação INSS (NumProtINSS, [1..1]).

TpBenfcINSS
string
required

Tipo Benefício INSS (TpBenfcINSS, [1..1]).

TpOpEmprtConsigd
string
required

Tipo Operação Empréstimo Consignado (TpOpEmprtConsigd, [1..1]).

VlrCredConsigd
string
required

Valor Crédito Consignado (Valor, [1..1]).

VlrLanc
string
required

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

VlrTarBcoCredtd
string
required

Valor Tarifa Banco Creditado (Valor, [1..1]).

AgDebtd
string

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

CodIdentdTransf
string

Código Identificador Transferência (CodIdentdTransf, [0..1]).

CtCredtd
string

Conta Creditada (CtBancaria, [0..1]).

DtAgendt
string

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

NivelPrefPAG
string

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

Response

Accepted

attempts
integer<int64>
required

Queue-put attempts made so far.

codMsg
string
required

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

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.